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