less: FEATURE_LESS_LINENUMS depends on FEATURE_LESS_DASHCMD
[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 DEBUG_CROND_OPTION
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 CRONTAB
125         bool "crontab"
126         default n
127         select FEATURE_SUID
128         help
129           Crontab manipulates the crontab for a particular user. Only
130           the superuser may specify a different user and/or crontab directory.
131           Note that Busybox binary must be setuid root for this applet to
132           work properly.
133
134 config DC
135         bool "dc"
136         default n
137         help
138           Dc is a reverse-polish desk calculator which supports unlimited
139           precision arithmetic.
140
141 config FEATURE_DC_LIBM
142         bool "Enable power and exp functions (requires libm)"
143         default n
144         depends on DC
145         help
146           Enable power and exp functions.
147           NOTE: This will require libm to be present for linking.
148
149 config DEVFSD
150         bool "devfsd (obsolete)"
151         default n
152         select FEATURE_SYSLOG
153         help
154           This is deprecated, and will be removed at the end of 2008.
155
156           Provides compatibility with old device names on a devfs systems.
157           You should set it to true if you have devfs enabled.
158           The following keywords in devsfd.conf are supported:
159           "CLEAR_CONFIG", "INCLUDE", "OPTIONAL_INCLUDE", "RESTORE",
160           "PERMISSIONS", "EXECUTE", "COPY", "IGNORE",
161           "MKOLDCOMPAT", "MKNEWCOMPAT","RMOLDCOMPAT", "RMNEWCOMPAT".
162
163            But only if they are written UPPERCASE!!!!!!!!
164
165 config DEVFSD_MODLOAD
166         bool "Adds support for MODLOAD keyword in devsfd.conf"
167         default n
168         depends on DEVFSD
169         help
170           This actually doesn't work with busybox modutils but needs
171           the external modutils.
172
173 config DEVFSD_FG_NP
174         bool "Enables the -fg and -np options"
175         default n
176         depends on DEVFSD
177         help
178           -fg  Run the daemon in the foreground.
179           -np  Exit after parsing the configuration file.
180                Do not poll for events.
181
182 config DEVFSD_VERBOSE
183         bool "Increases logging (and size)"
184         default n
185         depends on DEVFSD
186         help
187           Increases logging to stderr or syslog.
188
189 config FEATURE_DEVFS
190         bool "Use devfs names for all devices (obsolete)"
191         default n
192         help
193           This is obsolete and will be going away at the end of 2008..
194
195           This tells busybox to look for names like /dev/loop/0 instead of
196           /dev/loop0. If your /dev directory has normal names instead of
197           devfs names, you don't want this.
198
199 config EJECT
200         bool "eject"
201         default n
202         help
203           Used to eject cdroms. (defaults to /dev/cdrom)
204
205 config FEATURE_EJECT_SCSI
206         bool "SCSI support"
207         default n
208         depends on EJECT
209         help
210           Add the -s option to eject, this allows to eject SCSI-Devices and
211           usb-storage devices.
212
213 config FBSPLASH
214         bool "fbsplash"
215         default n
216         help
217           Shows splash image and progress bar on framebuffer device.
218           Can be used during boot phase of an embedded device. ~2kb.
219           Usage:
220           - use kernel option 'vga=xxx' or otherwise enable fb device.
221           - put somewhere fbsplash.cfg file and an image in .ppm format.
222           - $ setsid fbsplash [params] &
223             -c: hide cursor
224             -d /dev/fbN: framebuffer device (if not /dev/fb0)
225             -s path_to_image_file (can be "-" for stdin)
226             -i path_to_cfg_file (can be "-" for stdin)
227             -f path_to_fifo (can be "-" for stdin)
228           - if you want to run it only in presence of kernel parameter:
229             grep -q "fbsplash=on" </proc/cmdline && setsid fbsplash [params] &
230           - commands for fifo:
231             "NN" (ASCII decimal number) - percentage to show on progress bar
232             "exit" - well you guessed it
233
234 config INOTIFYD
235         bool "inotifyd"
236         default n
237         help
238           Simple inotify daemon. Reports filesystem changes. Requires
239           kernel >= 2.6.13
240
241 config LAST
242         bool "last"
243         default n
244         select FEATURE_WTMP
245         help
246           'last' displays a list of the last users that logged into the system.
247
248 choice
249         prompt "Choose last implementation"
250         depends on LAST
251         default FEATURE_LAST_SMALL
252
253 config FEATURE_LAST_SMALL
254         bool "small"
255         help
256           This is a small version of last with just the basic set of
257           features.
258
259 config FEATURE_LAST_FANCY
260         bool "huge"
261         help
262           'last' displays detailed information about the last users that
263           logged into the system (mimics sysvinit last). +900 bytes.
264 endchoice
265
266 config LESS
267         bool "less"
268         default n
269         help
270           'less' is a pager, meaning that it displays text files. It possesses
271           a wide array of features, and is an improvement over 'more'.
272
273 config FEATURE_LESS_MAXLINES
274         int "Max number of input lines less will try to eat"
275         default 9999999
276         depends on LESS
277
278 config FEATURE_LESS_BRACKETS
279         bool "Enable bracket searching"
280         default y
281         depends on LESS
282         help
283           This option adds the capability to search for matching left and right
284           brackets, facilitating programming.
285
286 config FEATURE_LESS_FLAGS
287         bool "Enable extra flags"
288         default y
289         depends on LESS
290         help
291           The extra flags provided do the following:
292
293           The -M flag enables a more sophisticated status line.
294           The -m flag enables a simpler status line with a percentage.
295
296 config FEATURE_LESS_DASHCMD
297         bool "Enable flag changes ('-' command)"
298         default n
299         depends on LESS
300         help
301           This enables the ability to change command-line flags within
302           less itself ('-' keyboard command).
303
304 config FEATURE_LESS_MARKS
305         bool "Enable marks"
306         default n
307         depends on LESS
308         help
309           Marks enable positions in a file to be stored for easy reference.
310
311 config FEATURE_LESS_REGEXP
312         bool "Enable regular expressions"
313         default n
314         depends on LESS
315         help
316           Enable regular expressions, allowing complex file searches.
317
318 config FEATURE_LESS_LINENUMS
319         bool "Enable dynamic switching of line numbers"
320         default n
321         depends on FEATURE_LESS_DASHCMD
322         help
323           Enable "-N" command.
324
325 config FEATURE_LESS_WINCH
326         bool "Enable automatic resizing on window size changes"
327         default n
328         depends on LESS
329         help
330           Makes less track window size changes.
331
332 config HDPARM
333         bool "hdparm"
334         default n
335         help
336           Get/Set hard drive parameters. Primarily intended for ATA
337           drives. Adds about 13k (or around 30k if you enable the
338           FEATURE_HDPARM_GET_IDENTITY option)....
339
340 config FEATURE_HDPARM_GET_IDENTITY
341         bool "Support obtaining detailed information directly from drives"
342         default y
343         depends on HDPARM
344         help
345           Enables the -I and -i options to obtain detailed information
346           directly from drives about their capabilities and supported ATA
347           feature set. If no device name is specified, hdparm will read
348           identify data from stdin. Enabling this option will add about 16k...
349
350 config FEATURE_HDPARM_HDIO_SCAN_HWIF
351         bool "Register an IDE interface (DANGEROUS)"
352         default n
353         depends on HDPARM
354         help
355           Enables the 'hdparm -R' option to register an IDE interface.
356           This is dangerous stuff, so you should probably say N.
357
358 config FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
359         bool "Un-register an IDE interface (DANGEROUS)"
360         default n
361         depends on HDPARM
362         help
363           Enables the 'hdparm -U' option to un-register an IDE interface.
364           This is dangerous stuff, so you should probably say N.
365
366 config FEATURE_HDPARM_HDIO_DRIVE_RESET
367         bool "Perform device reset (DANGEROUS)"
368         default n
369         depends on HDPARM
370         help
371           Enables the 'hdparm -w' option to perform a device reset.
372           This is dangerous stuff, so you should probably say N.
373
374 config FEATURE_HDPARM_HDIO_TRISTATE_HWIF
375         bool "Tristate device for hotswap (DANGEROUS)"
376         default n
377         depends on HDPARM
378         help
379           Enables the 'hdparm -x' option to tristate device for hotswap,
380           and the '-b' option to get/set bus state. This is dangerous
381           stuff, so you should probably say N.
382
383 config FEATURE_HDPARM_HDIO_GETSET_DMA
384         bool "Get/set using_dma flag (DANGEROUS)"
385         default n
386         depends on HDPARM
387         help
388           Enables the 'hdparm -d' option to get/set using_dma flag.
389           This is dangerous stuff, so you should probably say N.
390
391 config MAKEDEVS
392         bool "makedevs"
393         default n
394         help
395           'makedevs' is a utility used to create a batch of devices with
396           one command.
397           .
398           There are two choices for command line behaviour, the interface
399           as used by LEAF/Linux Router Project, or a device table file.
400           .
401           'leaf' is traditionally what busybox follows, it allows multiple
402           devices of a particluar type to be created per command.
403           e.g. /dev/hda[0-9]
404           Device properties are passed as command line arguments.
405           .
406           'table' reads device properties from a file or stdin, allowing
407           a batch of unrelated devices to be made with one command.
408           User/group names are allowed as an alternative to uid/gid.
409
410 choice
411         prompt "Choose makedevs behaviour"
412         depends on MAKEDEVS
413         default FEATURE_MAKEDEVS_TABLE
414
415 config FEATURE_MAKEDEVS_LEAF
416         bool "leaf"
417
418 config FEATURE_MAKEDEVS_TABLE
419         bool "table"
420
421 endchoice
422
423 config MAN
424         bool "man"
425         default n
426         help
427           Format and display manual pages.
428
429 config MICROCOM
430         bool "microcom"
431         default n
432         help
433           The poor man's minicom utility for chatting with serial port devices.
434
435 config MOUNTPOINT
436         bool "mountpoint"
437         default n
438         help
439           mountpoint checks if the directory is a mountpoint.
440
441 config MT
442         bool "mt"
443         default n
444         help
445           mt is used to control tape devices. You can use the mt utility
446           to advance or rewind a tape past a specified number of archive
447           files on the tape.
448
449 config RAIDAUTORUN
450         bool "raidautorun"
451         default n
452         help
453           raidautorun tells the kernel md driver to
454           search and start RAID arrays.
455
456 config READAHEAD
457         bool "readahead"
458         default n
459         depends on LFS
460         help
461           Preload the files listed on the command line into RAM cache so that
462           subsequent reads on these files will not block on disk I/O.
463
464           This applet just calls the readahead(2) system call on each file.
465           It is mainly useful in system startup scripts to preload files
466           or executables before they are used. When used at the right time
467           (in particular when a CPU bound process is running) it can
468           significantly speed up system startup.
469
470           As readahead(2) blocks until each file has been read, it is best to
471           run this applet as a background job.
472
473 config RUNLEVEL
474         bool "runlevel"
475         default n
476         help
477           find the current and previous system runlevel.
478
479           This applet uses utmp but does not rely on busybox supporing
480           utmp on purpose. It is used by e.g. emdebian via /etc/init.d/rc.
481
482 config RX
483         bool "rx"
484         default n
485         help
486           Receive files using the Xmodem protocol.
487
488 config SETSID
489         bool "setsid"
490         default n
491         help
492           setsid runs a program in a new session
493
494 config STRINGS
495         bool "strings"
496         default n
497         help
498           strings prints the printable character sequences for each file
499           specified.
500
501 config TASKSET
502         bool "taskset"
503         default n
504         help
505           Retrieve or set a processes's CPU affinity.
506           This requires sched_{g,s}etaffinity support in your libc.
507
508 config FEATURE_TASKSET_FANCY
509         bool "Fancy output"
510         default y
511         depends on TASKSET
512         help
513           Add code for fancy output. This merely silences a compiler-warning
514           and adds about 135 Bytes. May be needed for machines with alot
515           of CPUs.
516
517 config TIME
518         bool "time"
519         default n
520         help
521           The time command runs the specified program with the given arguments.
522           When the command finishes, time writes a message to standard output
523           giving timing statistics about this program run.
524
525 config TTYSIZE
526         bool "ttysize"
527         default n
528         help
529           A replacement for "stty size". Unlike stty, can report only width,
530           only height, or both, in any order. It also does not complain on
531           error, but returns default 80x24.
532           Usage in shell scripts: width=`ttysize w`.
533
534 config WATCHDOG
535         bool "watchdog"
536         default n
537         help
538           The watchdog utility is used with hardware or software watchdog
539           device drivers. It opens the specified watchdog device special file
540           and periodically writes a magic character to the device. If the
541           watchdog applet ever fails to write the magic character within a
542           certain amount of time, the watchdog device assumes the system has
543           hung, and will cause the hardware to reboot.
544
545 endmenu