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