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