ifplugd: code shrink
[oweals/busybox.git] / miscutils / Config.src
1 #
2 # For a description of the syntax of this configuration file,
3 # see scripts/kbuild/config-language.txt.
4 #
5
6 menu "Miscellaneous Utilities"
7
8 INSERT
9
10 config ADJTIMEX
11         bool "adjtimex"
12         default y
13         depends on PLATFORM_LINUX
14         help
15           Adjtimex reads and optionally sets adjustment parameters for
16           the Linux clock adjustment algorithm.
17
18 config BBCONFIG
19         bool "bbconfig"
20         default n
21         help
22           The bbconfig applet will print the config file with which
23           busybox was built.
24
25 config BEEP
26         bool "beep"
27         default y
28         depends on PLATFORM_LINUX
29         help
30           The beep applets beeps in a given freq/Hz.
31
32 config FEATURE_BEEP_FREQ
33         int "default frequency"
34         range 0 2147483647
35         default 4000
36         depends on BEEP
37         help
38           Frequency for default beep.
39
40 config FEATURE_BEEP_LENGTH_MS
41         int "default length"
42         range 0 2147483647
43         default 30
44         depends on BEEP
45         help
46           Length in ms for default beep.
47
48 config CHAT
49         bool "chat"
50         default y
51         help
52           Simple chat utility.
53
54 config FEATURE_CHAT_NOFAIL
55         bool "Enable NOFAIL expect strings"
56         depends on CHAT
57         default y
58         help
59           When enabled expect strings which are started with a dash trigger
60           no-fail mode. That is when expectation is not met within timeout
61           the script is not terminated but sends next SEND string and waits
62           for next EXPECT string. This allows to compose far more flexible
63           scripts.
64
65 config FEATURE_CHAT_TTY_HIFI
66         bool "Force STDIN to be a TTY"
67         depends on CHAT
68         default n
69         help
70           Original chat always treats STDIN as a TTY device and sets for it
71           so-called raw mode. This option turns on such behaviour.
72
73 config FEATURE_CHAT_IMPLICIT_CR
74         bool "Enable implicit Carriage Return"
75         depends on CHAT
76         default y
77         help
78           When enabled make chat to terminate all SEND strings with a "\r"
79           unless "\c" is met anywhere in the string.
80
81 config FEATURE_CHAT_SWALLOW_OPTS
82         bool "Swallow options"
83         depends on CHAT
84         default y
85         help
86           Busybox chat require no options. To make it not fail when used
87           in place of original chat (which has a bunch of options) turn
88           this on.
89
90 config FEATURE_CHAT_SEND_ESCAPES
91         bool "Support weird SEND escapes"
92         depends on CHAT
93         default y
94         help
95           Original chat uses some escape sequences in SEND arguments which
96           are not sent to device but rather performs special actions.
97           E.g. "\K" means to send a break sequence to device.
98           "\d" delays execution for a second, "\p" -- for a 1/100 of second.
99           Before turning this option on think twice: do you really need them?
100
101 config FEATURE_CHAT_VAR_ABORT_LEN
102         bool "Support variable-length ABORT conditions"
103         depends on CHAT
104         default y
105         help
106           Original chat uses fixed 50-bytes length ABORT conditions. Say N here.
107
108 config FEATURE_CHAT_CLR_ABORT
109         bool "Support revoking of ABORT conditions"
110         depends on CHAT
111         default y
112         help
113           Support CLR_ABORT directive.
114
115 config CHRT
116         bool "chrt"
117         default y
118         help
119           manipulate real-time attributes of a process.
120           This requires sched_{g,s}etparam support in your libc.
121
122 config CROND
123         bool "crond"
124         default y
125         select FEATURE_SUID
126         select FEATURE_SYSLOG
127         help
128           Crond is a background daemon that parses individual crontab
129           files and executes commands on behalf of the users in question.
130           This is a port of dcron from slackware. It uses files of the
131           format /var/spool/cron/crontabs/<username> files, for example:
132               $ cat /var/spool/cron/crontabs/root
133               # Run daily cron jobs at 4:40 every day:
134               40 4 * * * /etc/cron/daily > /dev/null 2>&1
135
136 config FEATURE_CROND_D
137         bool "Support option -d to redirect output to stderr"
138         depends on CROND
139         default y
140         help
141           -d sets loglevel to 0 (most verbose) and directs all output to stderr.
142
143 config FEATURE_CROND_CALL_SENDMAIL
144         bool "Report command output via email (using sendmail)"
145         default y
146         depends on CROND
147         help
148           Command output will be sent to corresponding user via email.
149
150 config FEATURE_CROND_DIR
151         string "crond spool directory"
152         default "/var/spool/cron"
153         depends on CROND || CRONTAB
154         help
155           Location of crond spool.
156
157 config CRONTAB
158         bool "crontab"
159         default y
160         select FEATURE_SUID
161         help
162           Crontab manipulates the crontab for a particular user. Only
163           the superuser may specify a different user and/or crontab directory.
164           Note that Busybox binary must be setuid root for this applet to
165           work properly.
166
167 config DC
168         bool "dc"
169         default y
170         help
171           Dc is a reverse-polish desk calculator which supports unlimited
172           precision arithmetic.
173
174 config FEATURE_DC_LIBM
175         bool "Enable power and exp functions (requires libm)"
176         default y
177         depends on DC
178         help
179           Enable power and exp functions.
180           NOTE: This will require libm to be present for linking.
181
182 config DEVFSD
183         bool "devfsd (obsolete)"
184         default n
185         depends on PLATFORM_LINUX
186         select FEATURE_SYSLOG
187         help
188           This is deprecated and should NOT be used anymore.
189           Use linux >= 2.6 (optionally with hotplug) and mdev instead!
190           See docs/mdev.txt for detailed instructions on how to use mdev
191           instead.
192
193           Provides compatibility with old device names on a devfs systems.
194           You should set it to true if you have devfs enabled.
195           The following keywords in devsfd.conf are supported:
196           "CLEAR_CONFIG", "INCLUDE", "OPTIONAL_INCLUDE", "RESTORE",
197           "PERMISSIONS", "EXECUTE", "COPY", "IGNORE",
198           "MKOLDCOMPAT", "MKNEWCOMPAT","RMOLDCOMPAT", "RMNEWCOMPAT".
199
200           But only if they are written UPPERCASE!!!!!!!!
201
202 config DEVFSD_MODLOAD
203         bool "Adds support for MODLOAD keyword in devsfd.conf"
204         default y
205         depends on DEVFSD
206         help
207           This actually doesn't work with busybox modutils but needs
208           the external modutils.
209
210 config DEVFSD_FG_NP
211         bool "Enables the -fg and -np options"
212         default y
213         depends on DEVFSD
214         help
215           -fg  Run the daemon in the foreground.
216           -np  Exit after parsing the configuration file.
217                Do not poll for events.
218
219 config DEVFSD_VERBOSE
220         bool "Increases logging (and size)"
221         default y
222         depends on DEVFSD
223         help
224           Increases logging to stderr or syslog.
225
226 config FEATURE_DEVFS
227         bool "Use devfs names for all devices (obsolete)"
228         default n
229         depends on PLATFORM_LINUX
230         help
231           This is obsolete and should NOT be used anymore.
232           Use linux >= 2.6 (optionally with hotplug) and mdev instead!
233
234           For legacy systems -- if there is no way around devfsd -- this
235           tells busybox to look for names like /dev/loop/0 instead of
236           /dev/loop0. If your /dev directory has normal names instead of
237           devfs names, you don't want this.
238
239 config DEVMEM
240         bool "devmem"
241         default y
242         help
243           devmem is a small program that reads and writes from physical
244           memory using /dev/mem.
245
246 config EJECT
247         bool "eject"
248         default y
249         depends on PLATFORM_LINUX
250         help
251           Used to eject cdroms. (defaults to /dev/cdrom)
252
253 config FEATURE_EJECT_SCSI
254         bool "SCSI support"
255         default y
256         depends on EJECT
257         help
258           Add the -s option to eject, this allows to eject SCSI-Devices and
259           usb-storage devices.
260
261 config FBSPLASH
262         bool "fbsplash"
263         default y
264         depends on PLATFORM_LINUX
265         help
266           Shows splash image and progress bar on framebuffer device.
267           Can be used during boot phase of an embedded device. ~2kb.
268           Usage:
269           - use kernel option 'vga=xxx' or otherwise enable fb device.
270           - put somewhere fbsplash.cfg file and an image in .ppm format.
271           - $ setsid fbsplash [params] &
272             -c: hide cursor
273             -d /dev/fbN: framebuffer device (if not /dev/fb0)
274             -s path_to_image_file (can be "-" for stdin)
275             -i path_to_cfg_file (can be "-" for stdin)
276             -f path_to_fifo (can be "-" for stdin)
277           - if you want to run it only in presence of kernel parameter:
278             grep -q "fbsplash=on" </proc/cmdline && setsid fbsplash [params] &
279           - commands for fifo:
280             "NN" (ASCII decimal number) - percentage to show on progress bar
281             "exit" - well you guessed it
282
283 config FLASHCP
284         bool "flashcp"
285         default n  # doesn't build on Ubuntu 8.04
286         help
287           The flashcp binary, inspired by mtd-utils as of git head 5eceb74f7.
288           This utility is used to copy images into a MTD device.
289
290 config FLASH_LOCK
291         bool "flash_lock"
292         default n  # doesn't build on Ubuntu 8.04
293         help
294           The flash_lock binary from mtd-utils as of git head 5ec0c10d0. This
295           utility locks part or all of the flash device.
296
297 config FLASH_UNLOCK
298         bool "flash_unlock"
299         default n  # doesn't build on Ubuntu 8.04
300         help
301           The flash_unlock binary from mtd-utils as of git head 5ec0c10d0. This
302           utility unlocks part or all of the flash device.
303
304 config FLASH_ERASEALL
305         bool "flash_eraseall"
306         default n  # doesn't build on Ubuntu 8.04
307         help
308           The flash_eraseall binary from mtd-utils as of git head c4c6a59eb.
309           This utility is used to erase the whole MTD device.
310
311 config IONICE
312         bool "ionice"
313         default y
314         depends on PLATFORM_LINUX
315         help
316           Set/set program io scheduling class and priority
317           Requires kernel >= 2.6.13
318
319 config INOTIFYD
320         bool "inotifyd"
321         default n  # doesn't build on Knoppix 5
322         help
323           Simple inotify daemon. Reports filesystem changes. Requires
324           kernel >= 2.6.13
325
326 config LAST
327         bool "last"
328         default y
329         depends on FEATURE_WTMP
330         help
331           'last' displays a list of the last users that logged into the system.
332
333 choice
334         prompt "Choose last implementation"
335         depends on LAST
336         default FEATURE_LAST_FANCY
337
338 config FEATURE_LAST_SMALL
339         bool "small"
340         help
341           This is a small version of last with just the basic set of
342           features.
343
344 config FEATURE_LAST_FANCY
345         bool "huge"
346         help
347           'last' displays detailed information about the last users that
348           logged into the system (mimics sysvinit last). +900 bytes.
349 endchoice
350
351 config LESS
352         bool "less"
353         default y
354         depends on PLATFORM_LINUX
355         depends on PLATFORM_LINUX
356         depends on PLATFORM_LINUX
357         depends on PLATFORM_LINUX
358         depends on PLATFORM_LINUX
359         help
360           'less' is a pager, meaning that it displays text files. It possesses
361           a wide array of features, and is an improvement over 'more'.
362
363 config FEATURE_LESS_MAXLINES
364         int "Max number of input lines less will try to eat"
365         default 9999999
366         depends on LESS
367
368 config FEATURE_LESS_BRACKETS
369         bool "Enable bracket searching"
370         default y
371         depends on LESS
372         help
373           This option adds the capability to search for matching left and right
374           brackets, facilitating programming.
375
376 config FEATURE_LESS_FLAGS
377         bool "Enable extra flags"
378         default y
379         depends on LESS
380         help
381           The extra flags provided do the following:
382
383           The -M flag enables a more sophisticated status line.
384           The -m flag enables a simpler status line with a percentage.
385
386 config FEATURE_LESS_MARKS
387         bool "Enable marks"
388         default y
389         depends on LESS
390         help
391           Marks enable positions in a file to be stored for easy reference.
392
393 config FEATURE_LESS_REGEXP
394         bool "Enable regular expressions"
395         default y
396         depends on LESS
397         help
398           Enable regular expressions, allowing complex file searches.
399
400 config FEATURE_LESS_WINCH
401         bool "Enable automatic resizing on window size changes"
402         default y
403         depends on LESS
404         help
405           Makes less track window size changes.
406
407 config FEATURE_LESS_DASHCMD
408         bool "Enable flag changes ('-' command)"
409         default y
410         depends on LESS
411         help
412           This enables the ability to change command-line flags within
413           less itself ('-' keyboard command).
414
415 config FEATURE_LESS_LINENUMS
416         bool "Enable dynamic switching of line numbers"
417         default y
418         depends on FEATURE_LESS_DASHCMD
419         help
420           Enable "-N" command.
421
422 config HDPARM
423         bool "hdparm"
424         default y
425         depends on PLATFORM_LINUX
426         help
427           Get/Set hard drive parameters. Primarily intended for ATA
428           drives. Adds about 13k (or around 30k if you enable the
429           FEATURE_HDPARM_GET_IDENTITY option)....
430
431 config FEATURE_HDPARM_GET_IDENTITY
432         bool "Support obtaining detailed information directly from drives"
433         default y
434         depends on HDPARM
435         help
436           Enables the -I and -i options to obtain detailed information
437           directly from drives about their capabilities and supported ATA
438           feature set. If no device name is specified, hdparm will read
439           identify data from stdin. Enabling this option will add about 16k...
440
441 config FEATURE_HDPARM_HDIO_SCAN_HWIF
442         bool "Register an IDE interface (DANGEROUS)"
443         default y
444         depends on HDPARM
445         help
446           Enables the 'hdparm -R' option to register an IDE interface.
447           This is dangerous stuff, so you should probably say N.
448
449 config FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
450         bool "Un-register an IDE interface (DANGEROUS)"
451         default y
452         depends on HDPARM
453         help
454           Enables the 'hdparm -U' option to un-register an IDE interface.
455           This is dangerous stuff, so you should probably say N.
456
457 config FEATURE_HDPARM_HDIO_DRIVE_RESET
458         bool "Perform device reset (DANGEROUS)"
459         default y
460         depends on HDPARM
461         help
462           Enables the 'hdparm -w' option to perform a device reset.
463           This is dangerous stuff, so you should probably say N.
464
465 config FEATURE_HDPARM_HDIO_TRISTATE_HWIF
466         bool "Tristate device for hotswap (DANGEROUS)"
467         default y
468         depends on HDPARM
469         help
470           Enables the 'hdparm -x' option to tristate device for hotswap,
471           and the '-b' option to get/set bus state. This is dangerous
472           stuff, so you should probably say N.
473
474 config FEATURE_HDPARM_HDIO_GETSET_DMA
475         bool "Get/set using_dma flag"
476         default y
477         depends on HDPARM
478         help
479           Enables the 'hdparm -d' option to get/set using_dma flag.
480
481 config MAKEDEVS
482         bool "makedevs"
483         default y
484         help
485           'makedevs' is a utility used to create a batch of devices with
486           one command.
487           .
488           There are two choices for command line behaviour, the interface
489           as used by LEAF/Linux Router Project, or a device table file.
490           .
491           'leaf' is traditionally what busybox follows, it allows multiple
492           devices of a particluar type to be created per command.
493           e.g. /dev/hda[0-9]
494           Device properties are passed as command line arguments.
495           .
496           'table' reads device properties from a file or stdin, allowing
497           a batch of unrelated devices to be made with one command.
498           User/group names are allowed as an alternative to uid/gid.
499
500 choice
501         prompt "Choose makedevs behaviour"
502         depends on MAKEDEVS
503         default FEATURE_MAKEDEVS_TABLE
504
505 config FEATURE_MAKEDEVS_LEAF
506         bool "leaf"
507
508 config FEATURE_MAKEDEVS_TABLE
509         bool "table"
510
511 endchoice
512
513 config MAN
514         bool "man"
515         default y
516         help
517           Format and display manual pages.
518
519 config MICROCOM
520         bool "microcom"
521         default y
522         help
523           The poor man's minicom utility for chatting with serial port devices.
524
525 config MOUNTPOINT
526         bool "mountpoint"
527         default y
528         help
529           mountpoint checks if the directory is a mountpoint.
530
531 config MT
532         bool "mt"
533         default y
534         help
535           mt is used to control tape devices. You can use the mt utility
536           to advance or rewind a tape past a specified number of archive
537           files on the tape.
538
539 config RAIDAUTORUN
540         bool "raidautorun"
541         default y
542         depends on PLATFORM_LINUX
543         help
544           raidautorun tells the kernel md driver to
545           search and start RAID arrays.
546
547 config READAHEAD
548         bool "readahead"
549         default y
550         depends on LFS && PLATFORM_LINUX
551         help
552           Preload the files listed on the command line into RAM cache so that
553           subsequent reads on these files will not block on disk I/O.
554
555           This applet just calls the readahead(2) system call on each file.
556           It is mainly useful in system startup scripts to preload files
557           or executables before they are used. When used at the right time
558           (in particular when a CPU bound process is running) it can
559           significantly speed up system startup.
560
561           As readahead(2) blocks until each file has been read, it is best to
562           run this applet as a background job.
563
564 config RFKILL
565         bool "rfkill"
566         default n  # doesn't build on Ubuntu 9.04
567         depends on PLATFORM_LINUX
568         help
569           Enable/disable wireless devices.
570
571           rfkill list : list all wireless devices
572           rfkill list bluetooth : list all bluetooth devices
573           rfkill list 1 : list device corresponding to the given index
574           rfkill block|unblock wlan : block/unblock all wlan(wifi) devices
575
576 config RUNLEVEL
577         bool "runlevel"
578         default y
579         help
580           find the current and previous system runlevel.
581
582           This applet uses utmp but does not rely on busybox supporing
583           utmp on purpose. It is used by e.g. emdebian via /etc/init.d/rc.
584
585 config RX
586         bool "rx"
587         default y
588         depends on PLATFORM_LINUX
589         help
590           Receive files using the Xmodem protocol.
591
592 config SETSID
593         bool "setsid"
594         default y
595         help
596           setsid runs a program in a new session
597
598 config STRINGS
599         bool "strings"
600         default y
601         help
602           strings prints the printable character sequences for each file
603           specified.
604
605 config TASKSET
606         bool "taskset"
607         default n  # doesn't build on some non-x86 targets (m68k)
608         help
609           Retrieve or set a processes's CPU affinity.
610           This requires sched_{g,s}etaffinity support in your libc.
611
612 config FEATURE_TASKSET_FANCY
613         bool "Fancy output"
614         default y
615         depends on TASKSET
616         help
617           Add code for fancy output. This merely silences a compiler-warning
618           and adds about 135 Bytes. May be needed for machines with alot
619           of CPUs.
620
621 config TIME
622         bool "time"
623         default y
624         help
625           The time command runs the specified program with the given arguments.
626           When the command finishes, time writes a message to standard output
627           giving timing statistics about this program run.
628
629 config TIMEOUT
630         bool "timeout"
631         default y
632         help
633           Runs a program and watches it. If it does not terminate in
634           specified number of seconds, it is sent a signal.
635
636 config TTYSIZE
637         bool "ttysize"
638         default y
639         help
640           A replacement for "stty size". Unlike stty, can report only width,
641           only height, or both, in any order. It also does not complain on
642           error, but returns default 80x24.
643           Usage in shell scripts: width=`ttysize w`.
644
645 config VOLNAME
646         bool "volname"
647         default y
648         help
649           Prints a CD-ROM volume name.
650
651 config WALL
652         bool "wall"
653         default y
654         help
655           Write a message to all users that are logged in.
656
657 config WATCHDOG
658         bool "watchdog"
659         default y
660         depends on PLATFORM_LINUX
661         help
662           The watchdog utility is used with hardware or software watchdog
663           device drivers. It opens the specified watchdog device special file
664           and periodically writes a magic character to the device. If the
665           watchdog applet ever fails to write the magic character within a
666           certain amount of time, the watchdog device assumes the system has
667           hung, and will cause the hardware to reboot.
668
669 endmenu