udhcpc: tweak help text
[oweals/busybox.git] / networking / udhcp / Config.src
1 #
2 # For a description of the syntax of this configuration file,
3 # see scripts/kbuild/config-language.txt.
4 #
5
6 INSERT
7
8 config UDHCPD
9         bool "udhcp server (udhcpd)"
10         default y
11         select PLATFORM_LINUX
12         help
13           udhcpd is a DHCP server geared primarily toward embedded systems,
14           while striving to be fully functional and RFC compliant.
15
16 config DHCPRELAY
17         bool "dhcprelay"
18         default y
19         depends on UDHCPD
20         help
21           dhcprelay listens for dhcp requests on one or more interfaces
22           and forwards these requests to a different interface or dhcp
23           server.
24
25 config DUMPLEASES
26         bool "Lease display utility (dumpleases)"
27         default y
28         depends on UDHCPD
29         help
30           dumpleases displays the leases written out by the udhcpd server.
31           Lease times are stored in the file by time remaining in lease, or
32           by the absolute time that it expires in seconds from epoch.
33
34 config FEATURE_UDHCPD_WRITE_LEASES_EARLY
35         bool "Rewrite the lease file at every new acknowledge"
36         default y
37         depends on UDHCPD
38         help
39           If selected, udhcpd will write a new file with leases every
40           time a new lease has been accepted, thus eliminating the need
41           to send SIGUSR1 for the initial writing or updating. Any timed
42           rewriting remains undisturbed.
43
44 config FEATURE_UDHCPD_BASE_IP_ON_MAC
45         bool "Select IP address based on client MAC"
46         default n
47         depends on UDHCPD
48         help
49           If selected, udhcpd will base its selection of IP address to offer
50           on the client's hardware address. Otherwise udhcpd uses the next
51           consecutive free address.
52
53           This reduces the frequency of IP address changes for clients
54           which let their lease expire, and makes consecutive DHCPOFFERS
55           for the same client to (almost always) contain the same
56           IP address.
57
58 config DHCPD_LEASES_FILE
59         string "Absolute path to lease file"
60         default "/var/lib/misc/udhcpd.leases"
61         depends on UDHCPD
62         help
63           udhcpd stores addresses in a lease file. This is the absolute path
64           of the file. Normally it is safe to leave it untouched.
65
66 config UDHCPC
67         bool "udhcp client (udhcpc)"
68         default y
69         select PLATFORM_LINUX
70         help
71           udhcpc is a DHCP client geared primarily toward embedded systems,
72           while striving to be fully functional and RFC compliant.
73
74           The udhcp client negotiates a lease with the DHCP server and
75           runs a script when a lease is obtained or lost.
76
77 config FEATURE_UDHCPC_ARPING
78         bool "Verify that the offered address is free, using ARP ping"
79         default y
80         depends on UDHCPC
81         help
82           If selected, udhcpc will send ARP probes and make sure
83           the offered address is really not in use by anyone. The client
84           will DHCPDECLINE the offer if the address is in use,
85           and restart the discover process.
86
87 config FEATURE_UDHCP_PORT
88         bool "Enable '-P port' option for udhcpd and udhcpc"
89         default n
90         depends on UDHCPD || UDHCPC
91         help
92           At the cost of ~300 bytes, enables -P port option.
93           This feature is typically not needed.
94
95 config UDHCP_DEBUG
96         int "Maximum verbosity level for udhcp applets (0..9)"
97         default 9
98         range 0 9
99         depends on UDHCPD || UDHCPC || DHCPRELAY
100         help
101           Verbosity can be increased with multiple -v options.
102           This option controls how high it can be cranked up.
103
104           Bigger values result in bigger code. Levels above 1
105           are very verbose and useful for debugging only.
106
107 config FEATURE_UDHCP_RFC3397
108         bool "Support for RFC3397 domain search (experimental)"
109         default y
110         depends on UDHCPD || UDHCPC
111         help
112           If selected, both client and server will support passing of domain
113           search lists via option 119, specified in RFC 3397,
114           and SIP servers option 120, specified in RFC 3361.
115
116 config FEATURE_UDHCP_8021Q
117         bool "Support for 802.1Q VLAN parameters"
118         default y
119         depends on UDHCPD || UDHCPC
120         help
121           If selected, both client and server will support passing of VLAN
122           ID and priority via options 132 and 133 as per 802.1Q.
123
124 config UDHCPC_DEFAULT_SCRIPT
125         string "Absolute path to config script"
126         default "/usr/share/udhcpc/default.script"
127         depends on UDHCPC
128         help
129           This script is called after udhcpc receives an answer. See
130           examples/udhcp for a working example. Normally it is safe
131           to leave this untouched.
132
133 config UDHCPC_SLACK_FOR_BUGGY_SERVERS
134         int "DHCP options slack buffer size"
135         default 80
136         range 0 924
137         depends on UDHCPD || UDHCPC
138         help
139           Some buggy DHCP servers send DHCP offer packets with option
140           field larger than we expect (which might also be considered a
141           buffer overflow attempt). These packets are normally discarded.
142           If circumstances beyond your control force you to support such
143           servers, this may help. The upper limit (924) makes dhcpc accept
144           even 1500 byte packets (maximum-sized ethernet packets).
145
146           This option does not make dhcp[cd] emit non-standard
147           sized packets.
148
149           Known buggy DHCP servers:
150           3Com OfficeConnect Remote 812 ADSL Router:
151             seems to confuse maximum allowed UDP packet size with
152             maximum size of entire IP packet, and sends packets which are
153             28 bytes too large.
154           Seednet (ISP) VDSL: sends packets 2 bytes too large.