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