02155d22016611f4a665f11a88a30e1b7a982e27
[oweals/busybox.git] / coreutils / 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 "Coreutils"
7
8 INSERT
9
10 config CAL
11         bool "cal"
12         default y
13         help
14           cal is used to display a monthly calendar.
15
16 config CATV
17         bool "catv"
18         default y
19         help
20           Display nonprinting characters as escape sequences (like some
21           implementations' cat -v option).
22
23 config CHGRP
24         bool "chgrp"
25         default y
26         help
27           chgrp is used to change the group ownership of files.
28
29 config CHMOD
30         bool "chmod"
31         default y
32         help
33           chmod is used to change the access permission of files.
34
35 config CHOWN
36         bool "chown"
37         default y
38         help
39           chown is used to change the user and/or group ownership
40           of files.
41
42 config FEATURE_CHOWN_LONG_OPTIONS
43         bool "Enable long options"
44         default y
45         depends on CHOWN && LONG_OPTS
46         help
47           Enable use of long options
48
49 config CHROOT
50         bool "chroot"
51         default y
52         help
53           chroot is used to change the root directory and run a command.
54           The default command is `/bin/sh'.
55
56 config CKSUM
57         bool "cksum"
58         default y
59         help
60           cksum is used to calculate the CRC32 checksum of a file.
61
62 config COMM
63         bool "comm"
64         default y
65         help
66           comm is used to compare two files line by line and return
67           a three-column output.
68
69 config CP
70         bool "cp"
71         default y
72         help
73           cp is used to copy files and directories.
74
75 config FEATURE_CP_LONG_OPTIONS
76         bool "Enable long options for cp"
77         default y
78         depends on CP && LONG_OPTS
79         help
80           Enable long options for cp.
81           Also add support for --parents option.
82
83 config CUT
84         bool "cut"
85         default y
86         help
87           cut is used to print selected parts of lines from
88           each file to stdout.
89
90 config DF
91         bool "df"
92         default y
93         help
94           df reports the amount of disk space used and available
95           on filesystems.
96
97 config FEATURE_DF_FANCY
98         bool "Enable -a, -i, -B"
99         default y
100         depends on DF
101         help
102           This option enables -a, -i and -B.
103
104             -a Show all filesystems
105             -i Inodes
106             -B <SIZE> Blocksize
107
108 config DIRNAME
109         bool "dirname"
110         default y
111         help
112           dirname is used to strip a non-directory suffix from
113           a file name.
114
115 config DOS2UNIX
116         bool "dos2unix/unix2dos"
117         default y
118         help
119           dos2unix is used to convert a text file from DOS format to
120           UNIX format, and vice versa.
121
122 config UNIX2DOS
123         bool
124         default y
125         depends on DOS2UNIX
126         help
127           unix2dos is used to convert a text file from UNIX format to
128           DOS format, and vice versa.
129
130 config DU
131         bool "du (default blocksize of 512 bytes)"
132         default y
133         help
134           du is used to report the amount of disk space used
135           for specified files.
136
137 config FEATURE_DU_DEFAULT_BLOCKSIZE_1K
138         bool "Use a default blocksize of 1024 bytes (1K)"
139         default y
140         depends on DU
141         help
142           Use a blocksize of (1K) instead of the default 512b.
143
144 config ECHO
145         bool "echo (basic SuSv3 version taking no options)"
146         default y
147         help
148           echo is used to print a specified string to stdout.
149
150 # this entry also appears in shell/Config.in, next to the echo builtin
151 config FEATURE_FANCY_ECHO
152         bool "Enable echo options (-n and -e)"
153         default y
154         depends on ECHO || ASH_BUILTIN_ECHO || HUSH
155         help
156           This adds options (-n and -e) to echo.
157
158 config ENV
159         bool "env"
160         default y
161         help
162           env is used to set an environment variable and run
163           a command; without options it displays the current
164           environment.
165
166 config FEATURE_ENV_LONG_OPTIONS
167         bool "Enable long options"
168         default y
169         depends on ENV && LONG_OPTS
170         help
171           Support long options for the env applet.
172
173 config EXPAND
174         bool "expand"
175         default y
176         help
177           By default, convert all tabs to spaces.
178
179 config FEATURE_EXPAND_LONG_OPTIONS
180         bool "Enable long options"
181         default y
182         depends on EXPAND && LONG_OPTS
183         help
184           Support long options for the expand applet.
185
186 config EXPR
187         bool "expr"
188         default y
189         help
190           expr is used to calculate numbers and print the result
191           to standard output.
192
193 config EXPR_MATH_SUPPORT_64
194         bool "Extend Posix numbers support to 64 bit"
195         default y
196         depends on EXPR
197         help
198           Enable 64-bit math support in the expr applet. This will make
199           the applet slightly larger, but will allow computation with very
200           large numbers.
201
202 config FALSE
203         bool "false"
204         default y
205         help
206           false returns an exit code of FALSE (1).
207
208 config FOLD
209         bool "fold"
210         default y
211         help
212           Wrap text to fit a specific width.
213
214 config FSYNC
215         bool "fsync"
216         default y
217         help
218           fsync is used to flush file-related cached blocks to disk.
219
220 config HEAD
221         bool "head"
222         default y
223         help
224           head is used to print the first specified number of lines
225           from files.
226
227 config FEATURE_FANCY_HEAD
228         bool "Enable head options (-c, -q, and -v)"
229         default y
230         depends on HEAD
231         help
232           This enables the head options (-c, -q, and -v).
233
234 config INSTALL
235         bool "install"
236         default y
237         help
238           Copy files and set attributes.
239
240 config FEATURE_INSTALL_LONG_OPTIONS
241         bool "Enable long options"
242         default y
243         depends on INSTALL && LONG_OPTS
244         help
245           Support long options for the install applet.
246
247 ####config LENGTH
248 ####    bool "length"
249 ####    default y
250 ####    help
251 ####      length is used to print out the length of a specified string.
252
253 config LN
254         bool "ln"
255         default y
256         help
257           ln is used to create hard or soft links between files.
258
259 config LOGNAME
260         bool "logname"
261         default y
262         help
263           logname is used to print the current user's login name.
264
265 config LS
266         bool "ls"
267         default y
268         help
269           ls is used to list the contents of directories.
270
271 config FEATURE_LS_FILETYPES
272         bool "Enable filetyping options (-p and -F)"
273         default y
274         depends on LS
275         help
276           Enable the ls options (-p and -F).
277
278 config FEATURE_LS_FOLLOWLINKS
279         bool "Enable symlinks dereferencing (-L)"
280         default y
281         depends on LS
282         help
283           Enable the ls option (-L).
284
285 config FEATURE_LS_RECURSIVE
286         bool "Enable recursion (-R)"
287         default y
288         depends on LS
289         help
290           Enable the ls option (-R).
291
292 config FEATURE_LS_SORTFILES
293         bool "Sort the file names"
294         default y
295         depends on LS
296         help
297           Allow ls to sort file names alphabetically.
298
299 config FEATURE_LS_TIMESTAMPS
300         bool "Show file timestamps"
301         default y
302         depends on LS
303         help
304           Allow ls to display timestamps for files.
305
306 config FEATURE_LS_USERNAME
307         bool "Show username/groupnames"
308         default y
309         depends on LS
310         help
311           Allow ls to display username/groupname for files.
312
313 config FEATURE_LS_COLOR
314         bool "Allow use of color to identify file types"
315         default y
316         depends on LS && LONG_OPTS
317         help
318           This enables the --color option to ls.
319
320 config FEATURE_LS_COLOR_IS_DEFAULT
321         bool "Produce colored ls output by default"
322         default y
323         depends on FEATURE_LS_COLOR
324         help
325           Saying yes here will turn coloring on by default,
326           even if no "--color" option is given to the ls command.
327           This is not recommended, since the colors are not
328           configurable, and the output may not be legible on
329           many output screens.
330
331 config MD5SUM
332         bool "md5sum"
333         default y
334         help
335           md5sum is used to print or check MD5 checksums.
336
337 config MKDIR
338         bool "mkdir"
339         default y
340         help
341           mkdir is used to create directories with the specified names.
342
343 config FEATURE_MKDIR_LONG_OPTIONS
344         bool "Enable long options"
345         default y
346         depends on MKDIR && LONG_OPTS
347         help
348           Support long options for the mkdir applet.
349
350 config MKFIFO
351         bool "mkfifo"
352         default y
353         help
354           mkfifo is used to create FIFOs (named pipes).
355           The `mknod' program can also create FIFOs.
356
357 config MKNOD
358         bool "mknod"
359         default y
360         help
361           mknod is used to create FIFOs or block/character special
362           files with the specified names.
363
364 config MV
365         bool "mv"
366         default y
367         help
368           mv is used to move or rename files or directories.
369
370 config FEATURE_MV_LONG_OPTIONS
371         bool "Enable long options"
372         default y
373         depends on MV && LONG_OPTS
374         help
375           Support long options for the mv applet.
376
377 config NICE
378         bool "nice"
379         default y
380         help
381           nice runs a program with modified scheduling priority.
382
383 config NOHUP
384         bool "nohup"
385         default y
386         help
387           run a command immune to hangups, with output to a non-tty.
388
389 config OD
390         bool "od"
391         default y
392         help
393           od is used to dump binary files in octal and other formats.
394
395 config PRINTENV
396         bool "printenv"
397         default y
398         help
399           printenv is used to print all or part of environment.
400
401 config PRINTF
402         bool "printf"
403         default y
404         help
405           printf is used to format and print specified strings.
406           It's similar to `echo' except it has more options.
407
408 config PWD
409         bool "pwd"
410         default y
411         help
412           pwd is used to print the current directory.
413
414 config READLINK
415         bool "readlink"
416         default y
417         help
418           This program reads a symbolic link and returns the name
419           of the file it points to
420
421 config FEATURE_READLINK_FOLLOW
422         bool "Enable canonicalization by following all symlinks (-f)"
423         default y
424         depends on READLINK
425         help
426           Enable the readlink option (-f).
427
428 config REALPATH
429         bool "realpath"
430         default y
431         help
432           Return the canonicalized absolute pathname.
433           This isn't provided by GNU shellutils, but where else does it belong.
434
435 config RM
436         bool "rm"
437         default y
438         help
439           rm is used to remove files or directories.
440
441 config RMDIR
442         bool "rmdir"
443         default y
444         help
445           rmdir is used to remove empty directories.
446
447 config FEATURE_RMDIR_LONG_OPTIONS
448         bool "Enable long options"
449         default y
450         depends on RMDIR && LONG_OPTS
451         help
452           Support long options for the rmdir applet, including
453           --ignore-fail-on-non-empty for compatibility with GNU rmdir.
454
455 config SEQ
456         bool "seq"
457         default y
458         help
459           print a sequence of numbers
460
461 config SHA1SUM
462         bool "sha1sum"
463         default y
464         help
465           Compute and check SHA1 message digest
466
467 config SHA256SUM
468         bool "sha256sum"
469         default y
470         help
471           Compute and check SHA256 message digest
472
473 config SHA512SUM
474         bool "sha512sum"
475         default y
476         help
477           Compute and check SHA512 message digest
478
479 config SHA3SUM
480         bool "sha3sum"
481         default y
482         help
483           Compute and check SHA3 (512-bit) message digest
484
485 config SLEEP
486         bool "sleep"
487         default y
488         help
489           sleep is used to pause for a specified number of seconds.
490           It comes in 3 versions:
491           - small: takes one integer parameter
492           - fancy: takes multiple integer arguments with suffixes:
493             sleep 1d 2h 3m 15s
494           - fancy with fractional numbers:
495             sleep 2.3s 4.5h sleeps for 16202.3 seconds
496           Last one is "the most compatible" with coreutils sleep,
497           but it adds around 1k of code.
498
499 config FEATURE_FANCY_SLEEP
500         bool "Enable multiple arguments and s/m/h/d suffixes"
501         default y
502         depends on SLEEP
503         help
504           Allow sleep to pause for specified minutes, hours, and days.
505
506 config FEATURE_FLOAT_SLEEP
507         bool "Enable fractional arguments"
508         default y
509         depends on FEATURE_FANCY_SLEEP
510         help
511           Allow for fractional numeric parameters.
512
513 config SORT
514         bool "sort"
515         default y
516         help
517           sort is used to sort lines of text in specified files.
518
519 config FEATURE_SORT_BIG
520         bool "Full SuSv3 compliant sort (support -ktcsbdfiozgM)"
521         default y
522         depends on SORT
523         help
524           Without this, sort only supports -r, -u, and an integer version
525           of -n. Selecting this adds sort keys, floating point support, and
526           more. This adds a little over 3k to a nonstatic build on x86.
527
528           The SuSv3 sort standard is available at:
529           http://www.opengroup.org/onlinepubs/007904975/utilities/sort.html
530
531 config SPLIT
532         bool "split"
533         default y
534         help
535           split a file into pieces.
536
537 config FEATURE_SPLIT_FANCY
538         bool "Fancy extensions"
539         default y
540         depends on SPLIT
541         help
542           Add support for features not required by SUSv3.
543           Supports additional suffixes 'b' for 512 bytes,
544           'g' for 1GiB for the -b option.
545
546 config STAT
547         bool "stat"
548         default y
549         select PLATFORM_LINUX # statfs()
550         help
551           display file or filesystem status.
552
553 config FEATURE_STAT_FORMAT
554         bool "Enable custom formats (-c)"
555         default y
556         depends on STAT
557         help
558           Without this, stat will not support the '-c format' option where
559           users can pass a custom format string for output. This adds about
560           7k to a nonstatic build on amd64.
561
562 config STTY
563         bool "stty"
564         default y
565         help
566           stty is used to change and print terminal line settings.
567
568 config SUM
569         bool "sum"
570         default y
571         help
572           checksum and count the blocks in a file
573
574 config TAC
575         bool "tac"
576         default y
577         help
578           tac is used to concatenate and print files in reverse.
579
580 config TAIL
581         bool "tail"
582         default y
583         help
584           tail is used to print the last specified number of lines
585           from files.
586
587 config FEATURE_FANCY_TAIL
588         bool "Enable extra tail options (-q, -s, -v, and -F)"
589         default y
590         depends on TAIL
591         help
592           The options (-q, -s, -v and -F) are provided by GNU tail, but
593           are not specific in the SUSv3 standard.
594
595             -q      Never output headers giving file names
596             -s SEC  Wait SEC seconds between reads with -f
597             -v      Always output headers giving file names
598             -F      Same as -f, but keep retrying
599
600 config TEE
601         bool "tee"
602         default y
603         help
604           tee is used to read from standard input and write
605           to standard output and files.
606
607 config FEATURE_TEE_USE_BLOCK_IO
608         bool "Enable block I/O (larger/faster) instead of byte I/O"
609         default y
610         depends on TEE
611         help
612           Enable this option for a faster tee, at expense of size.
613
614 config TRUE
615         bool "true"
616         default y
617         help
618           true returns an exit code of TRUE (0).
619
620 config TTY
621         bool "tty"
622         default y
623         help
624           tty is used to print the name of the current terminal to
625           standard output.
626
627 config UNAME
628         bool "uname"
629         default y
630         help
631           uname is used to print system information.
632
633 config UNEXPAND
634         bool "unexpand"
635         default y
636         help
637           By default, convert only leading sequences of blanks to tabs.
638
639 config FEATURE_UNEXPAND_LONG_OPTIONS
640         bool "Enable long options"
641         default y
642         depends on UNEXPAND && LONG_OPTS
643         help
644           Support long options for the unexpand applet.
645
646 config UNIQ
647         bool "uniq"
648         default y
649         help
650           uniq is used to remove duplicate lines from a sorted file.
651
652 config USLEEP
653         bool "usleep"
654         default y
655         help
656           usleep is used to pause for a specified number of microseconds.
657
658 config UUDECODE
659         bool "uudecode"
660         default y
661         help
662           uudecode is used to decode a uuencoded file.
663
664 config UUENCODE
665         bool "uuencode"
666         default y
667         help
668           uuencode is used to uuencode a file.
669
670 config WC
671         bool "wc"
672         default y
673         help
674           wc is used to print the number of bytes, words, and lines,
675           in specified files.
676
677 config FEATURE_WC_LARGE
678         bool "Support very large files in wc"
679         default y
680         depends on WC
681         help
682           Use "unsigned long long" in wc for counter variables.
683
684 config WHOAMI
685         bool "whoami"
686         default y
687         help
688           whoami is used to print the username of the current
689           user id (same as id -un).
690
691 config YES
692         bool "yes"
693         default y
694         help
695           yes is used to repeatedly output a specific string, or
696           the default string `y'.
697
698 comment "Common options"
699
700 config FEATURE_VERBOSE
701         bool "Support verbose options (usually -v) for various applets"
702         default y
703         help
704           Enable cp -v, rm -v and similar messages.
705           Also enables long option (--verbose) if it exists.
706           Without this option, -v is accepted but ignored.
707
708 comment "Common options for cp and mv"
709         depends on CP || MV
710
711 config FEATURE_PRESERVE_HARDLINKS
712         bool "Preserve hard links"
713         default y
714         depends on CP || MV
715         help
716           Allow cp and mv to preserve hard links.
717
718 comment "Common options for ls, more and telnet"
719         depends on LS || MORE || TELNET
720
721 config FEATURE_AUTOWIDTH
722         bool "Calculate terminal & column widths"
723         default y
724         depends on LS || MORE || TELNET
725         help
726           This option allows utilities such as 'ls', 'more' and 'telnet'
727           to determine the width of the screen, which can allow them to
728           display additional text or avoid wrapping text onto the next line.
729           If you leave this disabled, your utilities will be especially
730           primitive and will be unable to determine the current screen width.
731
732 comment "Common options for df, du, ls"
733         depends on DF || DU || LS
734
735 config FEATURE_HUMAN_READABLE
736         bool "Support for human readable output (example 13k, 23M, 235G)"
737         default y
738         depends on DF || DU || LS
739         help
740           Allow df, du, and ls to have human readable output.
741
742 comment "Common options for md5sum, sha1sum, sha256sum, sha512sum, sha3sum"
743         depends on MD5SUM || SHA1SUM || SHA256SUM || SHA512SUM || SHA3SUM
744
745 config FEATURE_MD5_SHA1_SUM_CHECK
746         bool "Enable -c, -s and -w options"
747         default y
748         depends on MD5SUM || SHA1SUM || SHA256SUM || SHA512SUM || SHA3SUM
749         help
750           Enabling the -c options allows files to be checked
751           against pre-calculated hash values.
752
753           -s and -w are useful options when verifying checksums.
754
755 endmenu