]> git.lizzy.rs Git - plan9front.git/blob - sys/man/8/dhcpd
hjfs: add users command, fix newuser ? documentation
[plan9front.git] / sys / man / 8 / dhcpd
1 .TH DHCPD 8
2 .SH NAME
3 dhcpd, dhcpleases, rarpd, tftpd \- Internet booting
4 .SH SYNOPSIS
5 .PP
6 .B ip/dhcpd
7 .RB [ -dmnprsSZ ]
8 .RB [ -f
9 .IR ndb-file ]
10 .RB [ -M
11 .IR secs ]
12 .RB [ -x
13 .IR netmtpt ]
14 .RB [ -Z
15 .IR secs ]
16 [
17 .I address
18 .I n
19 ] ...
20 .PP
21 .B ip/dhcpleases
22 .PP
23 .B ip/rarpd
24 .RB [ -d ]
25 .RB [ -e
26 .IR etherdev ]
27 .RB [ -x
28 .IR netmtpt ]
29 .PP
30 .B ip/tftpd
31 .RB [ -dr ]
32 .RB [ -h
33 .IR homedir ]
34 .RB [ -x
35 .IR netmtpt ]
36 .SH DESCRIPTION
37 These programs support booting over the Internet.
38 They should all be run on the same server to
39 allow other systems to be booted.
40 .I Dhcpd
41 and
42 .I tftpd
43 are used to boot everything;
44 .I rarpd
45 is an extra piece just for Suns.
46 .PP
47 .I Dhcpd
48 runs the
49 .SM BOOTP
50 and
51 .SM DHCP
52 protocols.
53 Clients use these protocols to obtain configuration information.
54 This information comes from attribute/value pairs in the network database
55 (see
56 .IR ndb (6)
57 and
58 .IR ndb (8)).
59 DHCP requests are honored both for static addresses found in
60 the NDB and for dynamic addresses listed in the command line.
61 DHCP requests are honored if either:
62 .br
63 \- there exists an NDB entry
64 containing both the ethernet address of the requester and
65 an IP address on the originating network or subnetwork.
66 .br
67 \- a free dynamic address exists on the originating network or subnetwork.
68 .PP
69 A BOOTP request is honored if all of the following are true:
70 .br
71 \- there exists an NDB entry
72 containing both the ethernet address of the requester and
73 an IP address on the originating network or subnetwork.
74 .br
75 \- the entry contains a
76 .B bootf=
77 attribute
78 .br
79 \- the file in the
80 .B bootf=
81 attribute is readable.
82 .PP
83 Dynamic addresses are specified on the command line as a list
84 of addresses and number pairs.
85 For example,
86 .EX
87         ip/dhcpd 10.1.1.12 10 10.2.1.70 12
88 .EE
89 directs
90 .I dhcpd
91 to return dynamic addresses 10.1.1.12 through 10.1.1.21 inclusive
92 and 10.2.1.70 through 10.2.1.81 inclusive.
93 .PP
94 .I Dhcpd
95 maintains a record of all dynamic addresses in the directory
96 .BR /lib/ndb/dhcp ,
97 one file per address.
98 If multiple servers have access to this common directory,
99 they will correctly coordinate their actions.
100 .PP
101 Attributes come from either the NDB entry for the system, the entry for its
102 subnet, or the entry for its network.  The system entry has precedence,
103 then the subnet, then the network.
104 The NDB attributes used are:
105 .TF ipmask
106 .TP
107 .B ip
108 the IP address
109 .TP
110 .B ipmask
111 the IP mask
112 .TP
113 .B ipgw
114 the default IP gateway
115 .TP
116 .B dom
117 the domain name of the system
118 .TP
119 .B fs
120 the default Plan 9 name server
121 .TP
122 .B auth
123 the default Plan 9 authentication server
124 .TP
125 .B dns
126 a domain name server
127 .TP
128 .B ntp
129 a network time protocol server
130 .TP
131 .B time
132 a time server
133 .TP
134 .B wins
135 a
136 .SM NETBIOS
137 name server
138 .TP
139 .B www
140 a World Wide Web proxy
141 .TP
142 .B pop3
143 a POP3 mail server
144 .TP
145 .B smtp
146 an SMTP mail server
147 .TP
148 .B bootf
149 the default boot file;
150 see
151 .IR ndb (6)
152 .PD
153 .PP
154 .I Dhcpd
155 will answer
156 .SM BOOTP
157 requests only if it has been specifically targeted or if it
158 has read access to the boot file for the requester.  That means that the requester
159 must specify a boot file in the request or one has to exist in NDB for
160 .I dhcpd
161 to answer.
162 .I Dhcpd
163 will answer all
164 .SM DHCP
165 requests for which it can associate an IP address with the
166 requester.
167 The options are:
168 .TP
169 .B d
170 Print debugging to standard output.
171 .TP
172 .B f
173 Specify a file other than
174 .B /lib/ndb/local
175 as the network database.
176 .TP
177 .B m
178 Mute: don't reply to requests, just log them and what
179 .I dhcpd
180 would have done.
181 .TP
182 .B M
183 Use
184 .I secs
185 as the minimum lease time for dynamic addresses.
186 .TP
187 .B n
188 Don't answer
189 .SM BOOTP
190 requests.
191 .TP
192 .B p
193 Answer
194 .SM DHCP
195 requests from
196 .SM PPTP
197 clients only.
198 .TP
199 .B r
200 Mute static addresses: don't reply to requests for static addresses,
201 just log them and what
202 .I dhcpd
203 would have done.
204 .TP
205 .B s
206 Sleep 2 seconds before answering requests for static addresses.
207 This is used to make a server be a backup only.
208 .TP
209 .B S
210 Sleep 2 seconds before answering requests for dynamic addresses.
211 .TP
212 .B x
213 The IP stack to use is mounted at 
214 .IR netmtpt .
215 The default is
216 .BR /net .
217 .TP
218 .B Z
219 Use
220 .I secs
221 as the minimum lease time for static addresses.
222 .PD
223 .PP
224 .I Dhcpleases
225 prints out the currently valid DHCP leases found in the
226 .B /lib/ndb/dhcp
227 directory.
228 .PP
229 .I Rarpd
230 performs the Reverse Address Resolution Protocol, translating
231 Ethernet addresses into IP addresses.
232 The options are:
233 .TP
234 .B d
235 Print debugging to standard output.
236 .TP
237 .B e
238 Use the Ethernet mounted at
239 .BI /net/ etherdev\f1.
240 .TP
241 .B x
242 The IP stack to use is mounted at 
243 .IR netmtpt .
244 The default is
245 .BR /net .
246 .PD
247 .PP
248 .I Tftpd
249 transfers files to systems that are booting.
250 It runs as user
251 .B none
252 and can only access files with global read permission.
253 The options are:
254 .TP
255 .B d
256 Print debugging to standard output.
257 .TP
258 .B x
259 The IP stack to use is mounted at 
260 .IR netmtpt .
261 The default is
262 .BR /net .
263 .TP
264 .B h
265 Change directory to
266 .IR homedir .
267 The default is
268 .BR /lib/tftpd .
269 All requests for files with non-rooted file names are served starting at this
270 directory with the exception of files of the form
271 .BR xxxxxxxx.SUNyy .
272 These are Sparc kernel boot files where
273 .B xxxxxxxx
274 is the hex IP address of the machine requesting the kernel and
275 .B yy
276 is an architecture identifier.
277 .I Tftpd
278 looks up the file in the network database using
279 .I ipinfo
280 (see
281 .IR ndb (2))
282 and responds with the boot file specified for that particular
283 machine.
284 If no boot file is specified, the transfer fails.
285 .I Tftpd
286 supports only octet mode.
287 .TP
288 .B r
289 Restricts access to only those files rooted in the
290 .IR homedir .
291 .PD
292 .SH FILES
293 .BR /lib/ndb/dhcp "    directory of dynamic address files
294 .SH SOURCE
295 .B /sys/src/cmd/ip
296 .SH "SEE ALSO"
297 .IR ndb (6),
298 .IR booting (8)