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