hush: tighten up "for" variable name check.
[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_ERASEALL
254         bool "flash_eraseall"
255         default n
256         help
257           The flash_eraseall binary from mtd-utils as of git head c4c6a59eb.
258           This utility is used to erase the whole MTD device.
259
260 config IONICE
261         bool "ionice"
262         default n
263         help
264           Set/set program io scheduling class and priority
265           Requires kernel >= 2.6.13
266
267 config INOTIFYD
268         bool "inotifyd"
269         default n
270         help
271           Simple inotify daemon. Reports filesystem changes. Requires
272           kernel >= 2.6.13
273
274 config LAST
275         bool "last"
276         default n
277         select FEATURE_WTMP
278         help
279           'last' displays a list of the last users that logged into the system.
280
281 choice
282         prompt "Choose last implementation"
283         depends on LAST
284         default FEATURE_LAST_SMALL
285
286 config FEATURE_LAST_SMALL
287         bool "small"
288         help
289           This is a small version of last with just the basic set of
290           features.
291
292 config FEATURE_LAST_FANCY
293         bool "huge"
294         help
295           'last' displays detailed information about the last users that
296           logged into the system (mimics sysvinit last). +900 bytes.
297 endchoice
298
299 config LESS
300         bool "less"
301         default n
302         help
303           'less' is a pager, meaning that it displays text files. It possesses
304           a wide array of features, and is an improvement over 'more'.
305
306 config FEATURE_LESS_MAXLINES
307         int "Max number of input lines less will try to eat"
308         default 9999999
309         depends on LESS
310
311 config FEATURE_LESS_BRACKETS
312         bool "Enable bracket searching"
313         default y
314         depends on LESS
315         help
316           This option adds the capability to search for matching left and right
317           brackets, facilitating programming.
318
319 config FEATURE_LESS_FLAGS
320         bool "Enable extra flags"
321         default y
322         depends on LESS
323         help
324           The extra flags provided do the following:
325
326           The -M flag enables a more sophisticated status line.
327           The -m flag enables a simpler status line with a percentage.
328
329 config FEATURE_LESS_MARKS
330         bool "Enable marks"
331         default n
332         depends on LESS
333         help
334           Marks enable positions in a file to be stored for easy reference.
335
336 config FEATURE_LESS_REGEXP
337         bool "Enable regular expressions"
338         default n
339         depends on LESS
340         help
341           Enable regular expressions, allowing complex file searches.
342
343 config FEATURE_LESS_WINCH
344         bool "Enable automatic resizing on window size changes"
345         default n
346         depends on LESS
347         help
348           Makes less track window size changes.
349
350 config FEATURE_LESS_DASHCMD
351         bool "Enable flag changes ('-' command)"
352         default n
353         depends on LESS
354         help
355           This enables the ability to change command-line flags within
356           less itself ('-' keyboard command).
357
358 config FEATURE_LESS_LINENUMS
359         bool "Enable dynamic switching of line numbers"
360         default n
361         depends on FEATURE_LESS_DASHCMD
362         help
363           Enable "-N" command.
364
365 config HDPARM
366         bool "hdparm"
367         default n
368         help
369           Get/Set hard drive parameters. Primarily intended for ATA
370           drives. Adds about 13k (or around 30k if you enable the
371           FEATURE_HDPARM_GET_IDENTITY option)....
372
373 config FEATURE_HDPARM_GET_IDENTITY
374         bool "Support obtaining detailed information directly from drives"
375         default y
376         depends on HDPARM
377         help
378           Enables the -I and -i options to obtain detailed information
379           directly from drives about their capabilities and supported ATA
380           feature set. If no device name is specified, hdparm will read
381           identify data from stdin. Enabling this option will add about 16k...
382
383 config FEATURE_HDPARM_HDIO_SCAN_HWIF
384         bool "Register an IDE interface (DANGEROUS)"
385         default n
386         depends on HDPARM
387         help
388           Enables the 'hdparm -R' option to register an IDE interface.
389           This is dangerous stuff, so you should probably say N.
390
391 config FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
392         bool "Un-register an IDE interface (DANGEROUS)"
393         default n
394         depends on HDPARM
395         help
396           Enables the 'hdparm -U' option to un-register an IDE interface.
397           This is dangerous stuff, so you should probably say N.
398
399 config FEATURE_HDPARM_HDIO_DRIVE_RESET
400         bool "Perform device reset (DANGEROUS)"
401         default n
402         depends on HDPARM
403         help
404           Enables the 'hdparm -w' option to perform a device reset.
405           This is dangerous stuff, so you should probably say N.
406
407 config FEATURE_HDPARM_HDIO_TRISTATE_HWIF
408         bool "Tristate device for hotswap (DANGEROUS)"
409         default n
410         depends on HDPARM
411         help
412           Enables the 'hdparm -x' option to tristate device for hotswap,
413           and the '-b' option to get/set bus state. This is dangerous
414           stuff, so you should probably say N.
415
416 config FEATURE_HDPARM_HDIO_GETSET_DMA
417         bool "Get/set using_dma flag"
418         default n
419         depends on HDPARM
420         help
421           Enables the 'hdparm -d' option to get/set using_dma flag.
422
423 config MAKEDEVS
424         bool "makedevs"
425         default n
426         help
427           'makedevs' is a utility used to create a batch of devices with
428           one command.
429           .
430           There are two choices for command line behaviour, the interface
431           as used by LEAF/Linux Router Project, or a device table file.
432           .
433           'leaf' is traditionally what busybox follows, it allows multiple
434           devices of a particluar type to be created per command.
435           e.g. /dev/hda[0-9]
436           Device properties are passed as command line arguments.
437           .
438           'table' reads device properties from a file or stdin, allowing
439           a batch of unrelated devices to be made with one command.
440           User/group names are allowed as an alternative to uid/gid.
441
442 choice
443         prompt "Choose makedevs behaviour"
444         depends on MAKEDEVS
445         default FEATURE_MAKEDEVS_TABLE
446
447 config FEATURE_MAKEDEVS_LEAF
448         bool "leaf"
449
450 config FEATURE_MAKEDEVS_TABLE
451         bool "table"
452
453 endchoice
454
455 config MAN
456         bool "man"
457         default n
458         help
459           Format and display manual pages.
460
461 config MICROCOM
462         bool "microcom"
463         default n
464         help
465           The poor man's minicom utility for chatting with serial port devices.
466
467 config MOUNTPOINT
468         bool "mountpoint"
469         default n
470         help
471           mountpoint checks if the directory is a mountpoint.
472
473 config MT
474         bool "mt"
475         default n
476         help
477           mt is used to control tape devices. You can use the mt utility
478           to advance or rewind a tape past a specified number of archive
479           files on the tape.
480
481 config RAIDAUTORUN
482         bool "raidautorun"
483         default n
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 n
491         depends on LFS
492         help
493           Preload the files listed on the command line into RAM cache so that
494           subsequent reads on these files will not block on disk I/O.
495
496           This applet just calls the readahead(2) system call on each file.
497           It is mainly useful in system startup scripts to preload files
498           or executables before they are used. When used at the right time
499           (in particular when a CPU bound process is running) it can
500           significantly speed up system startup.
501
502           As readahead(2) blocks until each file has been read, it is best to
503           run this applet as a background job.
504
505 config RUNLEVEL
506         bool "runlevel"
507         default n
508         help
509           find the current and previous system runlevel.
510
511           This applet uses utmp but does not rely on busybox supporing
512           utmp on purpose. It is used by e.g. emdebian via /etc/init.d/rc.
513
514 config RX
515         bool "rx"
516         default n
517         help
518           Receive files using the Xmodem protocol.
519
520 config SETSID
521         bool "setsid"
522         default n
523         help
524           setsid runs a program in a new session
525
526 config STRINGS
527         bool "strings"
528         default n
529         help
530           strings prints the printable character sequences for each file
531           specified.
532
533 config TASKSET
534         bool "taskset"
535         default n
536         help
537           Retrieve or set a processes's CPU affinity.
538           This requires sched_{g,s}etaffinity support in your libc.
539
540 config FEATURE_TASKSET_FANCY
541         bool "Fancy output"
542         default y
543         depends on TASKSET
544         help
545           Add code for fancy output. This merely silences a compiler-warning
546           and adds about 135 Bytes. May be needed for machines with alot
547           of CPUs.
548
549 config TIME
550         bool "time"
551         default n
552         help
553           The time command runs the specified program with the given arguments.
554           When the command finishes, time writes a message to standard output
555           giving timing statistics about this program run.
556
557 config TIMEOUT
558         bool "timeout"
559         default n
560         help
561           Runs a program and watches it. If it does not terminate in
562           specified number of seconds, it is sent a signal.
563
564 config TTYSIZE
565         bool "ttysize"
566         default n
567         help
568           A replacement for "stty size". Unlike stty, can report only width,
569           only height, or both, in any order. It also does not complain on
570           error, but returns default 80x24.
571           Usage in shell scripts: width=`ttysize w`.
572
573 config WATCHDOG
574         bool "watchdog"
575         default n
576         help
577           The watchdog utility is used with hardware or software watchdog
578           device drivers. It opens the specified watchdog device special file
579           and periodically writes a magic character to the device. If the
580           watchdog applet ever fails to write the magic character within a
581           certain amount of time, the watchdog device assumes the system has
582           hung, and will cause the hardware to reboot.
583
584 endmenu