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