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