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