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