b292e2568b494296eb4c57e1782be940ec51bcc4
[oweals/busybox.git] / 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 "Coreutils"
7
8 config CONFIG_BASENAME
9         bool "basename"
10         default n
11         help
12           basename is used to strip the directory and suffix from filenames,
13           leaving just the filename itself.  Enable this option if you wish
14           to enable the 'basename' utility.
15
16 config CONFIG_CAL
17         bool "cal"
18         default n
19         help
20           cal is used to display a monthly calender.
21
22 config CONFIG_CAT
23         bool "cat"
24         default n
25         help
26           cat is used to concatenate files and print them to the standard
27           output.  Enable this option if you wish to enable the 'cat' utility.
28
29 config CONFIG_CHGRP
30         bool "chgrp"
31         default n
32         help
33           chgrp is used to change the group ownership of files.
34
35 config CONFIG_CHMOD
36         bool "chmod"
37         default n
38         help
39           chmod is used to change the access permission of files.
40
41 config CONFIG_CHOWN
42         bool "chown"
43         default n
44         help
45           chown is used to change the user and/or group ownership
46           of files.
47
48 config CONFIG_CHROOT
49         bool "chroot"
50         default n
51         help
52           chroot is used to change the root directory and run a command.
53           The default command is `/bin/sh'.
54
55 config CONFIG_CMP
56         bool "cmp"
57         default n
58         help
59           cmp is used to compare two files and returns the result
60           to standard output.
61
62 config CONFIG_CP
63         bool "cp"
64         default n
65         help
66           cp is used to copy files and directories.
67
68 config CONFIG_CUT
69         bool "cut"
70         default n
71         help
72           cut is used to print selected parts of lines from
73           each file to stdout.
74
75 if CONFIG_WATCH
76         config CONFIG_DATE
77                 default y
78         comment "date (forced enabled for use with watch)"
79 endif
80
81 if !CONFIG_WATCH
82     config CONFIG_DATE
83             bool "date"
84             default n
85             help
86               date is used to set the system date or display the
87               current time in the given format.
88 endif
89
90 config CONFIG_FEATURE_DATE_ISOFMT
91         bool "  Enable ISO date format output (-I)"
92         default y
93         depends on CONFIG_DATE
94         help
95           Enable option (-I) to output an ISO-8601 compliant
96           date/time string.
97
98 config CONFIG_DD
99         bool "dd"
100         default n
101         help
102           dd copies a file (from standard input to standard output,
103           by default) using specific input and output blocksizes,
104           while optionally performing conversions on it.
105
106 config CONFIG_DF
107         bool "df"
108         default n
109         help
110           df reports the amount of disk space used and available
111           on filesystems.
112
113 config CONFIG_DIRNAME
114         bool "dirname"
115         default n
116         help
117           dirname is used to strip a non-directory suffix from
118           a file name.
119
120 config CONFIG_DOS2UNIX
121         bool "dos2unix/unix2dos"
122         default n
123         help
124           dos2unix is used to convert a text file from DOS format to
125           UNIX format, and vice versa.
126
127 config CONFIG_UNIX2DOS
128         bool
129         default y
130         depends on CONFIG_DOS2UNIX
131
132 config CONFIG_DU
133         bool "du (default blocksize of 512 bytes)"
134         default n
135         help
136           du is used to report the amount of disk space used
137           for specified files.
138
139 config CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K
140         bool "  Use a default blocksize of 1024 bytes (1K)"
141         default y
142         depends on CONFIG_DU
143         help
144           Use a blocksize of (1K) instead of the default 512b.
145
146 config CONFIG_ECHO
147         bool "echo (basic SUSv3 version taking no options)"
148         default n
149         help
150           echo is used to print a specified string to stdout.
151
152 config CONFIG_FEATURE_FANCY_ECHO
153         bool "  Enable echo options (-n and -e)"
154         default y
155         depends on CONFIG_ECHO
156         help
157           This adds options (-n and -e) to echo.
158
159 config CONFIG_ENV
160         bool "env"
161         default n
162         help
163           env is used to set an environment variable and run
164           a command; without options it displays the current
165           environment.
166
167 config CONFIG_PRINTENV
168         bool "printenv"
169         default n
170         help
171           printenv is used to print all or part of environment.
172
173 config CONFIG_EXPR
174         bool "expr"
175         default n
176         help
177           expr is used to calculate numbers and print the result
178           to standard output.
179
180 if CONFIG_HUSH || CONFIG_LASH || CONFIG_MSH
181         config CONFIG_FALSE
182                 default y
183         comment "false (forced enabled for use with shell)"
184 endif
185
186 if !CONFIG_HUSH && !CONFIG_LASH && !CONFIG_MSH
187     config CONFIG_FALSE
188             bool "false"
189             default n
190             help
191               false returns an exit code of FALSE (1).
192 endif
193
194 config CONFIG_FOLD
195         bool "fold"
196         default n
197         help
198           Wrap text to fit a specific width.
199
200 config CONFIG_HEAD
201         bool "head"
202         default n
203         help
204           head is used to print the first specified number of lines
205           from files.
206
207 config CONFIG_FEATURE_FANCY_HEAD
208         bool "  Enable head options (-c, -q, and -v)"
209         default n
210         depends on CONFIG_HEAD
211         help
212           This enables the head options (-c, -q, and -v).
213
214 config CONFIG_HOSTID
215         bool "hostid"
216         default n
217         help
218           hostid prints the numeric identifier (in hexadecimal) for
219           the current host.
220
221 config CONFIG_ID
222         bool "id"
223         default n
224         help
225           id displays the current user and group ID names.
226
227 config CONFIG_INSTALL
228         bool "install"
229         default n
230         help
231           Copy files and set attributes.
232
233 config CONFIG_LENGTH
234         bool "length"
235         default n
236         help
237           length is used to print out the length of a specified string.
238
239 config CONFIG_LN
240         bool "ln"
241         default n
242         help
243           ln is used to create hard or soft links between files.
244
245 config CONFIG_LOGNAME
246         bool "logname"
247         default n
248         help
249           logname is used to print the current user's login name.
250
251 config CONFIG_LS
252         bool "ls"
253         default n
254         help
255           ls is used to list the contents of directories.
256
257 config CONFIG_FEATURE_LS_FILETYPES
258         bool "  Enable filetyping options (-p and -F)"
259         default y
260         depends on CONFIG_LS
261         help
262           Enable the ls options (-p and -F).
263
264 config CONFIG_FEATURE_LS_FOLLOWLINKS
265         bool "  Enable symlinks dereferencing (-L)"
266         default y
267         depends on CONFIG_LS
268         help
269           Enable the ls option (-L).
270
271 config CONFIG_FEATURE_LS_RECURSIVE
272         bool "  Enable recursion (-R)"
273         default y
274         depends on CONFIG_LS
275         help
276           Enable the ls option (-R).
277
278 config CONFIG_FEATURE_LS_SORTFILES
279         bool "  Sort the file names"
280         default y
281         depends on CONFIG_LS
282         help
283           Allow ls to sort file names alphabetically.
284
285 config CONFIG_FEATURE_LS_TIMESTAMPS
286         bool "  Show file timestamps"
287         default y
288         depends on CONFIG_LS
289         help
290           Allow ls to display timestamps for files.
291
292 config CONFIG_FEATURE_LS_USERNAME
293         bool "  Show username/groupnames"
294         default y
295         depends on CONFIG_LS
296         help
297           Allow ls to display username/groupname for files.
298
299 config CONFIG_FEATURE_LS_COLOR
300         bool "  Use color to identify file types"
301         default y
302         depends on CONFIG_LS
303         help
304           Allow ls to use color when displaying files.
305
306 config CONFIG_MD5SUM
307         bool "md5sum"
308         default n
309         help
310           md5sum is used to print or check MD5 checksums.
311
312 config CONFIG_MKDIR
313         bool "mkdir"
314         default n
315         help
316           mkdir is used to create directories with the specified names.
317
318 config CONFIG_MKFIFO
319         bool "mkfifo"
320         default n
321         help
322           mkfifo is used to create FIFOs (named pipes).
323           The `mknod' program can also create FIFOs.
324
325 config CONFIG_MKNOD
326         bool "mknod"
327         default n
328         help
329           mknod is used to create FIFOs or block/character special
330           files with the specified names.
331
332 config CONFIG_MV
333         bool "mv"
334         default n
335         help
336           mv is used to move or rename files or directories.
337
338 config CONFIG_NICE
339         bool "nice"
340         default n
341         help
342           nice runs a program with modified scheduling priority.
343
344 config CONFIG_OD
345         bool "od"
346         default n
347         help
348           od is used to dump binary files in octal and other formats.
349
350 config CONFIG_PRINTF
351         bool "printf"
352         default n
353         help
354           printf is used to format and print specified strings.
355           It's similar to `echo' except it has more options.
356
357 config CONFIG_PWD
358         bool "pwd"
359         default n
360         help
361           pwd is used to print the current directory.
362
363 config CONFIG_REALPATH
364         bool "realpath"
365         default n
366         help
367           Return the canonicalized absolute pathname.
368           This isn't provided by GNU shellutils, but where else does it belong.
369
370 config CONFIG_RM
371         bool "rm"
372         default n
373         help
374           rm is used to remove files or directories.
375
376 config CONFIG_RMDIR
377         bool "rmdir"
378         default n
379         help
380           rmdir is used to remove empty directories.
381
382 config CONFIG_SEQ
383         bool "seq"
384         default n
385         help
386           print a sequence of numbers
387
388 config CONFIG_SHA1SUM
389         bool "sha1sum"
390         default n
391         help
392           Compute and check SHA1 message digest
393
394 config CONFIG_SLEEP
395         bool "sleep (single integer arg with no suffix)"
396         default n
397         help
398           sleep is used to pause for a specified number of seconds,
399
400 config CONFIG_FEATURE_FANCY_SLEEP
401         bool "  Enable multiple integer args and optional time suffixes"
402         default n
403         depends on CONFIG_SLEEP
404         help
405           Allow sleep to pause for specified minutes, hours, and days.
406
407 config CONFIG_SORT
408         bool "sort"
409         default n
410         help
411           sort is used to sort lines of text in specified files.
412
413 config CONFIG_SORT_BIG
414         bool "  full SuSv3 compliant sort (Support -ktcsbdfiozgM)"
415         default y
416         depends on CONFIG_SORT
417         help
418           Without this, sort only supports  -r, -u, and an integer version
419           of -n.  Selecting this adds sort keys, floating point support, and
420           more.  This adds a little over 3k to a nonstatic build on x86.
421
422           The SuSv3 sort standard is available at:
423           http://www.opengroup.org/onlinepubs/007904975/utilities/sort.html
424
425 config CONFIG_STAT
426         bool "stat"
427         default n
428         help
429           display file or filesystem status.
430
431 config CONFIG_FEATURE_STAT_FORMAT
432         bool "  Enable custom formats (-c)"
433         default n
434         depends on CONFIG_STAT
435         help
436           Without this, stat will not support the '-c format' option where 
437           users can pass a custom format string for output.  This adds about 
438           7k to a nonstatic build on amd64.
439
440 config CONFIG_STTY
441         bool "stty"
442         default n
443         help
444           stty is used to change and print terminal line settings.
445
446 config CONFIG_SUM
447         bool "sum"
448         default n
449         help
450           checksum and count the blocks in a file
451
452 config CONFIG_SYNC
453         bool "sync"
454         default n
455         help
456           sync is used to flush filesystem buffers.
457
458 config CONFIG_TAIL
459         bool "tail"
460         default n
461         help
462           tail is used to print the last specified number of lines
463           from files.
464
465 config CONFIG_FEATURE_FANCY_TAIL
466         bool "  Enable extra tail options (-q, -s, and -v)"
467         default y
468         depends on CONFIG_TAIL
469         help
470           The options (-q, -s, and -v) are provided by GNU tail, but
471           are not specific in the SUSv3 standard.
472
473 config CONFIG_TEE
474         bool "tee"
475         default n
476         help
477           tee is used to read from standard input and write
478           to standard output and files.
479
480 config CONFIG_FEATURE_TEE_USE_BLOCK_IO
481         bool "  Enable block i/o (larger/faster) instead of byte i/o."
482         default n
483         depends on CONFIG_TEE
484         help
485           Enable this option for a faster tee, at expense of size.
486
487 if CONFIG_ASH || CONFIG_HUSH || CONFIG_LASH || CONFIG_MSH
488         config CONFIG_TEST
489                 default y
490         comment "test (forced enabled for use with shell)"
491 endif
492
493 if !CONFIG_ASH && !CONFIG_HUSH && !CONFIG_LASH && !CONFIG_MSH
494     config CONFIG_TEST
495             bool "test"
496             default n
497             help
498               test is used to check file types and compare values,
499               returning an appropriate exit code. The shells (ash
500               and bash) have test builtin.
501 endif
502
503 config CONFIG_FEATURE_TEST_64
504         bool "  Extend test to 64 bit"
505         default n
506         depends on CONFIG_TEST
507         help
508           Enable 64-bit support in test.
509
510 config CONFIG_TOUCH
511         bool "touch"
512         default n
513         help
514           touch is used to create or change the access and/or
515           modification timestamp of specified files.
516
517 config CONFIG_TR
518         bool "tr"
519         default n
520         help
521           tr is used to squeeze, and/or delete characters from standard
522           input, writing to standard output.
523
524 if CONFIG_HUSH || CONFIG_LASH || CONFIG_MSH
525         config CONFIG_TRUE
526                 default y
527         comment "true (forced enabled for use with shell)"
528 endif
529
530 if !CONFIG_HUSH && !CONFIG_LASH && !CONFIG_MSH
531     config CONFIG_TRUE
532             bool "true"
533             default n
534             help
535               true returns an exit code of TRUE (0).
536
537 endif
538
539 config CONFIG_TTY
540         bool "tty"
541         default n
542         help
543           tty is used to print the name of the current terminal to
544           standard output.
545
546 config CONFIG_UNAME
547         bool "uname"
548         default n
549         help
550           uname is used to print system information.
551
552 config CONFIG_UNIQ
553         bool "uniq"
554         default n
555         help
556           uniq is used to remove duplicate lines from a sorted file.
557
558 config CONFIG_USLEEP
559         bool "usleep"
560         default n
561         help
562           usleep is used to pause for a specified number of microseconds.
563
564 config CONFIG_UUDECODE
565         bool "uudecode"
566         default n
567         help
568           uudecode is used to decode a uuencoded file.
569
570 config CONFIG_UUENCODE
571         bool "uuencode"
572         default n
573         help
574           uuencode is used to uuencode a file.
575
576 config CONFIG_WATCH
577         bool "watch"
578         default n
579         help
580           watch is used to execute a program periodically, showing
581           output to the screen.
582
583 config CONFIG_WC
584         bool "wc"
585         default n
586         help
587           wc is used to print the number of bytes, words, and lines,
588           in specified files.
589
590 config CONFIG_WHO
591         bool "who"
592         default n
593         select CONFIG_FEATURE_U_W_TMP
594         help
595           who is used to show who is logged on.
596
597 config CONFIG_WHOAMI
598         bool "whoami"
599         default n
600         help
601           whoami is used to print the username of the current
602           user id (same as id -un).
603
604 config CONFIG_YES
605         bool "yes"
606         default n
607         help
608           yes is used to repeatedly output a specific string, or
609           the default string `y'.
610
611 comment "Common options for cp and mv"
612     depends on CONFIG_CP || CONFIG_MV
613
614 config CONFIG_FEATURE_PRESERVE_HARDLINKS
615         bool "  Preserve hard links"
616         default n
617         depends on CONFIG_CP || CONFIG_MV
618         help
619           Allow cp and mv to preserve hard links.
620
621 comment "Common options for ls and more"
622         depends on CONFIG_LS || CONFIG_MORE
623
624 config CONFIG_FEATURE_AUTOWIDTH
625         bool "  Calculate terminal & column widths"
626         default y
627         depends on CONFIG_LS || CONFIG_MORE
628         help
629           This option allows utilities such as 'ls' and 'more' to determine the
630           width of the screen, which can allow them to display additional text
631           or avoid wrapping text onto the next line.  If you leave this
632           disabled, your utilities will be especially primitive and will be
633           unable to determine the current screen width.
634
635 comment "Common options for df, du, ls"
636     depends on CONFIG_DF || CONFIG_DU || CONFIG_LS
637
638 config CONFIG_FEATURE_HUMAN_READABLE
639         bool "  Support for human readable output (example 13k, 23M, 235G)"
640         default n
641         depends on CONFIG_DF || CONFIG_DU || CONFIG_LS
642         help
643           Allow df, du, and ls to have human readable output.
644
645 comment "Common options for md5sum, sha1sum"
646     depends on CONFIG_MD5SUM || CONFIG_SHA1SUM
647
648 config CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
649         bool "  Enable -c, -s and -w options"
650         default n
651         depends on CONFIG_MD5SUM || CONFIG_SHA1SUM
652         help
653           Enabling the -c options allows files to be checked
654           against pre-calculated hash values.
655
656           -s and -w are useful options when verifying checksums.
657
658 endmenu