http://gimel.esc.cam.ac.uk/james/rpld/src/rpld-1.4.tar.gz
[rpld.git] / rpld.man
1 .\" 
2 .\"/*************************************************
3 .\"*     rpld - an IBM style RIPL server            *
4 .\"*************************************************/
5 .\"
6 .\"Copyright (c) 1999,2000, James McKenzie.
7 .\"                     All rights reserved
8 .\"Copyright (c) 1998,2000, Christopher Lightfoot.
9 .\"                     All rights reserved
10 .\"
11 .\"By using this file, you agree to the terms and conditions set
12 .\"forth in the LICENSE file which can be found at the top level of
13 .\"the rpld distribution.
14 .\"
15 .\"IBM is a trademark of IBM Corp.
16 .\"
17 .\"
18 .\"
19 .\" $Id: rpld.man,v 1.10 2000/07/17 10:43:34 root Exp $;
20 .\"
21 .\" $Log: rpld.man,v $
22 .\" Revision 1.10  2000/07/17 10:43:34  root
23 .\" #
24 .\"
25 .\" Revision 1.9  2000/07/16 21:09:57  root
26 .\" #
27 .\"
28 .\" Revision 1.8  2000/07/16 14:22:06  root
29 .\" #
30 .\"
31 .\" Revision 1.7  2000/07/16 14:05:28  root
32 .\" #
33 .\"
34 .\" Revision 1.6  2000/07/16 13:18:10  root
35 .\" #
36 .\"
37 .\" Revision 1.1  2000/07/16 13:16:33  root
38 .\" #
39 .\"
40 .\" Revision 1.10  1999/09/15 01:22:18  root
41 .\" #
42 .\"
43 .\" Revision 1.9  1999/09/15 00:36:29  root
44 .\" #
45 .\"
46 .\" Revision 1.8  1999/09/15 00:25:57  root
47 .\" #
48 .\"
49 .\" Revision 1.7  1999/09/15 00:22:07  root
50 .\" #
51 .\"
52 .\" Revision 1.6  1999/09/15 00:14:29  root
53 .\" #
54 .\"
55 .\" Revision 1.5  1999/09/14 21:43:30  root
56 .\" #
57 .\"
58 .\" Revision 1.4  1999/09/14 21:37:08  root
59 .\" #
60 .\"
61 .\" Revision 1.3  1999/09/14 21:32:12  root
62 .\" #
63 .\"
64 .\" Revision 1.2  1999/09/14 21:25:59  root
65 .\" #
66 .\"
67 .\" Revision 1.1  1999/09/14 21:00:47  root
68 .\" #
69 .\"
70 .\" Revision 1.1  1999/09/14 17:19:37  root
71 .\" Initial revision
72 .\"
73 .\";
74 .Dd Jun 16, 2000
75 .Dt RPLD 8
76 .Os Linux
77 .Sh NAME
78 .Nm rpld
79 .Nd an RPL/RIPL remote boot server
80 .Sh SYNOPSIS
81 .Nm rpld
82 .Sh WARRANTY
83 .Nm rpld 
84 DOES NOT come with ANY WARRANTY, NOT even an IMPLIED WARRANTY.
85 .Sh DESCRIPTION
86 .Nm rpld 
87 will net-boot IBM style RPL boot ROMs. Communication between the client and the
88 server is done in LLC-1 ui/C frames with the source and destination SAP both 
89 being 0xfc. On booting the client transmits a FIND frame containing the client's
90 MAC address, adapter type and frame length. The server replies with a FOUND frame
91 containing the server's MAC address and a possibly smaller frame length. The
92 client issues a SEND.FILE.REQUEST frame requesting the first block of the boot
93 file. The server then issues a sequence of FILE.DATA.RESPONSE frames with 
94 increasing block numbers. The FILE.DATA.RESPONSE frames contain a load address
95 and an execute address and a flag. If the client fails to receive a  
96 FILE.DATA.RESPONSE frame within a certain period it sends another 
97 SEND.FILE.REQUEST frame requesting the block which follows the last block that
98 was successfully received. On the last FILE.DATA.RESPONSE frame the server
99 sets a special value of the flags which cause the client to transfer execution
100 to the execute address specified in the frame.
101 .Pp
102 The server starts by reading the configuration file in /etc/rpld.conf,
103 see 
104 .Pa rpld.conf(5),
105 After the configuration file has been read, it opens the system's
106 default network interface and listens for RPL frames.
107 The server recalculates the length of all the files to be downloaded every time
108 it receives a SEND.FILE.REQUEST frame. 
109 .Sh BUGS
110 .Bl -tag -width 0 -compact
111 .It
112 Solenopsis invicta Burens
113 .It
114 rpld (probably) doesn't support the new bzImage format correctly.
115 .It
116 rpld doesn't reload the first 512 octets of Linux kernels automatically.
117 .It
118 There is no way to make rpld re-read its configuration file.
119 .It
120 When concurrently serving multiple clients rpld will choose the pacing value of the slowest one.
121 .It
122 Partial ethernet addresses should be specified in bits not bytes.
123 .It
124 rpld needs to meet more network adapters.
125 .Sh NOTES
126 .Pp
127 IBM is a trademark of IBM Corp.
128 .Sh FILES
129 .Bl -tag -width /etc/rpld.conf -compact
130 .Pp
131 .It Pa /usr/sbin/rpld
132 .It Pa /etc/rpld.conf
133 .It Pa /rplboot
134 .El
135 .Sh SEE ALSO
136 .Pp
137 .Bl -tag -width 0 -compact
138 .It Pa rpld\.conf(5),
139 .It Pa bootpd(1),
140 .It Pa dhcpd(1),
141 .It Pa http://gimel.esc.cam.ac.uk/james/rpld;
142 .El
143 .Sh AUTHORS AND COPYRIGHT
144 .Pp
145 (c) 1999,2000 James McKenzie, and Christopher Lightfoot. All rights reserved.