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