Patch from Terje Kvernes adding quite a lot of missing documentation
[people/mcb30/busybox.git] / networking / Config.in
1 #
2 # For a description of the syntax of this configuration file,
3 # see scripts/kbuild/config-language.txt.
4 #
5
6 menu "Networking Utilities"
7
8 config CONFIG_FEATURE_IPV6
9         bool "Enable IPv6 support"
10         default n
11         help
12           Enable IPv6 support to busybox. This makes applets that talk IP
13           able to work with IPv6.
14
15 config CONFIG_ARPING
16         bool "arping"
17         default n
18         help
19           Ping hosts by ARP packets
20
21 config CONFIG_FTPGET
22         bool "ftpget"
23         default n
24         help
25           Retrieve a remote file via FTP.
26
27 config CONFIG_FTPPUT
28         bool "ftpput"
29         default n
30         help
31           Store a remote file via FTP.
32
33 config CONFIG_HOSTNAME
34         bool "hostname"
35         default n
36         help
37           Show or set the system's host name
38
39 config CONFIG_HTTPD
40         bool "httpd"
41         default n
42         help
43           Serve web pages via an HTTP server.
44
45 config CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
46         bool "  Support call from inetd only"
47         default n
48         depends on CONFIG_HTTPD
49         help
50           This option disables uid and port options for the httpd applet
51           but requires inetd server daemon.
52
53 config CONFIG_FEATURE_HTTPD_BASIC_AUTH
54         bool "  Enable Basic Authentication"
55         default y
56         depends on CONFIG_HTTPD
57         help
58           Utilizes password settings from /etc/httpd.conf for basic
59           authentication on a per url basis.
60
61
62 if !CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
63 config CONFIG_FEATURE_HTTPD_RELOAD_CONFIG_SIGHUP
64         bool "  Enable support reload global config file after hup signaled"
65         default n
66         depends on CONFIG_HTTPD
67         help
68           This option enables processing of SIGHUP to reload cached
69           configuration settings.
70
71 config CONFIG_FEATURE_HTTPD_SETUID
72         bool "  Enable support -u <user> option"
73         default n
74         depends on CONFIG_HTTPD
75         help
76           This option allows the server to run as a specific user
77           rather than defaulting to the user that starts the server.
78           Use of this option requires special privilegies to change to a
79           different user.
80 endif
81
82 config CONFIG_FEATURE_HTTPD_CONFIG_WITH_MIME_TYPES
83         bool "  Enable support load from config file mime types"
84         default n
85         depends on CONFIG_HTTPD
86         help
87           This option enables support for additional mime types at
88           run-time to be specified in the configuration file.
89
90 config CONFIG_FEATURE_HTTPD_CGI
91         bool "  Enable support Common Gateway Interface"
92         default y
93         depends on CONFIG_HTTPD
94         help
95           This option allows scripts and executables to be invoked
96           when specific urls are requested.
97
98 config CONFIG_FEATURE_HTTPD_SET_REMOTE_PORT_TO_ENV
99         bool "  Enable support set eviroment REMOTE_PORT variable for CGI"
100         default n
101         depends on CONFIG_FEATURE_HTTPD_CGI
102         help
103           Use of this option can assist scripts in generating
104           references that contain a unique port number.
105
106 config CONFIG_FEATURE_HTTPD_SET_CGI_VARS_TO_ENV
107         bool "  Enable setting of CGI_varname=value environment vars for CGI"
108         default y
109         depends on CONFIG_FEATURE_HTTPD_CGI
110         help
111           This option parses POST or GET arguments from a form and
112           sets environment variables with their value.  This simplifies
113           and speeds up CGI scripts.  A form argument of foo=bar would
114           result in a script having the environment variable CGI_foo set
115           to 'bar'.  In addition, this option sets a variable that
116           lists all the argument names.  e.g. CGI_VARNAMES_="name1 name2".
117
118 config CONFIG_FEATURE_HTTPD_ENCODE_URL_STR
119         bool "  Enable the -e option for shell script CGI simplification."
120         default y
121         depends on CONFIG_HTTPD
122         help
123           After set, this option allows html encoding arbitrary
124           strings for display of the browser.  Output goes to stdout.
125           For example, httpd -e "<Hello World>" as
126           "&#60Hello&#32World&#62".
127
128 config CONFIG_IFCONFIG
129         bool "ifconfig"
130         default n
131         help
132           Ifconfig is used to configure the kernel-resident network interfaces.
133
134 config CONFIG_FEATURE_IFCONFIG_STATUS
135         bool "  Enable status reporting output (+7k)"
136         default y
137         depends on CONFIG_IFCONFIG
138         help
139           If ifconfig is called with no arguments it will display the status
140           of the currently active interfaces.
141
142 config CONFIG_FEATURE_IFCONFIG_SLIP
143         bool "  Enable slip-specific options \"keepalive\" and \"outfill\""
144         default n
145         depends on CONFIG_IFCONFIG
146         help
147           Allow "keepalive" and "outfill" support for SLIP.  If you're not
148           planning on using serial lines, leave this unchecked.
149
150 config CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
151         bool "  Enable options \"mem_start\", \"io_addr\", and \"irq\""
152         default n
153         depends on CONFIG_IFCONFIG
154         help
155           Allow the start address for shared memory, start address for I/O,
156           and/or the interrupt line used by the specified device.
157
158 config CONFIG_FEATURE_IFCONFIG_HW
159         bool "  Enable option \"hw\" (ether only)"
160         default y
161         depends on CONFIG_IFCONFIG
162         help
163           Set the hardware address of this interface, if the device driver
164           supports  this  operation.  Currently, we only support the 'ether'
165           class.
166
167 config CONFIG_FEATURE_IFCONFIG_BROADCAST_PLUS
168         bool "  Set the broadcast automatically"
169         default n
170         depends on CONFIG_IFCONFIG
171         help
172           Setting this will make ifconfig attempt to find the broadcast
173           automatically if the value '+' is used.
174
175 config CONFIG_IFUPDOWN
176         bool "ifupdown"
177         default n
178         help
179           Activate or deactivate the specified interface.
180
181 config CONFIG_FEATURE_IFUPDOWN_IP
182         bool "  Use ip applet"
183         default n
184         depends on CONFIG_IFUPDOWN && CONFIG_IP && CONFIG_FEATURE_IP_ADDRESS && CONFIG_FEATURE_IP_LINK && CONFIG_FEATURE_IP_ROUTE
185         help
186           Use "ip" in "ifupdown".
187
188 config CONFIG_FEATURE_IFUPDOWN_IPV4
189         bool "  Enable support for IPv4"
190         default y
191         depends on CONFIG_IFUPDOWN
192         help
193           If you want busybox to talk IPv4, leave this on.
194
195 config CONFIG_FEATURE_IFUPDOWN_IPV6
196         bool "  Enable support for IPv6"
197         default n
198         depends on CONFIG_IFUPDOWN
199         help
200           If you need support for IPv6, turn this option on.
201
202 config CONFIG_FEATURE_IFUPDOWN_IPX
203         bool "  Enable support for IPX"
204         default n
205         depends on CONFIG_IFUPDOWN
206         help
207           If this option is selected you can use busybox to work with IPX
208           networks.
209
210 config CONFIG_FEATURE_IFUPDOWN_MAPPING
211         bool "  Enable mapping support"
212         default n
213         depends on CONFIG_IFUPDOWN
214         help
215           This enables support for the "mapping" stanza, unless you have
216           a weird network setup you dont need it.
217
218 config CONFIG_INETD
219         bool "inetd"
220         default n
221         help
222           Internet superserver daemon
223
224 config CONFIG_FEATURE_INETD_SUPPORT_BILTIN_ECHO
225         bool "  Support echo service"
226         default y
227         depends on CONFIG_INETD
228         help
229           Echo received data internal inetd service
230
231 config CONFIG_FEATURE_INETD_SUPPORT_BILTIN_DISCARD
232         bool "  Support discard service"
233         default y
234         depends on CONFIG_INETD
235         help
236           Internet /dev/null internal inetd service
237
238 config CONFIG_FEATURE_INETD_SUPPORT_BILTIN_TIME
239         bool "  Support time service"
240         default y
241         depends on CONFIG_INETD
242         help
243           Return 32 bit time since 1900 internal inetd service
244
245 config CONFIG_FEATURE_INETD_SUPPORT_BILTIN_DAYTIME
246         bool "  Support daytime service"
247         default y
248         depends on CONFIG_INETD
249         help
250           Return human-readable time internal inetd service
251
252 config CONFIG_FEATURE_INETD_SUPPORT_BILTIN_CHARGEN
253         bool "  Support chargen service"
254         default y
255         depends on CONFIG_INETD
256         help
257           Familiar character generator internal inetd service
258
259
260 config CONFIG_IP
261         bool "ip"
262         default n
263         help
264           The "ip" applet is a TCP/IP interface configuration and routing
265           utility.  You generally don't need "ip" to use busybox with
266           TCP/IP.
267
268 if CONFIG_IP && CONFIG_IPADDR
269         config CONFIG_FEATURE_IP_ADDRESS
270                 default y
271         comment "  address (forced enabled for ipaddr)"
272 endif
273 if ! (CONFIG_IP && CONFIG_IPADDR)
274         config CONFIG_FEATURE_IP_ADDRESS
275                 bool "  address"
276                 default y
277                 depends on CONFIG_IP
278                 help
279                   Address manipulation support for the "ip" applet.
280 endif
281
282 if CONFIG_IP && CONFIG_IPLINK
283         config CONFIG_FEATURE_IP_LINK
284                 default y
285         comment "  link (forced enabled for iplink)"
286 endif
287 if !(CONFIG_IP && CONFIG_IPLINK)
288         config CONFIG_FEATURE_IP_LINK
289                 bool "  link"
290                 default y
291                 depends on CONFIG_IP
292                 help
293                   Configure network devices with "ip".
294 endif
295
296 if CONFIG_IP && CONFIG_IPROUTE
297         config CONFIG_FEATURE_IP_ROUTE
298                 default y
299         comment "  route (forced enabled for iproute)"
300 endif
301 if !(CONFIG_IP && CONFIG_IPROUTE)
302         config CONFIG_FEATURE_IP_ROUTE
303                 bool "  route"
304                 default y
305                 depends on CONFIG_IP
306                 help
307                   Add support for routing table management to "ip".  
308 endif
309
310 if CONFIG_IP && CONFIG_IPTUNNEL
311         config CONFIG_FEATURE_IP_TUNNEL
312                 default y
313         comment "  tunnel (forced enabled for iptunnel)"
314 endif
315 if !(CONFIG_IP && CONFIG_IPTUNNEL)
316         config CONFIG_FEATURE_IP_TUNNEL
317                 bool "  tunnel"
318                 default n
319                 depends on CONFIG_IP
320                 help
321                   Add support for tunneling commands to "ip".
322 endif
323
324 config CONFIG_IPCALC
325         bool "ipcalc"
326         default n
327         help
328           ipcalc takes an IP address and netmask and calculates the
329           resulting broadcast, network, and host range.
330
331 config CONFIG_FEATURE_IPCALC_FANCY
332         bool "  Fancy IPCALC, more options, adds 300 bytes"
333         default y
334         depends on CONFIG_IPCALC
335         help
336           Adds the fields hostname and silent to the output of "ipcalc".
337
338 config CONFIG_IPADDR
339         bool "ipaddr"
340         default n
341         help
342           Equivalent to selecting address support to "ip", above.
343
344 config CONFIG_IPLINK
345         bool "iplink"
346         default n
347         help
348           Equivalent to selecting link support to "ip", above.
349
350 config CONFIG_IPROUTE
351         bool "iproute"
352         default n
353         help
354           Equivalent to selecting route support to "ip", above.
355
356 config CONFIG_IPTUNNEL
357         bool "iptunnel"
358         default n
359         help
360           Equivalent to selecting tunnel support to "ip", above.
361
362 config CONFIG_NAMEIF
363         bool "nameif"
364         default n
365         help
366           nameif used to rename network interface by its MAC address.
367           Renamed interfaces MUST be in the down state.
368           It is possible to use file (default: /etc/mactab)
369           with list of new interface names and MACs.
370           Maximum interface name length: IF_NAMESIZE = 16
371           File fields are sepatated by space or tab.
372           File format:
373           # Comment
374           new_interface_name    XX:XX:XX:XX:XX:XX
375
376 config CONFIG_NC
377         bool "nc"
378         default n
379         help
380           A simple Unix utility which reads and writes data across network
381           connections.
382
383 config CONFIG_NETSTAT
384         bool "netstat"
385         default n
386         help
387           Netstat prints information about the Linux networking  subsystem.
388
389 config CONFIG_NSLOOKUP
390         bool "nslookup"
391         default n
392         help
393           Nslookup is a tool to query Internet name servers.
394
395 config CONFIG_PING
396         bool "ping"
397         default n
398         help
399           Ping uses the ICMP protocol's mandatory ECHO_REQUEST datagram to
400           elicit an ICMP ECHO_RESPONSE from a host or gateway.
401
402 config CONFIG_FEATURE_FANCY_PING
403         bool "  Enable fancy ping output"
404         default y
405         depends on CONFIG_PING
406         help
407           Make the output from the ping applet include statistics, and at the
408           same time provide full support for ICMP packets.
409
410 config CONFIG_PING6
411         bool "ping6"
412         default n
413         depends on CONFIG_FEATURE_IPV6
414         help
415           This will give you a ping that can talk IPv6.
416
417 config CONFIG_FEATURE_FANCY_PING6
418         bool "  Enable fancy ping6 output"
419         default y
420         depends on CONFIG_PING6
421         help
422           Make the output from the ping6 applet include statistics, and at the
423           same time provide full support for ICMP packets.
424
425 config CONFIG_ROUTE
426         bool "route"
427         default n
428         help
429           Route displays or manipulates the kernel's IP routing tables.
430
431 config CONFIG_TELNET
432         bool "telnet"
433         default n
434         help
435           Telnet is an interface to the TELNET protocol, but is also commonly
436           used to test other simple protocols.
437
438 config CONFIG_FEATURE_TELNET_TTYPE
439         bool "  Pass TERM type to remote host"
440         default y
441         depends on CONFIG_TELNET
442         help
443           Setting this option will forward the TERM environment variable to the
444           remote host you are connecting to.  This is useful to make sure that
445           things like ANSI colors and other control sequences behave.
446
447 config CONFIG_TELNETD
448         bool "telnetd"
449         default n
450         help
451           A daemon for the TELNET protocol, allowing you to log on to the host
452           running the daemon.  Please keep in mind that the TELNET protocol
453           sends passwords in plain text.  If you can't afford the space for
454           any SSH daemon and you trust your network, say 'y' here.
455
456 config CONFIG_FEATURE_TELNETD_INETD
457         bool "  Support call from inetd only"
458         default n
459         depends on CONFIG_TELNETD
460         help
461           Selecting this will make telnetd only callable from inetd, removing the
462           standalone support.
463
464 config CONFIG_TFTP
465         bool "tftp"
466         default n
467         help
468           This enables the Tirvial File Transfer Protocol client program.  TFTP
469           is usually used for simple, small transfers such as a root image
470           for a network-enabled bootloader.
471
472 config CONFIG_FEATURE_TFTP_GET
473         bool "  Enable \"get\" command"
474         default y
475         depends on CONFIG_TFTP
476         help
477           Add support for the GET command within the TFTP client.  This allows
478           a client to retreive a file from a TFTP server.
479
480 config CONFIG_FEATURE_TFTP_PUT
481         bool "  Enable \"put\" command"
482         default y
483         depends on CONFIG_TFTP
484         help
485           Add support for the PUT command within the TFTP client.  This allows
486           a client to transfer a file to a TFTP server.
487
488 config CONFIG_FEATURE_TFTP_BLOCKSIZE
489         bool "  Enable \"blocksize\" command"
490         default n
491         depends on CONFIG_TFTP
492         help
493           Allow the client to specify the desired block size for transfers.
494
495 config CONFIG_FEATURE_TFTP_DEBUG
496         bool "  Enable debug"
497         default n
498         depends on CONFIG_TFTP
499         help
500           Enable debug settings for tftp.  This is useful if you're running
501           into problems with tftp as the protocol doesn't help you much when
502           you run into problems.
503
504 config CONFIG_TRACEROUTE
505         bool "traceroute"
506         default n
507         help
508           Utility to trace the route of IP packets
509
510 config CONFIG_FEATURE_TRACEROUTE_VERBOSE
511         bool "  Enable verbose output"
512         default n
513         depends on CONFIG_TRACEROUTE
514         help
515           Add some verbosity to traceroute.  This includes amongst other things
516           hostnames and ICMP response types.
517
518 config CONFIG_FEATURE_TRACEROUTE_SO_DEBUG
519         bool "  Enable SO_DEBUG option"
520         default n
521         depends on CONFIG_TRACEROUTE
522         help
523           Please submit a patch to add help text for this item.
524
525 config CONFIG_VCONFIG
526         bool "vconfig"
527         default n
528         help
529           Creates, removes, and configures VLAN interfaces
530
531 config CONFIG_WGET
532         bool "wget"
533         default n
534         help
535           Wget is a utility for non-interactive download of files from HTTP,
536           HTTPS, and FTP servers.
537
538 config CONFIG_FEATURE_WGET_STATUSBAR
539         bool "  Enable a nifty process meter (+2k)"
540         default y
541         depends on CONFIG_WGET
542         help
543           Enable the transfer progress bar for wget transfers.
544
545 config CONFIG_FEATURE_WGET_AUTHENTICATION
546         bool "  Enable HTTP authentication"
547         default y
548         depends on CONFIG_WGET
549         help
550           Support authenticated HTTP transfers.
551
552 source networking/udhcp/Config.in
553
554 endmenu
555