partially migrate coreutils to Config.src and Kbuild.src
[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 n
13         help
14           cal is used to display a monthly calender.
15
16 config CATV
17         bool "catv"
18         default n
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 n
26         help
27           chgrp is used to change the group ownership of files.
28
29 config CHMOD
30         bool "chmod"
31         default n
32         help
33           chmod is used to change the access permission of files.
34
35 config CHOWN
36         bool "chown"
37         default n
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 n
45         depends on CHOWN && LONG_OPTS
46         help
47           Enable use of long options
48
49 config CHROOT
50         bool "chroot"
51         default n
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 n
59         help
60           cksum is used to calculate the CRC32 checksum of a file.
61
62 config COMM
63         bool "comm"
64         default n
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 n
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 n
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 n
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 n
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 n
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 n
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 n
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 n
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 n
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 n
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 n
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 n
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 n
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 n
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 n
214         help
215           By default, convert all tabs to spaces.
216
217 config FEATURE_EXPAND_LONG_OPTIONS
218         bool "Enable long options"
219         default n
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 n
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 n
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 n
243         help
244           false returns an exit code of FALSE (1).
245
246 config FOLD
247         bool "fold"
248         default n
249         help
250           Wrap text to fit a specific width.
251
252 config FSYNC
253         bool "fsync"
254         default n
255         help
256           fsync is used to flush file-related cached blocks to disk.
257
258 config HEAD
259         bool "head"
260         default n
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 n
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 n
275         help
276           hostid prints the numeric identifier (in hexadecimal) for
277           the current host.
278
279 config ID
280         bool "id"
281         default n
282         help
283           id displays the current user and group ID names.
284
285 config INSTALL
286         bool "install"
287         default n
288         help
289           Copy files and set attributes.
290
291 config FEATURE_INSTALL_LONG_OPTIONS
292         bool "Enable long options"
293         default n
294         depends on INSTALL && LONG_OPTS
295         help
296           Support long options for the install applet.
297
298 config LENGTH
299         bool "length"
300         default n
301         help
302           length is used to print out the length of a specified string.
303
304 config LN
305         bool "ln"
306         default n
307         help
308           ln is used to create hard or soft links between files.
309
310 config LOGNAME
311         bool "logname"
312         default n
313         help
314           logname is used to print the current user's login name.
315
316 config LS
317         bool "ls"
318         default n
319         help
320           ls is used to list the contents of directories.
321
322 config FEATURE_LS_FILETYPES
323         bool "Enable filetyping options (-p and -F)"
324         default y
325         depends on LS
326         help
327           Enable the ls options (-p and -F).
328
329 config FEATURE_LS_FOLLOWLINKS
330         bool "Enable symlinks dereferencing (-L)"
331         default y
332         depends on LS
333         help
334           Enable the ls option (-L).
335
336 config FEATURE_LS_RECURSIVE
337         bool "Enable recursion (-R)"
338         default y
339         depends on LS
340         help
341           Enable the ls option (-R).
342
343 config FEATURE_LS_SORTFILES
344         bool "Sort the file names"
345         default y
346         depends on LS
347         help
348           Allow ls to sort file names alphabetically.
349
350 config FEATURE_LS_TIMESTAMPS
351         bool "Show file timestamps"
352         default y
353         depends on LS
354         help
355           Allow ls to display timestamps for files.
356
357 config FEATURE_LS_USERNAME
358         bool "Show username/groupnames"
359         default y
360         depends on LS
361         help
362           Allow ls to display username/groupname for files.
363
364 config FEATURE_LS_COLOR
365         bool "Allow use of color to identify file types"
366         default y
367         depends on LS && LONG_OPTS
368         help
369           This enables the --color option to ls.
370
371 config FEATURE_LS_COLOR_IS_DEFAULT
372         bool "Produce colored ls output by default"
373         default n
374         depends on FEATURE_LS_COLOR
375         help
376           Saying yes here will turn coloring on by default,
377           even if no "--color" option is given to the ls command.
378           This is not recommended, since the colors are not
379           configurable, and the output may not be legible on
380           many output screens.
381
382 config MD5SUM
383         bool "md5sum"
384         default n
385         help
386           md5sum is used to print or check MD5 checksums.
387
388 config MKDIR
389         bool "mkdir"
390         default n
391         help
392           mkdir is used to create directories with the specified names.
393
394 config FEATURE_MKDIR_LONG_OPTIONS
395         bool "Enable long options"
396         default n
397         depends on MKDIR && LONG_OPTS
398         help
399           Support long options for the mkdir applet.
400
401 config MKFIFO
402         bool "mkfifo"
403         default n
404         help
405           mkfifo is used to create FIFOs (named pipes).
406           The `mknod' program can also create FIFOs.
407
408 config MKNOD
409         bool "mknod"
410         default n
411         help
412           mknod is used to create FIFOs or block/character special
413           files with the specified names.
414
415 config MV
416         bool "mv"
417         default n
418         help
419           mv is used to move or rename files or directories.
420
421 config FEATURE_MV_LONG_OPTIONS
422         bool "Enable long options"
423         default n
424         depends on MV && LONG_OPTS
425         help
426           Support long options for the mv applet.
427
428 config NICE
429         bool "nice"
430         default n
431         help
432           nice runs a program with modified scheduling priority.
433
434 config NOHUP
435         bool "nohup"
436         default n
437         help
438           run a command immune to hangups, with output to a non-tty.
439
440 config OD
441         bool "od"
442         default n
443         help
444           od is used to dump binary files in octal and other formats.
445
446 config PRINTENV
447         bool "printenv"
448         default n
449         help
450           printenv is used to print all or part of environment.
451
452 config PRINTF
453         bool "printf"
454         default n
455         help
456           printf is used to format and print specified strings.
457           It's similar to `echo' except it has more options.
458
459 config PWD
460         bool "pwd"
461         default n
462         help
463           pwd is used to print the current directory.
464
465 config READLINK
466         bool "readlink"
467         default n
468         help
469           This program reads a symbolic link and returns the name
470           of the file it points to
471
472 config FEATURE_READLINK_FOLLOW
473         bool "Enable canonicalization by following all symlinks (-f)"
474         default n
475         depends on READLINK
476         help
477           Enable the readlink option (-f).
478
479 config REALPATH
480         bool "realpath"
481         default n
482         help
483           Return the canonicalized absolute pathname.
484           This isn't provided by GNU shellutils, but where else does it belong.
485
486 config RM
487         bool "rm"
488         default n
489         help
490           rm is used to remove files or directories.
491
492 config RMDIR
493         bool "rmdir"
494         default n
495         help
496           rmdir is used to remove empty directories.
497
498 config FEATURE_RMDIR_LONG_OPTIONS
499         bool "Enable long options"
500         default n
501         depends on RMDIR && LONG_OPTS
502         help
503           Support long options for the rmdir applet, including
504           --ignore-fail-on-non-empty for compatibility with GNU rmdir.
505
506 config SEQ
507         bool "seq"
508         default n
509         help
510           print a sequence of numbers
511
512 config SHA1SUM
513         bool "sha1sum"
514         default n
515         help
516           Compute and check SHA1 message digest
517
518 config SHA256SUM
519         bool "sha256sum"
520         default n
521         help
522           Compute and check SHA256 message digest
523
524 config SHA512SUM
525         bool "sha512sum"
526         default n
527         help
528           Compute and check SHA512 message digest
529
530 config SLEEP
531         bool "sleep"
532         default n
533         help
534           sleep is used to pause for a specified number of seconds.
535           It comes in 3 versions:
536           - small: takes one integer parameter
537           - fancy: takes multiple integer arguments with suffixes:
538             sleep 1d 2h 3m 15s
539           - fancy with fractional numbers:
540             sleep 2.3s 4.5h sleeps for 16202.3 seconds
541           Last one is "the most compatible" with coreutils sleep,
542           but it adds around 1k of code.
543
544 config FEATURE_FANCY_SLEEP
545         bool "Enable multiple arguments and s/m/h/d suffixes"
546         default n
547         depends on SLEEP
548         help
549           Allow sleep to pause for specified minutes, hours, and days.
550
551 config FEATURE_FLOAT_SLEEP
552         bool "Enable fractional arguments"
553         default n
554         depends on FEATURE_FANCY_SLEEP
555         help
556           Allow for fractional numeric parameters.
557
558 config SORT
559         bool "sort"
560         default n
561         help
562           sort is used to sort lines of text in specified files.
563
564 config FEATURE_SORT_BIG
565         bool "Full SuSv3 compliant sort (support -ktcsbdfiozgM)"
566         default y
567         depends on SORT
568         help
569           Without this, sort only supports -r, -u, and an integer version
570           of -n. Selecting this adds sort keys, floating point support, and
571           more. This adds a little over 3k to a nonstatic build on x86.
572
573           The SuSv3 sort standard is available at:
574           http://www.opengroup.org/onlinepubs/007904975/utilities/sort.html
575
576 config SPLIT
577         bool "split"
578         default n
579         help
580           split a file into pieces.
581
582 config FEATURE_SPLIT_FANCY
583         bool "Fancy extensions"
584         default n
585         depends on SPLIT
586         help
587           Add support for features not required by SUSv3.
588           Supports additional suffixes 'b' for 512 bytes,
589           'g' for 1GiB for the -b option.
590
591 config STAT
592         bool "stat"
593         default n
594         help
595           display file or filesystem status.
596
597 config FEATURE_STAT_FORMAT
598         bool "Enable custom formats (-c)"
599         default n
600         depends on STAT
601         help
602           Without this, stat will not support the '-c format' option where
603           users can pass a custom format string for output. This adds about
604           7k to a nonstatic build on amd64.
605
606 config STTY
607         bool "stty"
608         default n
609         help
610           stty is used to change and print terminal line settings.
611
612 config SUM
613         bool "sum"
614         default n
615         help
616           checksum and count the blocks in a file
617
618 config SYNC
619         bool "sync"
620         default n
621         help
622           sync is used to flush filesystem buffers.
623
624 config TAC
625         bool "tac"
626         default n
627         help
628           tac is used to concatenate and print files in reverse.
629
630 config TAIL
631         bool "tail"
632         default n
633         help
634           tail is used to print the last specified number of lines
635           from files.
636
637 config FEATURE_FANCY_TAIL
638         bool "Enable extra tail options (-q, -s, -v, and -F)"
639         default y
640         depends on TAIL
641         help
642           The options (-q, -s, and -v) are provided by GNU tail, but
643           are not specific in the SUSv3 standard.
644
645             -q      Never output headers giving file names
646             -s SEC  Wait SEC seconds between reads with -f
647             -v      Always output headers giving file names
648
649 config TEE
650         bool "tee"
651         default n
652         help
653           tee is used to read from standard input and write
654           to standard output and files.
655
656 config FEATURE_TEE_USE_BLOCK_IO
657         bool "Enable block I/O (larger/faster) instead of byte I/O"
658         default n
659         depends on TEE
660         help
661           Enable this option for a faster tee, at expense of size.
662
663 config TOUCH
664         bool "touch"
665         default n
666         help
667           touch is used to create or change the access and/or
668           modification timestamp of specified files.
669
670 config TRUE
671         bool "true"
672         default n
673         help
674           true returns an exit code of TRUE (0).
675
676 config TTY
677         bool "tty"
678         default n
679         help
680           tty is used to print the name of the current terminal to
681           standard output.
682
683 config UNAME
684         bool "uname"
685         default n
686         help
687           uname is used to print system information.
688
689 config UNEXPAND
690         bool "unexpand"
691         default n
692         help
693           By default, convert only leading sequences of blanks to tabs.
694
695 config FEATURE_UNEXPAND_LONG_OPTIONS
696         bool "Enable long options"
697         default n
698         depends on UNEXPAND && LONG_OPTS
699         help
700           Support long options for the unexpand applet.
701
702 config UNIQ
703         bool "uniq"
704         default n
705         help
706           uniq is used to remove duplicate lines from a sorted file.
707
708 config USLEEP
709         bool "usleep"
710         default n
711         help
712           usleep is used to pause for a specified number of microseconds.
713
714 config UUDECODE
715         bool "uudecode"
716         default n
717         help
718           uudecode is used to decode a uuencoded file.
719
720 config UUENCODE
721         bool "uuencode"
722         default n
723         help
724           uuencode is used to uuencode a file.
725
726 config WC
727         bool "wc"
728         default n
729         help
730           wc is used to print the number of bytes, words, and lines,
731           in specified files.
732
733 config FEATURE_WC_LARGE
734         bool "Support very large files in wc"
735         default n
736         depends on WC
737         help
738           Use "unsigned long long" in wc for counter variables.
739
740 config WHO
741         bool "who"
742         default n
743         depends on FEATURE_UTMP
744         help
745           who is used to show who is logged on.
746
747 config WHOAMI
748         bool "whoami"
749         default n
750         help
751           whoami is used to print the username of the current
752           user id (same as id -un).
753
754 config YES
755         bool "yes"
756         default n
757         help
758           yes is used to repeatedly output a specific string, or
759           the default string `y'.
760
761 comment "Common options for cp and mv"
762         depends on CP || MV
763
764 config FEATURE_PRESERVE_HARDLINKS
765         bool "Preserve hard links"
766         default n
767         depends on CP || MV
768         help
769           Allow cp and mv to preserve hard links.
770
771 comment "Common options for ls, more and telnet"
772         depends on LS || MORE || TELNET
773
774 config FEATURE_AUTOWIDTH
775         bool "Calculate terminal & column widths"
776         default y
777         depends on LS || MORE || TELNET
778         help
779           This option allows utilities such as 'ls', 'more' and 'telnet'
780           to determine the width of the screen, which can allow them to
781           display additional text or avoid wrapping text onto the next line.
782           If you leave this disabled, your utilities will be especially
783           primitive and will be unable to determine the current screen width.
784
785 comment "Common options for df, du, ls"
786         depends on DF || DU || LS
787
788 config FEATURE_HUMAN_READABLE
789         bool "Support for human readable output (example 13k, 23M, 235G)"
790         default n
791         depends on DF || DU || LS
792         help
793           Allow df, du, and ls to have human readable output.
794
795 comment "Common options for md5sum, sha1sum, sha256sum, sha512sum"
796         depends on MD5SUM || SHA1SUM || SHA256SUM || SHA512SUM
797
798 config FEATURE_MD5_SHA1_SUM_CHECK
799         bool "Enable -c, -s and -w options"
800         default n
801         depends on MD5SUM || SHA1SUM || SHA256SUM || SHA512SUM
802         help
803           Enabling the -c options allows files to be checked
804           against pre-calculated hash values.
805
806           -s and -w are useful options when verifying checksums.
807
808 endmenu