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