Added sample rpld.conf file to load gPXE
[rpld.git] / doc / rpld.8
1
2 RPLD(8)                     System Manager's Manual                    RPLD(8)
3
4 NAME
5      rpld - an RPL/RIPL remote boot server
6
7 SYNOPSIS
8      rpld [-f] [-C configfile] [-i iface] [-s sap] [-h]
9
10 WARRANTY
11      rpld DOES NOT come with ANY WARRANTY, NOT even an IMPLIED WARRANTY.
12
13 OPTIONS
14      -f              this flag causes rpld to run in the foreground, and not
15                      to fork and run as a daemon.
16
17      -C configfile   causes rpld to read configfile rather than the default
18                      configuration file.
19
20      -i iface        causes rpld to bind to network interface iface rather
21                      than the default. Because of the limitations of the LLC
22                      802.2 protocol rpld can only bind to one interface.
23
24      -s sap          changes the SAP number that rpld binds to. The IBM stan-
25                      dard says this should be 0xf8 but most network cards seem
26                      to use 0xfc and some even use 0xf4. You can specify the
27                      sap as either a hex number with a leading 0x or a decimal
28                      one. Beware of specificing a SAP number which is used for
29                      system control packets on a machine with native llc sup-
30                      port.
31
32      -h              causes rpld to print a brief help message.
33
34 DESCRIPTION
35      rpld will net-boot IBM style RPL boot ROMs. Communication between the
36      client and the server is done in LLC-1 ui/C frames with the source and
37      destination SAP both being 0xfc. On booting the client transmits a FIND
38      frame containing the client's MAC address, adapter type and frame length.
39      The server replies with a FOUND frame containing the server's MAC address
40      and a possibly smaller frame length. The client issues a SEND.FILE.RE-
41      QUEST frame requesting the first block of the boot file. The server then
42      issues a sequence of FILE.DATA.RESPONSE frames with increasing block num-
43      bers. The FILE.DATA.RESPONSE frames contain a load address and an execute
44      address and a flag. If the client fails to receive a FILE.DATA.RESPONSE
45      frame within a certain period it sends another SEND.FILE.REQUEST frame
46      requesting the block which follows the last block that was successfully
47      received. On the last FILE.DATA.RESPONSE frame the server sets a special
48      value of the flags which cause the client to transfer execution to the
49      execute address specified in the frame.
50
51      The server starts by reading the configuration file in /etc/rpld.conf,
52      see rpld.conf(5), After the configuration file has been read, it opens
53      the system's default network interface and listens for RPL frames.  The
54      server recalculates the length of all the files to be downloaded every
55      time it receives a SEND.FILE.REQUEST frame.
56
57 BUGS
58        Solenopsis invicta Burens
59        rpld doesn't support the new bzImage format correctly.
60        rpld doesn't reload the first 512 octets of Linux kernels automatical-
61        ly.
62        There is no way to make rpld re-read its configuration file.
63        When concurrently serving multiple clients rpld will choose the pacing
64
65
66        value of the slowest one.
67        Partial ethernet addresses should be specified in bits not bytes.
68        rpld needs to meet more network adapters.
69
70 NOTES
71      IBM is a trademark of IBM Corp.
72
73      and the makefile in the distribution for more information.
74
75 FILES
76      /usr/sbin/rpld
77      /etc/rpld.conf
78      /rplboot
79
80 SEE ALSO
81      rpld.conf(5),
82      bootpd(1),
83      dhcpd(1),
84      http://gimel.esc.cam.ac.uk/james/rpld;
85
86 AUTHORS AND COPYRIGHT
87      (c) 1999,2000 James McKenzie, and Christopher Lightfoot. All rights re-
88      served.
89
90  Linux                           Jun 16, 2000                                2