trylink: automatically use custom link script if user provides one
[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 DIRNAME
139         bool "dirname"
140         default n
141         help
142           dirname is used to strip a non-directory suffix from
143           a file name.
144
145 config DOS2UNIX
146         bool "dos2unix/unix2dos"
147         default n
148         help
149           dos2unix is used to convert a text file from DOS format to
150           UNIX format, and vice versa.
151
152 config UNIX2DOS
153         bool
154         default y
155         depends on DOS2UNIX
156         help
157           unix2dos is used to convert a text file from UNIX format to
158           DOS format, and vice versa.
159
160 config DU
161         bool "du (default blocksize of 512 bytes)"
162         default n
163         help
164           du is used to report the amount of disk space used
165           for specified files.
166
167 config FEATURE_DU_DEFAULT_BLOCKSIZE_1K
168         bool "Use a default blocksize of 1024 bytes (1K)"
169         default y
170         depends on DU
171         help
172           Use a blocksize of (1K) instead of the default 512b.
173
174 config ECHO
175         bool "echo (basic SuSv3 version taking no options)"
176         default n
177         help
178           echo is used to print a specified string to stdout.
179
180 # this entry also appears in shell/Config.in, next to the echo builtin
181 config FEATURE_FANCY_ECHO
182         bool "Enable echo options (-n and -e)"
183         default y
184         depends on ECHO
185         help
186           This adds options (-n and -e) to echo.
187
188 config ENV
189         bool "env"
190         default n
191         help
192           env is used to set an environment variable and run
193           a command; without options it displays the current
194           environment.
195
196 config FEATURE_ENV_LONG_OPTIONS
197         bool "Enable long options"
198         default n
199         depends on ENV && GETOPT_LONG
200         help
201           Support long options for the env applet.
202
203 config EXPAND
204         bool "expand"
205         default n
206         help
207           By default, convert all tabs to spaces.
208
209 config FEATURE_EXPAND_LONG_OPTIONS
210         bool "Enable long options"
211         default n
212         depends on EXPAND && GETOPT_LONG
213         help
214           Support long options for the expand applet.
215
216 config EXPR
217         bool "expr"
218         default n
219         help
220           expr is used to calculate numbers and print the result
221           to standard output.
222
223 config EXPR_MATH_SUPPORT_64
224         bool "Extend Posix numbers support to 64 bit"
225         default n
226         depends on EXPR
227         help
228           Enable 64-bit math support in the expr applet.  This will make
229           the applet slightly larger, but will allow computation with very
230           large numbers.
231
232 config FALSE
233         bool "false"
234         default n
235         help
236           false returns an exit code of FALSE (1).
237
238 config FOLD
239         bool "fold"
240         default n
241         help
242           Wrap text to fit a specific width.
243
244 config HEAD
245         bool "head"
246         default n
247         help
248           head is used to print the first specified number of lines
249           from files.
250
251 config FEATURE_FANCY_HEAD
252         bool "Enable head options (-c, -q, and -v)"
253         default n
254         depends on HEAD
255         help
256           This enables the head options (-c, -q, and -v).
257
258 config HOSTID
259         bool "hostid"
260         default n
261         help
262           hostid prints the numeric identifier (in hexadecimal) for
263           the current host.
264
265 config ID
266         bool "id"
267         default n
268         help
269           id displays the current user and group ID names.
270
271 config INSTALL
272         bool "install"
273         default n
274         help
275           Copy files and set attributes.
276
277 config FEATURE_INSTALL_LONG_OPTIONS
278         bool "Enable long options"
279         default n
280         depends on INSTALL && GETOPT_LONG
281         help
282           Support long options for the install applet.
283
284 config LENGTH
285         bool "length"
286         default n
287         help
288           length is used to print out the length of a specified string.
289
290 config LN
291         bool "ln"
292         default n
293         help
294           ln is used to create hard or soft links between files.
295
296 config LOGNAME
297         bool "logname"
298         default n
299         help
300           logname is used to print the current user's login name.
301
302 config LS
303         bool "ls"
304         default n
305         help
306           ls is used to list the contents of directories.
307
308 config FEATURE_LS_FILETYPES
309         bool "Enable filetyping options (-p and -F)"
310         default y
311         depends on LS
312         help
313           Enable the ls options (-p and -F).
314
315 config FEATURE_LS_FOLLOWLINKS
316         bool "Enable symlinks dereferencing (-L)"
317         default y
318         depends on LS
319         help
320           Enable the ls option (-L).
321
322 config FEATURE_LS_RECURSIVE
323         bool "Enable recursion (-R)"
324         default y
325         depends on LS
326         help
327           Enable the ls option (-R).
328
329 config FEATURE_LS_SORTFILES
330         bool "Sort the file names"
331         default y
332         depends on LS
333         help
334           Allow ls to sort file names alphabetically.
335
336 config FEATURE_LS_TIMESTAMPS
337         bool "Show file timestamps"
338         default y
339         depends on LS
340         help
341           Allow ls to display timestamps for files.
342
343 config FEATURE_LS_USERNAME
344         bool "Show username/groupnames"
345         default y
346         depends on LS
347         help
348           Allow ls to display username/groupname for files.
349
350 config FEATURE_LS_COLOR
351         bool "Allow use of color to identify file types"
352         default y
353         depends on LS && GETOPT_LONG
354         help
355           This enables the --color option to ls.
356
357 config FEATURE_LS_COLOR_IS_DEFAULT
358         bool "Produce colored ls output by default"
359         default n
360         depends on FEATURE_LS_COLOR
361         help
362           Saying yes here will turn coloring on by default,
363           even if no "--color" option is given to the ls command.
364           This is not recommended, since the colors are not
365           configurable, and the output may not be legible on
366           many output screens.
367
368 config MD5SUM
369         bool "md5sum"
370         default n
371         help
372           md5sum is used to print or check MD5 checksums.
373
374 config MKDIR
375         bool "mkdir"
376         default n
377         help
378           mkdir is used to create directories with the specified names.
379
380 config FEATURE_MKDIR_LONG_OPTIONS
381         bool "Enable long options"
382         default n
383         depends on MKDIR && GETOPT_LONG
384         help
385           Support long options for the mkdir applet.
386
387 config MKFIFO
388         bool "mkfifo"
389         default n
390         help
391           mkfifo is used to create FIFOs (named pipes).
392           The `mknod' program can also create FIFOs.
393
394 config MKNOD
395         bool "mknod"
396         default n
397         help
398           mknod is used to create FIFOs or block/character special
399           files with the specified names.
400
401 config MV
402         bool "mv"
403         default n
404         help
405           mv is used to move or rename files or directories.
406
407 config FEATURE_MV_LONG_OPTIONS
408         bool "Enable long options"
409         default n
410         depends on MV && GETOPT_LONG
411         help
412           Support long options for the mv applet.
413
414 config NICE
415         bool "nice"
416         default n
417         help
418           nice runs a program with modified scheduling priority.
419
420 config NOHUP
421         bool "nohup"
422         default n
423         help
424           run a command immune to hangups, with output to a non-tty.
425
426 config OD
427         bool "od"
428         default n
429         help
430           od is used to dump binary files in octal and other formats.
431
432 config PRINTENV
433         bool "printenv"
434         default n
435         help
436           printenv is used to print all or part of environment.
437
438 config PRINTF
439         bool "printf"
440         default n
441         help
442           printf is used to format and print specified strings.
443           It's similar to `echo' except it has more options.
444
445 config PWD
446         bool "pwd"
447         default n
448         help
449           pwd is used to print the current directory.
450
451 config READLINK
452         bool "readlink"
453         default n
454         help
455           This program reads a symbolic link and returns the name
456           of the file it points to
457
458 config FEATURE_READLINK_FOLLOW
459         bool "Enable canonicalization by following all symlinks (-f)"
460         default n
461         depends on READLINK
462         help
463           Enable the readlink option (-f).
464
465 config REALPATH
466         bool "realpath"
467         default n
468         help
469           Return the canonicalized absolute pathname.
470           This isn't provided by GNU shellutils, but where else does it belong.
471
472 config RM
473         bool "rm"
474         default n
475         help
476           rm is used to remove files or directories.
477
478 config RMDIR
479         bool "rmdir"
480         default n
481         help
482           rmdir is used to remove empty directories.
483
484 config SEQ
485         bool "seq"
486         default n
487         help
488           print a sequence of numbers
489
490 config SHA1SUM
491         bool "sha1sum"
492         default n
493         help
494           Compute and check SHA1 message digest
495
496 config SLEEP
497         bool "sleep (single integer arg with no suffix)"
498         default n
499         help
500           sleep is used to pause for a specified number of seconds,
501
502 config FEATURE_FANCY_SLEEP
503         bool "Enable multiple integer args and optional time suffixes"
504         default n
505         depends on SLEEP
506         help
507           Allow sleep to pause for specified minutes, hours, and days.
508
509 config SORT
510         bool "sort"
511         default n
512         help
513           sort is used to sort lines of text in specified files.
514
515 config FEATURE_SORT_BIG
516         bool "full SuSv3 compliant sort (Support -ktcsbdfiozgM)"
517         default y
518         depends on SORT
519         help
520           Without this, sort only supports  -r, -u, and an integer version
521           of -n.  Selecting this adds sort keys, floating point support, and
522           more.  This adds a little over 3k to a nonstatic build on x86.
523
524           The SuSv3 sort standard is available at:
525           http://www.opengroup.org/onlinepubs/007904975/utilities/sort.html
526
527 config SPLIT
528         bool "split"
529         default n
530         help
531           split a file into pieces.
532
533 config FEATURE_SPLIT_FANCY
534         bool "fancy extensions"
535         default n
536         depends on SPLIT
537         help
538           Add support for features not required by SUSv3.
539           Supports additional suffixes 'b' for 512 bytes,
540           'g' for 1GiB for the -b option.
541
542 config STAT
543         bool "stat"
544         default n
545         help
546           display file or filesystem status.
547
548 config FEATURE_STAT_FORMAT
549         bool "Enable custom formats (-c)"
550         default n
551         depends on STAT
552         help
553           Without this, stat will not support the '-c format' option where
554           users can pass a custom format string for output.  This adds about
555           7k to a nonstatic build on amd64.
556
557 config STTY
558         bool "stty"
559         default n
560         help
561           stty is used to change and print terminal line settings.
562
563 config SUM
564         bool "sum"
565         default n
566         help
567           checksum and count the blocks in a file
568
569 config SYNC
570         bool "sync"
571         default n
572         help
573           sync is used to flush filesystem buffers.
574
575 config TAIL
576         bool "tail"
577         default n
578         help
579           tail is used to print the last specified number of lines
580           from files.
581
582 config FEATURE_FANCY_TAIL
583         bool "Enable extra tail options (-q, -s, and -v)"
584         default y
585         depends on TAIL
586         help
587           The options (-q, -s, and -v) are provided by GNU tail, but
588           are not specific in the SUSv3 standard.
589
590 config TEE
591         bool "tee"
592         default n
593         help
594           tee is used to read from standard input and write
595           to standard output and files.
596
597 config FEATURE_TEE_USE_BLOCK_IO
598         bool "Enable block i/o (larger/faster) instead of byte i/o."
599         default n
600         depends on TEE
601         help
602           Enable this option for a faster tee, at expense of size.
603
604 config TEST
605         bool "test"
606         default n
607         help
608           test is used to check file types and compare values,
609           returning an appropriate exit code.  The bash shell
610           has test built in, ash can build it in optionally.
611
612 config FEATURE_TEST_64
613         bool "Extend test to 64 bit"
614         default n
615         depends on TEST
616         help
617           Enable 64-bit support in test.
618
619 config TOUCH
620         bool "touch"
621         default n
622         help
623           touch is used to create or change the access and/or
624           modification timestamp of specified files.
625
626 config TR
627         bool "tr"
628         default n
629         help
630           tr is used to squeeze, and/or delete characters from standard
631           input, writing to standard output.
632
633 config FEATURE_TR_CLASSES
634         bool "Enable character classes (such as [:upper:])"
635         default n
636         depends on TR
637         help
638           Enable character classes, enabling commands such as:
639           tr [:upper:] [:lower:] to convert input into lowercase.
640
641 config FEATURE_TR_EQUIV
642         bool "Enable equivalence classes"
643         default n
644         depends on TR
645         help
646           Enable equivalence classes, which essentially add the enclosed
647           character to the current set. For instance, tr [=a=] xyz would
648           replace all instances of 'a' with 'xyz'. This option is mainly
649           useful for cases when no other way of expressing a character
650           is possible.
651
652 config TRUE
653         bool "true"
654         default n
655         help
656           true returns an exit code of TRUE (0).
657
658 config TTY
659         bool "tty"
660         default n
661         help
662           tty is used to print the name of the current terminal to
663           standard output.
664
665 config UNAME
666         bool "uname"
667         default n
668         help
669           uname is used to print system information.
670
671 config UNEXPAND
672         bool "unexpand"
673         default n
674         help
675           By default, convert only leading sequences of blanks to tabs.
676
677 config FEATURE_UNEXPAND_LONG_OPTIONS
678         bool "Enable long options"
679         default n
680         depends on UNEXPAND && GETOPT_LONG
681         help
682           Support long options for the unexpand applet.
683
684 config UNIQ
685         bool "uniq"
686         default n
687         help
688           uniq is used to remove duplicate lines from a sorted file.
689
690 config USLEEP
691         bool "usleep"
692         default n
693         help
694           usleep is used to pause for a specified number of microseconds.
695
696 config UUDECODE
697         bool "uudecode"
698         default n
699         help
700           uudecode is used to decode a uuencoded file.
701
702 config UUENCODE
703         bool "uuencode"
704         default n
705         help
706           uuencode is used to uuencode a file.
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