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