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