less: fix duplicate "depends on PLATFORM_LINUX". no code changes
[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         help
356           'less' is a pager, meaning that it displays text files. It possesses
357           a wide array of features, and is an improvement over 'more'.
358
359 config FEATURE_LESS_MAXLINES
360         int "Max number of input lines less will try to eat"
361         default 9999999
362         depends on LESS
363
364 config FEATURE_LESS_BRACKETS
365         bool "Enable bracket searching"
366         default y
367         depends on LESS
368         help
369           This option adds the capability to search for matching left and right
370           brackets, facilitating programming.
371
372 config FEATURE_LESS_FLAGS
373         bool "Enable extra flags"
374         default y
375         depends on LESS
376         help
377           The extra flags provided do the following:
378
379           The -M flag enables a more sophisticated status line.
380           The -m flag enables a simpler status line with a percentage.
381
382 config FEATURE_LESS_MARKS
383         bool "Enable marks"
384         default y
385         depends on LESS
386         help
387           Marks enable positions in a file to be stored for easy reference.
388
389 config FEATURE_LESS_REGEXP
390         bool "Enable regular expressions"
391         default y
392         depends on LESS
393         help
394           Enable regular expressions, allowing complex file searches.
395
396 config FEATURE_LESS_WINCH
397         bool "Enable automatic resizing on window size changes"
398         default y
399         depends on LESS
400         help
401           Makes less track window size changes.
402
403 config FEATURE_LESS_DASHCMD
404         bool "Enable flag changes ('-' command)"
405         default y
406         depends on LESS
407         help
408           This enables the ability to change command-line flags within
409           less itself ('-' keyboard command).
410
411 config FEATURE_LESS_LINENUMS
412         bool "Enable dynamic switching of line numbers"
413         default y
414         depends on FEATURE_LESS_DASHCMD
415         help
416           Enables "-N" command.
417
418 config HDPARM
419         bool "hdparm"
420         default y
421         depends on PLATFORM_LINUX
422         help
423           Get/Set hard drive parameters. Primarily intended for ATA
424           drives. Adds about 13k (or around 30k if you enable the
425           FEATURE_HDPARM_GET_IDENTITY option)....
426
427 config FEATURE_HDPARM_GET_IDENTITY
428         bool "Support obtaining detailed information directly from drives"
429         default y
430         depends on HDPARM
431         help
432           Enables the -I and -i options to obtain detailed information
433           directly from drives about their capabilities and supported ATA
434           feature set. If no device name is specified, hdparm will read
435           identify data from stdin. Enabling this option will add about 16k...
436
437 config FEATURE_HDPARM_HDIO_SCAN_HWIF
438         bool "Register an IDE interface (DANGEROUS)"
439         default y
440         depends on HDPARM
441         help
442           Enables the 'hdparm -R' option to register an IDE interface.
443           This is dangerous stuff, so you should probably say N.
444
445 config FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
446         bool "Un-register an IDE interface (DANGEROUS)"
447         default y
448         depends on HDPARM
449         help
450           Enables the 'hdparm -U' option to un-register an IDE interface.
451           This is dangerous stuff, so you should probably say N.
452
453 config FEATURE_HDPARM_HDIO_DRIVE_RESET
454         bool "Perform device reset (DANGEROUS)"
455         default y
456         depends on HDPARM
457         help
458           Enables the 'hdparm -w' option to perform a device reset.
459           This is dangerous stuff, so you should probably say N.
460
461 config FEATURE_HDPARM_HDIO_TRISTATE_HWIF
462         bool "Tristate device for hotswap (DANGEROUS)"
463         default y
464         depends on HDPARM
465         help
466           Enables the 'hdparm -x' option to tristate device for hotswap,
467           and the '-b' option to get/set bus state. This is dangerous
468           stuff, so you should probably say N.
469
470 config FEATURE_HDPARM_HDIO_GETSET_DMA
471         bool "Get/set using_dma flag"
472         default y
473         depends on HDPARM
474         help
475           Enables the 'hdparm -d' option to get/set using_dma flag.
476
477 config MAKEDEVS
478         bool "makedevs"
479         default y
480         help
481           'makedevs' is a utility used to create a batch of devices with
482           one command.
483
484           There are two choices for command line behaviour, the interface
485           as used by LEAF/Linux Router Project, or a device table file.
486
487           'leaf' is traditionally what busybox follows, it allows multiple
488           devices of a particluar type to be created per command.
489           e.g. /dev/hda[0-9]
490           Device properties are passed as command line arguments.
491
492           'table' reads device properties from a file or stdin, allowing
493           a batch of unrelated devices to be made with one command.
494           User/group names are allowed as an alternative to uid/gid.
495
496 choice
497         prompt "Choose makedevs behaviour"
498         depends on MAKEDEVS
499         default FEATURE_MAKEDEVS_TABLE
500
501 config FEATURE_MAKEDEVS_LEAF
502         bool "leaf"
503
504 config FEATURE_MAKEDEVS_TABLE
505         bool "table"
506
507 endchoice
508
509 config MAN
510         bool "man"
511         default y
512         help
513           Format and display manual pages.
514
515 config MICROCOM
516         bool "microcom"
517         default y
518         help
519           The poor man's minicom utility for chatting with serial port devices.
520
521 config MOUNTPOINT
522         bool "mountpoint"
523         default y
524         help
525           mountpoint checks if the directory is a mountpoint.
526
527 config MT
528         bool "mt"
529         default y
530         help
531           mt is used to control tape devices. You can use the mt utility
532           to advance or rewind a tape past a specified number of archive
533           files on the tape.
534
535 config RAIDAUTORUN
536         bool "raidautorun"
537         default y
538         depends on PLATFORM_LINUX
539         help
540           raidautorun tells the kernel md driver to
541           search and start RAID arrays.
542
543 config READAHEAD
544         bool "readahead"
545         default y
546         depends on LFS && PLATFORM_LINUX
547         help
548           Preload the files listed on the command line into RAM cache so that
549           subsequent reads on these files will not block on disk I/O.
550
551           This applet just calls the readahead(2) system call on each file.
552           It is mainly useful in system startup scripts to preload files
553           or executables before they are used. When used at the right time
554           (in particular when a CPU bound process is running) it can
555           significantly speed up system startup.
556
557           As readahead(2) blocks until each file has been read, it is best to
558           run this applet as a background job.
559
560 config RFKILL
561         bool "rfkill"
562         default n  # doesn't build on Ubuntu 9.04
563         depends on PLATFORM_LINUX
564         help
565           Enable/disable wireless devices.
566
567           rfkill list : list all wireless devices
568           rfkill list bluetooth : list all bluetooth devices
569           rfkill list 1 : list device corresponding to the given index
570           rfkill block|unblock wlan : block/unblock all wlan(wifi) devices
571
572 config RUNLEVEL
573         bool "runlevel"
574         default y
575         help
576           find the current and previous system runlevel.
577
578           This applet uses utmp but does not rely on busybox supporing
579           utmp on purpose. It is used by e.g. emdebian via /etc/init.d/rc.
580
581 config RX
582         bool "rx"
583         default y
584         depends on PLATFORM_LINUX
585         help
586           Receive files using the Xmodem protocol.
587
588 config SETSID
589         bool "setsid"
590         default y
591         help
592           setsid runs a program in a new session
593
594 config STRINGS
595         bool "strings"
596         default y
597         help
598           strings prints the printable character sequences for each file
599           specified.
600
601 config TASKSET
602         bool "taskset"
603         default n  # doesn't build on some non-x86 targets (m68k)
604         help
605           Retrieve or set a processes's CPU affinity.
606           This requires sched_{g,s}etaffinity support in your libc.
607
608 config FEATURE_TASKSET_FANCY
609         bool "Fancy output"
610         default y
611         depends on TASKSET
612         help
613           Add code for fancy output. This merely silences a compiler-warning
614           and adds about 135 Bytes. May be needed for machines with alot
615           of CPUs.
616
617 config TIME
618         bool "time"
619         default y
620         help
621           The time command runs the specified program with the given arguments.
622           When the command finishes, time writes a message to standard output
623           giving timing statistics about this program run.
624
625 config TIMEOUT
626         bool "timeout"
627         default y
628         help
629           Runs a program and watches it. If it does not terminate in
630           specified number of seconds, it is sent a signal.
631
632 config TTYSIZE
633         bool "ttysize"
634         default y
635         help
636           A replacement for "stty size". Unlike stty, can report only width,
637           only height, or both, in any order. It also does not complain on
638           error, but returns default 80x24.
639           Usage in shell scripts: width=`ttysize w`.
640
641 config VOLNAME
642         bool "volname"
643         default y
644         help
645           Prints a CD-ROM volume name.
646
647 config WALL
648         bool "wall"
649         default y
650         help
651           Write a message to all users that are logged in.
652
653 config WATCHDOG
654         bool "watchdog"
655         default y
656         depends on PLATFORM_LINUX
657         help
658           The watchdog utility is used with hardware or software watchdog
659           device drivers. It opens the specified watchdog device special file
660           and periodically writes a magic character to the device. If the
661           watchdog applet ever fails to write the magic character within a
662           certain amount of time, the watchdog device assumes the system has
663           hung, and will cause the hardware to reboot.
664
665 endmenu