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