aboutsummaryrefslogtreecommitdiff
path: root/networking/udhcp/udhcpc.8
diff options
context:
space:
mode:
Diffstat (limited to 'networking/udhcp/udhcpc.8')
-rw-r--r--networking/udhcp/udhcpc.8208
1 files changed, 0 insertions, 208 deletions
diff --git a/networking/udhcp/udhcpc.8 b/networking/udhcp/udhcpc.8
deleted file mode 100644
index 752a736c0..000000000
--- a/networking/udhcp/udhcpc.8
+++ /dev/null
@@ -1,208 +0,0 @@
1.TH UDHCPC 8 2001-09-26 GNU/Linux "GNU/Linux Administrator's Manual"
2.SH NAME
3udhcpc \- very small DHCP client
4.SH SYNOPSIS
5.B udhcpc
6.RI [ OPTION ]...
7.SH DESCRIPTION
8The udhcp client negotiates a lease with the DHCP server and
9executes a script when it is obtained or lost.
10.SH OPTIONS
11.TP
12.BI \-c\ CLIENTID ,\ \-\-clientid= CLIENTID
13Send the client identifier
14.IR CLIENTID .
15.TP
16.BR -f ,\ \-\-foreground
17Do not fork after obtaining a lease.
18.TP
19.BI \-H\ HOSTNAME ,\ \-\-hostname= HOSTNAME
20Send the client hostname
21.IR HOSTNAME .
22.TP
23.BI \-h\ HOSTNAME
24Alias for -H
25.IR HOSTNAME .
26.TP
27.BI \-i\ INTERFACE ,\ \-\-interface= INTERFACE
28Configure
29.IR INTERFACE .
30.TP
31.BR -n ,\ \-\-now
32Exit with failure if a lease cannot be obtained.
33.TP
34.BI \-p\ FILE ,\ \-\-pidfile= FILE
35Write the process ID of the daemon to
36.IR FILE .
37.TP
38.BR -q ,\ \-\-quit
39Exit after obtaining a lease.
40.TP
41.BI \-r\ ADDRESS ,\ \-\-request= ADDRESS
42Request IP address
43.IR ADDRESS .
44.TP
45.BI \-s\ FILE ,\ \-\-script= FILE
46Use script
47.IR FILE .
48.TP
49.BR -v ,\ \-\-version
50Display version.
51.SH USAGE
52When an event occurs,
53.B udhcpc
54executes a script. There are four possible arguments to this
55script:
56.TP
57.B deconfig
58.B deconfig
59is used when
60.B udhcpc
61starts, and when a lease is lost. The script should put the
62interface in an up, but deconfigured, state.
63.TP
64.B bound
65.B bound
66is used when
67.B udhcpc
68moves from an unbound to a bound state. The script should
69configure the interface and set any other relevant parameters
70(e.g., default gateway, dns server, etc.).
71.TP
72.B renew
73.B renew
74is used when
75.B udhcpc
76when a lease is renewed. The interface is already
77configured, so the IP address will not change. Other parameters
78(e.g., default gateway, subnet mask, dns server) may.
79.TP
80.B nak
81.B nak
82is used when
83.B udhcpc
84receieves a NAK packet from the server. The
85enviromental variable
86.B $message
87will contain the reason for the
88NAK message if the server included one. Processing this message
89is optional, as the script will also be called with deconfig if
90need be.
91.PP
92Parameters are passed to the script via the following environment
93variables:
94.TP
95.B HOME
96The inherited HOME, or "/" if it is unset.
97.TP
98.B PATH
99The inherited PATH, or "/bin:/usr/bin:/sbin:/usr/sbin" if it is
100unset.
101.TP
102.B interface
103The interface.
104.TP
105.B ip
106The client IP address.
107.TP
108.B siaddr
109The BOOTP next server option.
110.TP
111.B sname
112The BOOTP server name option.
113.TP
114.B boot_file
115The BOOTP boot file option.
116.TP
117.B subnet
118The subnet mask.
119.TP
120.B timezone
121The timezone offset from UTC in seconds.
122.TP
123.B router
124The list of routers.
125.TP
126.B timesvr
127The list of time servers.
128.TP
129.B namesvr
130The list of IEN 116 name servers.
131.TP
132.B dns
133The list of DNS servers.
134.TP
135.B logsvr
136The list of MIT-LCS UDP log servers.
137.TP
138.B cookiesvr
139The list of RFC 865 cookie servers.
140.TP
141.B lprsvr
142The list of LPR servers.
143.TP
144.B hostname
145The host name.
146.TP
147.B bootsize
148The length in 512-octet blocks of the bootfile.
149.TP
150.B domain
151The domain name of the network.
152.TP
153.B swapsvr
154The client's swap server.
155.TP
156.B rootpath
157The path of the client's root dist.
158.TP
159.B ipttl
160The TTL.
161.TP
162.B mtu
163The MTU.
164.TP
165.B broadcast
166The broadcast address.
167.TP
168.B ntpsrv
169The list of NTP servers.
170.TP
171.B wins
172The list of WINS servers.
173.TP
174.B lease
175The lease time in seconds.
176.TP
177.B dhcptype
178The DHCP message type (safely ignored).
179.TP
180.B serverid
181The server IP address.
182.TP
183.B message
184Reason for a DHCPNAK.
185.TP
186.B tftp
187The TFTP server name.
188.TP
189.B bootfile
190The bootfile name.
191.SH FILES
192.TP
193.I /usr/share/udhcpc/default.script
194Script run when leases are obtained or lost.
195.SH NOTES
196.B udhcpc
197responds to the following signals:
198.TP
199.B SIGUSR1
200This signal causes
201.B udhcpc
202to renew the current lease or, if it does not have one, obtain a
203new lease.
204.TP
205.B SIGUSR2
206This signal caused
207.B udhcpc
208to release the current lease.
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-08-14 10:13:29 +0000