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