i2cdump: don't read block data in non-block modes
[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 config FEATURE_LAST_FANCY
312         bool "Turn on output of extra information"
313         default y
314         depends on LAST
315         help
316           'last' displays detailed information about the last users that
317           logged into the system (mimics sysvinit last). +900 bytes.
318
319 config HDPARM
320         bool "hdparm"
321         default y
322         select PLATFORM_LINUX
323         help
324           Get/Set hard drive parameters. Primarily intended for ATA
325           drives. Adds about 13k (or around 30k if you enable the
326           FEATURE_HDPARM_GET_IDENTITY option)....
327
328 config FEATURE_HDPARM_GET_IDENTITY
329         bool "Support obtaining detailed information directly from drives"
330         default y
331         depends on HDPARM
332         help
333           Enables the -I and -i options to obtain detailed information
334           directly from drives about their capabilities and supported ATA
335           feature set. If no device name is specified, hdparm will read
336           identify data from stdin. Enabling this option will add about 16k...
337
338 config FEATURE_HDPARM_HDIO_SCAN_HWIF
339         bool "Register an IDE interface (DANGEROUS)"
340         default y
341         depends on HDPARM
342         help
343           Enables the 'hdparm -R' option to register an IDE interface.
344           This is dangerous stuff, so you should probably say N.
345
346 config FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
347         bool "Un-register an IDE interface (DANGEROUS)"
348         default y
349         depends on HDPARM
350         help
351           Enables the 'hdparm -U' option to un-register an IDE interface.
352           This is dangerous stuff, so you should probably say N.
353
354 config FEATURE_HDPARM_HDIO_DRIVE_RESET
355         bool "Perform device reset (DANGEROUS)"
356         default y
357         depends on HDPARM
358         help
359           Enables the 'hdparm -w' option to perform a device reset.
360           This is dangerous stuff, so you should probably say N.
361
362 config FEATURE_HDPARM_HDIO_TRISTATE_HWIF
363         bool "Tristate device for hotswap (DANGEROUS)"
364         default y
365         depends on HDPARM
366         help
367           Enables the 'hdparm -x' option to tristate device for hotswap,
368           and the '-b' option to get/set bus state. This is dangerous
369           stuff, so you should probably say N.
370
371 config FEATURE_HDPARM_HDIO_GETSET_DMA
372         bool "Get/set using_dma flag"
373         default y
374         depends on HDPARM
375         help
376           Enables the 'hdparm -d' option to get/set using_dma flag.
377
378 config MAKEDEVS
379         bool "makedevs"
380         default y
381         help
382           'makedevs' is a utility used to create a batch of devices with
383           one command.
384
385           There are two choices for command line behaviour, the interface
386           as used by LEAF/Linux Router Project, or a device table file.
387
388           'leaf' is traditionally what busybox follows, it allows multiple
389           devices of a particluar type to be created per command.
390           e.g. /dev/hda[0-9]
391           Device properties are passed as command line arguments.
392
393           'table' reads device properties from a file or stdin, allowing
394           a batch of unrelated devices to be made with one command.
395           User/group names are allowed as an alternative to uid/gid.
396
397 choice
398         prompt "Choose makedevs behaviour"
399         depends on MAKEDEVS
400         default FEATURE_MAKEDEVS_TABLE
401
402 config FEATURE_MAKEDEVS_LEAF
403         bool "leaf"
404
405 config FEATURE_MAKEDEVS_TABLE
406         bool "table"
407
408 endchoice
409
410 config MAN
411         bool "man"
412         default y
413         help
414           Format and display manual pages.
415
416 config MICROCOM
417         bool "microcom"
418         default y
419         help
420           The poor man's minicom utility for chatting with serial port devices.
421
422 config MOUNTPOINT
423         bool "mountpoint"
424         default y
425         help
426           mountpoint checks if the directory is a mountpoint.
427
428 config MT
429         bool "mt"
430         default y
431         help
432           mt is used to control tape devices. You can use the mt utility
433           to advance or rewind a tape past a specified number of archive
434           files on the tape.
435
436 config RAIDAUTORUN
437         bool "raidautorun"
438         default y
439         select PLATFORM_LINUX
440         help
441           raidautorun tells the kernel md driver to
442           search and start RAID arrays.
443
444 config READAHEAD
445         bool "readahead"
446         default y
447         depends on LFS
448         select PLATFORM_LINUX
449         help
450           Preload the files listed on the command line into RAM cache so that
451           subsequent reads on these files will not block on disk I/O.
452
453           This applet just calls the readahead(2) system call on each file.
454           It is mainly useful in system startup scripts to preload files
455           or executables before they are used. When used at the right time
456           (in particular when a CPU bound process is running) it can
457           significantly speed up system startup.
458
459           As readahead(2) blocks until each file has been read, it is best to
460           run this applet as a background job.
461
462 config RUNLEVEL
463         bool "runlevel"
464         default y
465         depends on FEATURE_UTMP
466         help
467           find the current and previous system runlevel.
468
469           This applet uses utmp but does not rely on busybox supporing
470           utmp on purpose. It is used by e.g. emdebian via /etc/init.d/rc.
471
472 config RX
473         bool "rx"
474         default y
475         select PLATFORM_LINUX
476         help
477           Receive files using the Xmodem protocol.
478
479 config SETSID
480         bool "setsid"
481         default y
482         help
483           setsid runs a program in a new session
484
485 config STRINGS
486         bool "strings"
487         default y
488         help
489           strings prints the printable character sequences for each file
490           specified.
491
492 config TIME
493         bool "time"
494         default y
495         help
496           The time command runs the specified program with the given arguments.
497           When the command finishes, time writes a message to standard output
498           giving timing statistics about this program run.
499
500 config TIMEOUT
501         bool "timeout"
502         default y
503         help
504           Runs a program and watches it. If it does not terminate in
505           specified number of seconds, it is sent a signal.
506
507 config TTYSIZE
508         bool "ttysize"
509         default y
510         help
511           A replacement for "stty size". Unlike stty, can report only width,
512           only height, or both, in any order. It also does not complain on
513           error, but returns default 80x24.
514           Usage in shell scripts: width=`ttysize w`.
515
516 config VOLNAME
517         bool "volname"
518         default y
519         help
520           Prints a CD-ROM volume name.
521
522 config WATCHDOG
523         bool "watchdog"
524         default y
525         select PLATFORM_LINUX
526         help
527           The watchdog utility is used with hardware or software watchdog
528           device drivers. It opens the specified watchdog device special file
529           and periodically writes a magic character to the device. If the
530           watchdog applet ever fails to write the magic character within a
531           certain amount of time, the watchdog device assumes the system has
532           hung, and will cause the hardware to reboot.
533
534 endmenu