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