- add testcase for grep bug (http://busybox.net/bugs/view.php?id=887)
[oweals/busybox.git] / coreutils / 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 config CONFIG_CATV
29         bool "catv"
30         default n
31         help
32           Display nonprinting characters as escape sequences (like some
33           implementations' cat -v option).
34
35 config CONFIG_FEATURE_CAT_ESCAPE
36         bool "support -vetET"
37         depends on CONFIG_CAT
38         default n
39         help
40           Sheer bloat.
41
42 config CONFIG_CHGRP
43         bool "chgrp"
44         default n
45         help
46           chgrp is used to change the group ownership of files.
47
48 config CONFIG_CHMOD
49         bool "chmod"
50         default n
51         help
52           chmod is used to change the access permission of files.
53
54 config CONFIG_CHOWN
55         bool "chown"
56         default n
57         help
58           chown is used to change the user and/or group ownership
59           of files.
60
61 config CONFIG_CHROOT
62         bool "chroot"
63         default n
64         help
65           chroot is used to change the root directory and run a command.
66           The default command is `/bin/sh'.
67
68 config CONFIG_CKSUM
69         bool "cksum"
70         default n
71         help
72           cksum is used to calculate the CRC32 checksum of a file.
73
74 config CONFIG_CMP
75         bool "cmp"
76         default n
77         help
78           cmp is used to compare two files and returns the result
79           to standard output.
80
81 config CONFIG_COMM
82         bool "comm"
83         default n
84         help
85           comm is used to compare two files line by line and return
86           a three-column output.
87
88 config CONFIG_CP
89         bool "cp"
90         default n
91         help
92           cp is used to copy files and directories.
93
94 config CONFIG_CUT
95         bool "cut"
96         default n
97         help
98           cut is used to print selected parts of lines from
99           each file to stdout.
100
101 config CONFIG_DATE
102         bool "date"
103         default n
104         help
105           date is used to set the system date or display the
106           current time in the given format.
107
108 config CONFIG_FEATURE_DATE_ISOFMT
109         bool "Enable ISO date format output (-I)"
110         default y
111         depends on CONFIG_DATE
112         help
113           Enable option (-I) to output an ISO-8601 compliant
114           date/time string.
115
116 config CONFIG_DD
117         bool "dd"
118         default n
119         help
120           dd copies a file (from standard input to standard output,
121           by default) using specific input and output blocksizes,
122           while optionally performing conversions on it.
123
124 config CONFIG_FEATURE_DD_SIGNAL_HANDLING
125         bool "Enable DD signal handling for status reporting"
126         default y
127         depends on CONFIG_DD
128         help
129           sending a SIGUSR1 signal to a running `dd' process makes it 
130           print to standard error the number of records read and written 
131           so far, then to resume copying.
132
133           $ dd if=/dev/zero of=/dev/null& pid=$! $ kill -USR1 $pid; sleep 1; kill $pid 
134           10899206+0 records in 10899206+0 records out
135
136 config CONFIG_FEATURE_DD_IBS_OBS
137         bool "Enable ibs, obs and conv options"
138         default n
139         depends on CONFIG_DD
140         help
141           Enables support for writing a certain number of bytes in and out,
142           at a time, and performing conversions on the data stream.
143
144 config CONFIG_DF
145         bool "df"
146         default n
147         help
148           df reports the amount of disk space used and available
149           on filesystems.
150
151 config CONFIG_DIFF
152         bool "diff"
153         default n
154         help
155           diff compares two files or directories and outputs the
156           differences between them in a form that can be given to
157           the patch command.
158
159 config CONFIG_FEATURE_DIFF_BINARY
160         bool "Enable checks for binary files"
161         default y
162         depends on CONFIG_DIFF
163         help
164           This option enables support for checking for binary files
165           before a comparison is carried out.
166
167 config CONFIG_FEATURE_DIFF_DIR
168         bool "Enable directory support"
169         default y
170         depends on CONFIG_DIFF
171         help
172           This option enables support for directory and subdirectory
173           comparison.
174
175 config CONFIG_FEATURE_DIFF_MINIMAL
176         bool "Enable -d option to find smaller sets of changes"
177         default n
178         depends on CONFIG_DIFF
179         help
180           Enabling this option allows the use of -d to make diff
181           try hard to find the smallest possible set of changes.
182
183 config CONFIG_DIRNAME
184         bool "dirname"
185         default n
186         help
187           dirname is used to strip a non-directory suffix from
188           a file name.
189
190 config CONFIG_DOS2UNIX
191         bool "dos2unix/unix2dos"
192         default n
193         help
194           dos2unix is used to convert a text file from DOS format to
195           UNIX format, and vice versa.
196
197 config CONFIG_UNIX2DOS
198         bool
199         default y
200         depends on CONFIG_DOS2UNIX
201         help
202           unix2dos is used to convert a text file from UNIX format to
203           DOS format, and vice versa.
204
205 config CONFIG_DU
206         bool "du (default blocksize of 512 bytes)"
207         default n
208         help
209           du is used to report the amount of disk space used
210           for specified files.
211
212 config CONFIG_FEATURE_DU_DEFAULT_BLOCKSIZE_1K
213         bool "Use a default blocksize of 1024 bytes (1K)"
214         default y
215         depends on CONFIG_DU
216         help
217           Use a blocksize of (1K) instead of the default 512b.
218
219 config CONFIG_ECHO
220         bool "echo (basic SuSv3 version taking no options)"
221         default n
222         help
223           echo is used to print a specified string to stdout.
224
225 # this entry also appears in shell/Config.in, next to the echo builtin
226 config CONFIG_FEATURE_FANCY_ECHO
227         bool "Enable echo options (-n and -e)"
228         default y
229         depends on CONFIG_ECHO
230         help
231           This adds options (-n and -e) to echo.
232
233 config CONFIG_ENV
234         bool "env"
235         default n
236         help
237           env is used to set an environment variable and run
238           a command; without options it displays the current
239           environment.
240
241 config CONFIG_FEATURE_ENV_LONG_OPTIONS
242         bool "Enable long options"
243         default n
244         depends on CONFIG_ENV && CONFIG_GETOPT_LONG
245         help
246           Support long options for the env applet.
247
248 config CONFIG_EXPR
249         bool "expr"
250         default n
251         help
252           expr is used to calculate numbers and print the result
253           to standard output.
254
255 config CONFIG_EXPR_MATH_SUPPORT_64
256         bool "Extend Posix numbers support to 64 bit"
257         default n
258         depends on CONFIG_EXPR
259         help
260           Enable 64-bit math support in the expr applet.  This will make
261           the applet slightly larger, but will allow computation with very
262           large numbers.
263
264 config CONFIG_FALSE
265         bool "false"
266         default n
267         help
268           false returns an exit code of FALSE (1).
269
270 config CONFIG_FOLD
271         bool "fold"
272         default n
273         help
274           Wrap text to fit a specific width.
275
276 config CONFIG_HEAD
277         bool "head"
278         default n
279         help
280           head is used to print the first specified number of lines
281           from files.
282
283 config CONFIG_FEATURE_FANCY_HEAD
284         bool "Enable head options (-c, -q, and -v)"
285         default n
286         depends on CONFIG_HEAD
287         help
288           This enables the head options (-c, -q, and -v).
289
290 config CONFIG_HOSTID
291         bool "hostid"
292         default n
293         help
294           hostid prints the numeric identifier (in hexadecimal) for
295           the current host.
296
297 config CONFIG_ID
298         bool "id"
299         default n
300         help
301           id displays the current user and group ID names.
302
303 config CONFIG_INSTALL
304         bool "install"
305         default n
306         help
307           Copy files and set attributes.
308
309 config CONFIG_FEATURE_INSTALL_LONG_OPTIONS
310         bool "Enable long options"
311         default n
312         depends on CONFIG_INSTALL && CONFIG_GETOPT_LONG
313         help
314           Support long options for the install applet.
315
316 config CONFIG_LENGTH
317         bool "length"
318         default n
319         help
320           length is used to print out the length of a specified string.
321
322 config CONFIG_LN
323         bool "ln"
324         default n
325         help
326           ln is used to create hard or soft links between files.
327
328 config CONFIG_LOGNAME
329         bool "logname"
330         default n
331         help
332           logname is used to print the current user's login name.
333
334 config CONFIG_LS
335         bool "ls"
336         default n
337         help
338           ls is used to list the contents of directories.
339
340 config CONFIG_FEATURE_LS_FILETYPES
341         bool "Enable filetyping options (-p and -F)"
342         default y
343         depends on CONFIG_LS
344         help
345           Enable the ls options (-p and -F).
346
347 config CONFIG_FEATURE_LS_FOLLOWLINKS
348         bool "Enable symlinks dereferencing (-L)"
349         default y
350         depends on CONFIG_LS
351         help
352           Enable the ls option (-L).
353
354 config CONFIG_FEATURE_LS_RECURSIVE
355         bool "Enable recursion (-R)"
356         default y
357         depends on CONFIG_LS
358         help
359           Enable the ls option (-R).
360
361 config CONFIG_FEATURE_LS_SORTFILES
362         bool "Sort the file names"
363         default y
364         depends on CONFIG_LS
365         help
366           Allow ls to sort file names alphabetically.
367
368 config CONFIG_FEATURE_LS_TIMESTAMPS
369         bool "Show file timestamps"
370         default y
371         depends on CONFIG_LS
372         help
373           Allow ls to display timestamps for files.
374
375 config CONFIG_FEATURE_LS_USERNAME
376         bool "Show username/groupnames"
377         default y
378         depends on CONFIG_LS
379         help
380           Allow ls to display username/groupname for files.
381
382 config CONFIG_FEATURE_LS_COLOR
383         bool "Allow use of color to identify file types"
384         default y
385         depends on CONFIG_LS && CONFIG_GETOPT_LONG
386         help
387           This enables the --color option to ls.
388
389 config CONFIG_FEATURE_LS_COLOR_IS_DEFAULT
390         bool "Produce colored ls output by default"
391         default n
392         depends on CONFIG_FEATURE_LS_COLOR
393         help
394           Saying yes here will turn coloring on by default,
395           even if no "--color" option is given to the ls command.
396           This is not recommended, since the colors are not
397           configurable, and the output may not be legible on
398           many output screens.
399
400 config CONFIG_MD5SUM
401         bool "md5sum"
402         default n
403         help
404           md5sum is used to print or check MD5 checksums.
405
406 config CONFIG_MKDIR
407         bool "mkdir"
408         default n
409         help
410           mkdir is used to create directories with the specified names.
411
412 config CONFIG_FEATURE_MKDIR_LONG_OPTIONS
413         bool "Enable long options"
414         default n
415         depends on CONFIG_MKDIR && CONFIG_GETOPT_LONG
416         help
417           Support long options for the mkdir applet.
418
419 config CONFIG_MKFIFO
420         bool "mkfifo"
421         default n
422         help
423           mkfifo is used to create FIFOs (named pipes).
424           The `mknod' program can also create FIFOs.
425
426 config CONFIG_MKNOD
427         bool "mknod"
428         default n
429         help
430           mknod is used to create FIFOs or block/character special
431           files with the specified names.
432
433 config CONFIG_MV
434         bool "mv"
435         default n
436         help
437           mv is used to move or rename files or directories.
438
439 config CONFIG_FEATURE_MV_LONG_OPTIONS
440         bool "Enable long options"
441         default n
442         depends on CONFIG_MV && CONFIG_GETOPT_LONG
443         help
444           Support long options for the mv applet.
445
446 config CONFIG_NICE
447         bool "nice"
448         default n
449         help
450           nice runs a program with modified scheduling priority.
451
452 config CONFIG_NOHUP
453         bool "nohup"
454         default n
455         help
456           run a command immune to hangups, with output to a non-tty.
457
458 config CONFIG_OD
459         bool "od"
460         default n
461         help
462           od is used to dump binary files in octal and other formats.
463
464 config CONFIG_PRINTENV
465         bool "printenv"
466         default n
467         help
468           printenv is used to print all or part of environment.
469
470 config CONFIG_PRINTF
471         bool "printf"
472         default n
473         help
474           printf is used to format and print specified strings.
475           It's similar to `echo' except it has more options.
476
477 config CONFIG_PWD
478         bool "pwd"
479         default n
480         help
481           pwd is used to print the current directory.
482
483 config CONFIG_REALPATH
484         bool "realpath"
485         default n
486         help
487           Return the canonicalized absolute pathname.
488           This isn't provided by GNU shellutils, but where else does it belong.
489
490 config CONFIG_RM
491         bool "rm"
492         default n
493         help
494           rm is used to remove files or directories.
495
496 config CONFIG_RMDIR
497         bool "rmdir"
498         default n
499         help
500           rmdir is used to remove empty directories.
501
502 config CONFIG_SEQ
503         bool "seq"
504         default n
505         help
506           print a sequence of numbers
507
508 config CONFIG_SHA1SUM
509         bool "sha1sum"
510         default n
511         help
512           Compute and check SHA1 message digest
513
514 config CONFIG_SLEEP
515         bool "sleep (single integer arg with no suffix)"
516         default n
517         help
518           sleep is used to pause for a specified number of seconds,
519
520 config CONFIG_FEATURE_FANCY_SLEEP
521         bool "Enable multiple integer args and optional time suffixes"
522         default n
523         depends on CONFIG_SLEEP
524         help
525           Allow sleep to pause for specified minutes, hours, and days.
526
527 config CONFIG_SORT
528         bool "sort"
529         default n
530         help
531           sort is used to sort lines of text in specified files.
532
533 config CONFIG_FEATURE_SORT_BIG
534         bool "full SuSv3 compliant sort (Support -ktcsbdfiozgM)"
535         default y
536         depends on CONFIG_SORT
537         help
538           Without this, sort only supports  -r, -u, and an integer version
539           of -n.  Selecting this adds sort keys, floating point support, and
540           more.  This adds a little over 3k to a nonstatic build on x86.
541
542           The SuSv3 sort standard is available at:
543           http://www.opengroup.org/onlinepubs/007904975/utilities/sort.html
544
545 config CONFIG_STAT
546         bool "stat"
547         default n
548         help
549           display file or filesystem status.
550
551 config CONFIG_FEATURE_STAT_FORMAT
552         bool "Enable custom formats (-c)"
553         default n
554         depends on CONFIG_STAT
555         help
556           Without this, stat will not support the '-c format' option where
557           users can pass a custom format string for output.  This adds about
558           7k to a nonstatic build on amd64.
559
560 config CONFIG_STTY
561         bool "stty"
562         default n
563         help
564           stty is used to change and print terminal line settings.
565
566 config CONFIG_SUM
567         bool "sum"
568         default n
569         help
570           checksum and count the blocks in a file
571
572 config CONFIG_SYNC
573         bool "sync"
574         default n
575         help
576           sync is used to flush filesystem buffers.
577
578 config CONFIG_TAIL
579         bool "tail"
580         default n
581         help
582           tail is used to print the last specified number of lines
583           from files.
584
585 config CONFIG_FEATURE_FANCY_TAIL
586         bool "Enable extra tail options (-q, -s, and -v)"
587         default y
588         depends on CONFIG_TAIL
589         help
590           The options (-q, -s, and -v) are provided by GNU tail, but
591           are not specific in the SUSv3 standard.
592
593 config CONFIG_TEE
594         bool "tee"
595         default n
596         help
597           tee is used to read from standard input and write
598           to standard output and files.
599
600 config CONFIG_FEATURE_TEE_USE_BLOCK_IO
601         bool "Enable block i/o (larger/faster) instead of byte i/o."
602         default n
603         depends on CONFIG_TEE
604         help
605           Enable this option for a faster tee, at expense of size.
606
607 config CONFIG_TEST
608         bool "test"
609         default n
610         help
611           test is used to check file types and compare values,
612           returning an appropriate exit code. The shells (ash
613           and bash) have test builtin.
614
615 config CONFIG_FEATURE_TEST_64
616         bool "Extend test to 64 bit"
617         default n
618         depends on CONFIG_TEST
619         help
620           Enable 64-bit support in test.
621
622 config CONFIG_TOUCH
623         bool "touch"
624         default n
625         help
626           touch is used to create or change the access and/or
627           modification timestamp of specified files.
628
629 config CONFIG_TR
630         bool "tr"
631         default n
632         help
633           tr is used to squeeze, and/or delete characters from standard
634           input, writing to standard output.
635
636 config CONFIG_FEATURE_TR_CLASSES
637         bool "Enable character classes (such as [:upper:])"
638         default n
639         depends on CONFIG_TR
640         help
641           Enable character classes, enabling commands such as:
642           tr [:upper:] [:lower:] to convert input into lowercase.
643
644 config CONFIG_FEATURE_TR_EQUIV
645         bool "Enable equivalence classes"
646         default n
647         depends on CONFIG_TR
648         help
649           Enable equivalence classes, which essentially add the enclosed
650           character to the current set. For instance, tr [=a=] xyz would
651           replace all instances of 'a' with 'xyz'. This option is mainly
652           useful for cases when no other way of expressing a character
653           is possible.
654
655 config CONFIG_TRUE
656         bool "true"
657         default n
658         help
659           true returns an exit code of TRUE (0).
660
661 config CONFIG_TTY
662         bool "tty"
663         default n
664         help
665           tty is used to print the name of the current terminal to
666           standard output.
667
668 config CONFIG_UNAME
669         bool "uname"
670         default n
671         help
672           uname is used to print system information.
673
674 config CONFIG_UNIQ
675         bool "uniq"
676         default n
677         help
678           uniq is used to remove duplicate lines from a sorted file.
679
680 config CONFIG_USLEEP
681         bool "usleep"
682         default n
683         help
684           usleep is used to pause for a specified number of microseconds.
685
686 config CONFIG_UUDECODE
687         bool "uudecode"
688         default n
689         help
690           uudecode is used to decode a uuencoded file.
691
692 config CONFIG_UUENCODE
693         bool "uuencode"
694         default n
695         help
696           uuencode is used to uuencode a file.
697
698 config CONFIG_WATCH
699         bool "watch"
700         default n
701         select CONFIG_DATE
702         help
703           watch is used to execute a program periodically, showing
704           output to the screen.
705
706 config CONFIG_WC
707         bool "wc"
708         default n
709         help
710           wc is used to print the number of bytes, words, and lines,
711           in specified files.
712
713 config CONFIG_WHO
714         bool "who"
715         default n
716         select CONFIG_FEATURE_UTMP
717         help
718           who is used to show who is logged on.
719
720 config CONFIG_WHOAMI
721         bool "whoami"
722         default n
723         help
724           whoami is used to print the username of the current
725           user id (same as id -un).
726
727 config CONFIG_YES
728         bool "yes"
729         default n
730         help
731           yes is used to repeatedly output a specific string, or
732           the default string `y'.
733
734 comment "Common options for cp and mv"
735         depends on CONFIG_CP || CONFIG_MV
736
737 config CONFIG_FEATURE_PRESERVE_HARDLINKS
738         bool "Preserve hard links"
739         default n
740         depends on CONFIG_CP || CONFIG_MV
741         help
742           Allow cp and mv to preserve hard links.
743
744 comment "Common options for ls, more and telnet"
745         depends on CONFIG_LS || CONFIG_MORE || CONFIG_TELNET
746
747 config CONFIG_FEATURE_AUTOWIDTH
748         bool "Calculate terminal & column widths"
749         default y
750         depends on CONFIG_LS || CONFIG_MORE || CONFIG_TELNET
751         help
752           This option allows utilities such as 'ls', 'more' and 'telnet'
753           to determine the width of the screen, which can allow them to 
754           display additional text or avoid wrapping text onto the next line.
755           If you leave this disabled, your utilities will be especially 
756           primitive and will be unable to determine the current screen width.
757
758 comment "Common options for df, du, ls"
759         depends on CONFIG_DF || CONFIG_DU || CONFIG_LS
760
761 config CONFIG_FEATURE_HUMAN_READABLE
762         bool "Support for human readable output (example 13k, 23M, 235G)"
763         default n
764         depends on CONFIG_DF || CONFIG_DU || CONFIG_LS
765         help
766           Allow df, du, and ls to have human readable output.
767
768 comment "Common options for md5sum, sha1sum"
769         depends on CONFIG_MD5SUM || CONFIG_SHA1SUM
770
771 config CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
772         bool "Enable -c, -s and -w options"
773         default n
774         depends on CONFIG_MD5SUM || CONFIG_SHA1SUM
775         help
776           Enabling the -c options allows files to be checked
777           against pre-calculated hash values.
778
779           -s and -w are useful options when verifying checksums.
780
781 endmenu