Typo fix.
[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 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 CONFIG_CAL
17         bool "cal"
18         default n
19         help
20           cal is used to display a monthly calender.
21
22 config 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 CONFIG_FEATURE_CAT_ESCAPE
30         bool "support -vetET"
31         depends on CONFIG_CAT
32         default n
33         help
34           Sheer bloat.
35
36 config CONFIG_CHGRP
37         bool "chgrp"
38         default n
39         help
40           chgrp is used to change the group ownership of files.
41
42 config CONFIG_CHMOD
43         bool "chmod"
44         default n
45         help
46           chmod is used to change the access permission of files.
47
48 config 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 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 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 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 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 CONFIG_CP
83         bool "cp"
84         default n
85         help
86           cp is used to copy files and directories.
87
88 config 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 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 CONFIG_FEATURE_DATE_ISOFMT
103         bool "Enable ISO date format output (-I)"
104         default y
105         depends on CONFIG_DATE
106         help
107           Enable option (-I) to output an ISO-8601 compliant
108           date/time string.
109
110 config 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 CONFIG_FEATURE_DD_SIGNAL_HANDLING
119         bool "Enable DD signal handling for status reporting"
120         default y
121         depends on CONFIG_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 CONFIG_FEATURE_DD_IBS_OBS
131         bool "Enable ibs, obs and conv options"
132         default n
133         depends on CONFIG_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 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 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 CONFIG_FEATURE_DIFF_BINARY
154         bool "Enable checks for binary files"
155         default y
156         depends on CONFIG_DIFF
157         help
158           This option enables support for checking for binary files
159           before a comparison is carried out.
160
161 config CONFIG_FEATURE_DIFF_DIR
162         bool "Enable directory support"
163         default y
164         depends on CONFIG_DIFF
165         help
166           This option enables support for directory and subdirectory
167           comparison.
168
169 config CONFIG_FEATURE_DIFF_MINIMAL
170         bool "Enable -d option to find smaller sets of changes"
171         default n
172         depends on CONFIG_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 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 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 CONFIG_UNIX2DOS
192         bool
193         default y
194         depends on CONFIG_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 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 CONFIG_FEATURE_DU_DEFAULT_BLOCKSIZE_1K
207         bool "Use a default blocksize of 1024 bytes (1K)"
208         default y
209         depends on CONFIG_DU
210         help
211           Use a blocksize of (1K) instead of the default 512b.
212
213 config 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 CONFIG_FEATURE_FANCY_ECHO
221         bool "Enable echo options (-n and -e)"
222         default y
223         depends on CONFIG_ECHO
224         help
225           This adds options (-n and -e) to echo.
226
227 config 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 CONFIG_EXPR
236         bool "expr"
237         default n
238         help
239           expr is used to calculate numbers and print the result
240           to standard output.
241
242 config CONFIG_EXPR_MATH_SUPPORT_64
243         bool "Extend Posix numbers support to 64 bit"
244         default n
245         depends on CONFIG_EXPR
246         help
247           Enable 64-bit math support in the expr applet.  This will make
248           the applet slightly larger, but will allow computation with very
249           large numbers.
250
251 config CONFIG_FALSE
252         bool "false"
253         default n
254         help
255           false returns an exit code of FALSE (1).
256
257 config CONFIG_FOLD
258         bool "fold"
259         default n
260         help
261           Wrap text to fit a specific width.
262
263 config CONFIG_HEAD
264         bool "head"
265         default n
266         help
267           head is used to print the first specified number of lines
268           from files.
269
270 config CONFIG_FEATURE_FANCY_HEAD
271         bool "Enable head options (-c, -q, and -v)"
272         default n
273         depends on CONFIG_HEAD
274         help
275           This enables the head options (-c, -q, and -v).
276
277 config CONFIG_HOSTID
278         bool "hostid"
279         default n
280         help
281           hostid prints the numeric identifier (in hexadecimal) for
282           the current host.
283
284 config CONFIG_ID
285         bool "id"
286         default n
287         help
288           id displays the current user and group ID names.
289
290 config CONFIG_INSTALL
291         bool "install"
292         default n
293         help
294           Copy files and set attributes.
295
296 config CONFIG_LENGTH
297         bool "length"
298         default n
299         help
300           length is used to print out the length of a specified string.
301
302 config CONFIG_LN
303         bool "ln"
304         default n
305         help
306           ln is used to create hard or soft links between files.
307
308 config CONFIG_LOGNAME
309         bool "logname"
310         default n
311         help
312           logname is used to print the current user's login name.
313
314 config CONFIG_LS
315         bool "ls"
316         default n
317         help
318           ls is used to list the contents of directories.
319
320 config CONFIG_FEATURE_LS_FILETYPES
321         bool "Enable filetyping options (-p and -F)"
322         default y
323         depends on CONFIG_LS
324         help
325           Enable the ls options (-p and -F).
326
327 config CONFIG_FEATURE_LS_FOLLOWLINKS
328         bool "Enable symlinks dereferencing (-L)"
329         default y
330         depends on CONFIG_LS
331         help
332           Enable the ls option (-L).
333
334 config CONFIG_FEATURE_LS_RECURSIVE
335         bool "Enable recursion (-R)"
336         default y
337         depends on CONFIG_LS
338         help
339           Enable the ls option (-R).
340
341 config CONFIG_FEATURE_LS_SORTFILES
342         bool "Sort the file names"
343         default y
344         depends on CONFIG_LS
345         help
346           Allow ls to sort file names alphabetically.
347
348 config CONFIG_FEATURE_LS_TIMESTAMPS
349         bool "Show file timestamps"
350         default y
351         depends on CONFIG_LS
352         help
353           Allow ls to display timestamps for files.
354
355 config CONFIG_FEATURE_LS_USERNAME
356         bool "Show username/groupnames"
357         default y
358         depends on CONFIG_LS
359         help
360           Allow ls to display username/groupname for files.
361
362 config CONFIG_FEATURE_LS_COLOR
363         bool "Allow use of color to identify file types"
364         default y
365         depends on CONFIG_LS
366         help
367           This enables the --color option to ls.
368
369 config CONFIG_FEATURE_LS_COLOR_IS_DEFAULT
370         bool "Produce colored ls output by default"
371         default n
372         depends on CONFIG_FEATURE_LS_COLOR
373         help
374           Saying yes here will turn coloring on by default,
375           even if no "--color" option is given to the ls command.
376           This is not recommended, since the colors are not
377           configurable, and the output may not be legible on
378           many output screens.
379
380 config CONFIG_MD5SUM
381         bool "md5sum"
382         default n
383         help
384           md5sum is used to print or check MD5 checksums.
385
386 config CONFIG_MKDIR
387         bool "mkdir"
388         default n
389         help
390           mkdir is used to create directories with the specified names.
391
392 config CONFIG_MKFIFO
393         bool "mkfifo"
394         default n
395         help
396           mkfifo is used to create FIFOs (named pipes).
397           The `mknod' program can also create FIFOs.
398
399 config CONFIG_MKNOD
400         bool "mknod"
401         default n
402         help
403           mknod is used to create FIFOs or block/character special
404           files with the specified names.
405
406 config CONFIG_MV
407         bool "mv"
408         default n
409         help
410           mv is used to move or rename files or directories.
411
412 config CONFIG_NICE
413         bool "nice"
414         default n
415         help
416           nice runs a program with modified scheduling priority.
417
418 config CONFIG_NOHUP
419         bool "nohup"
420         default n
421         help
422           run a command immune to hangups, with output to a non-tty.
423
424 config CONFIG_OD
425         bool "od"
426         default n
427         help
428           od is used to dump binary files in octal and other formats.
429
430 config CONFIG_PRINTENV
431         bool "printenv"
432         default n
433         help
434           printenv is used to print all or part of environment.
435
436 config CONFIG_PRINTF
437         bool "printf"
438         default n
439         help
440           printf is used to format and print specified strings.
441           It's similar to `echo' except it has more options.
442
443 config CONFIG_PWD
444         bool "pwd"
445         default n
446         help
447           pwd is used to print the current directory.
448
449 config CONFIG_REALPATH
450         bool "realpath"
451         default n
452         help
453           Return the canonicalized absolute pathname.
454           This isn't provided by GNU shellutils, but where else does it belong.
455
456 config CONFIG_RM
457         bool "rm"
458         default n
459         help
460           rm is used to remove files or directories.
461
462 config CONFIG_RMDIR
463         bool "rmdir"
464         default n
465         help
466           rmdir is used to remove empty directories.
467
468 config CONFIG_SEQ
469         bool "seq"
470         default n
471         help
472           print a sequence of numbers
473
474 config CONFIG_SHA1SUM
475         bool "sha1sum"
476         default n
477         help
478           Compute and check SHA1 message digest
479
480 config CONFIG_SLEEP
481         bool "sleep (single integer arg with no suffix)"
482         default n
483         help
484           sleep is used to pause for a specified number of seconds,
485
486 config CONFIG_FEATURE_FANCY_SLEEP
487         bool "Enable multiple integer args and optional time suffixes"
488         default n
489         depends on CONFIG_SLEEP
490         help
491           Allow sleep to pause for specified minutes, hours, and days.
492
493 config CONFIG_SORT
494         bool "sort"
495         default n
496         help
497           sort is used to sort lines of text in specified files.
498
499 config CONFIG_FEATURE_SORT_BIG
500         bool "full SuSv3 compliant sort (Support -ktcsbdfiozgM)"
501         default y
502         depends on CONFIG_SORT
503         help
504           Without this, sort only supports  -r, -u, and an integer version
505           of -n.  Selecting this adds sort keys, floating point support, and
506           more.  This adds a little over 3k to a nonstatic build on x86.
507
508           The SuSv3 sort standard is available at:
509           http://www.opengroup.org/onlinepubs/007904975/utilities/sort.html
510
511 config CONFIG_STAT
512         bool "stat"
513         default n
514         help
515           display file or filesystem status.
516
517 config CONFIG_FEATURE_STAT_FORMAT
518         bool "Enable custom formats (-c)"
519         default n
520         depends on CONFIG_STAT
521         help
522           Without this, stat will not support the '-c format' option where
523           users can pass a custom format string for output.  This adds about
524           7k to a nonstatic build on amd64.
525
526 config CONFIG_STTY
527         bool "stty"
528         default n
529         help
530           stty is used to change and print terminal line settings.
531
532 config CONFIG_SUM
533         bool "sum"
534         default n
535         help
536           checksum and count the blocks in a file
537
538 config CONFIG_SYNC
539         bool "sync"
540         default n
541         help
542           sync is used to flush filesystem buffers.
543
544 config CONFIG_TAIL
545         bool "tail"
546         default n
547         help
548           tail is used to print the last specified number of lines
549           from files.
550
551 config CONFIG_FEATURE_FANCY_TAIL
552         bool "Enable extra tail options (-q, -s, and -v)"
553         default y
554         depends on CONFIG_TAIL
555         help
556           The options (-q, -s, and -v) are provided by GNU tail, but
557           are not specific in the SUSv3 standard.
558
559 config CONFIG_TEE
560         bool "tee"
561         default n
562         help
563           tee is used to read from standard input and write
564           to standard output and files.
565
566 config CONFIG_FEATURE_TEE_USE_BLOCK_IO
567         bool "Enable block i/o (larger/faster) instead of byte i/o."
568         default n
569         depends on CONFIG_TEE
570         help
571           Enable this option for a faster tee, at expense of size.
572
573 config CONFIG_TEST
574         bool "test"
575         default n
576         help
577           test is used to check file types and compare values,
578           returning an appropriate exit code. The shells (ash
579           and bash) have test builtin.
580
581 config CONFIG_FEATURE_TEST_64
582         bool "Extend test to 64 bit"
583         default n
584         depends on CONFIG_TEST
585         help
586           Enable 64-bit support in test.
587
588 config CONFIG_TOUCH
589         bool "touch"
590         default n
591         help
592           touch is used to create or change the access and/or
593           modification timestamp of specified files.
594
595 config CONFIG_TR
596         bool "tr"
597         default n
598         help
599           tr is used to squeeze, and/or delete characters from standard
600           input, writing to standard output.
601
602 config CONFIG_FEATURE_TR_CLASSES
603         bool "Enable character classes (such as [:upper:])"
604         default n
605         depends on CONFIG_TR
606         help
607           Enable character classes, enabling commands such as:
608           tr [:upper:] [:lower:] to convert input into lowercase.
609
610 config CONFIG_FEATURE_TR_EQUIV
611         bool "Enable equivalence classes"
612         default n
613         depends on CONFIG_TR
614         help
615           Enable equivalence classes, which essentially add the enclosed
616           character to the current set. For instance, tr [=a=] xyz would
617           replace all instances of 'a' with 'xyz'. This option is mainly
618           useful for cases when no other way of expressing a character
619           is possible.
620
621 config CONFIG_TRUE
622         bool "true"
623         default n
624         help
625           true returns an exit code of TRUE (0).
626
627 config CONFIG_TTY
628         bool "tty"
629         default n
630         help
631           tty is used to print the name of the current terminal to
632           standard output.
633
634 config CONFIG_UNAME
635         bool "uname"
636         default n
637         help
638           uname is used to print system information.
639
640 config CONFIG_UNIQ
641         bool "uniq"
642         default n
643         help
644           uniq is used to remove duplicate lines from a sorted file.
645
646 config CONFIG_USLEEP
647         bool "usleep"
648         default n
649         help
650           usleep is used to pause for a specified number of microseconds.
651
652 config CONFIG_UUDECODE
653         bool "uudecode"
654         default n
655         help
656           uudecode is used to decode a uuencoded file.
657
658 config CONFIG_UUENCODE
659         bool "uuencode"
660         default n
661         help
662           uuencode is used to uuencode a file.
663
664 config CONFIG_WATCH
665         bool "watch"
666         default n
667         select CONFIG_DATE
668         help
669           watch is used to execute a program periodically, showing
670           output to the screen.
671
672 config CONFIG_WC
673         bool "wc"
674         default n
675         help
676           wc is used to print the number of bytes, words, and lines,
677           in specified files.
678
679 config CONFIG_WHO
680         bool "who"
681         default n
682         select CONFIG_FEATURE_UTMP
683         help
684           who is used to show who is logged on.
685
686 config CONFIG_WHOAMI
687         bool "whoami"
688         default n
689         help
690           whoami is used to print the username of the current
691           user id (same as id -un).
692
693 config CONFIG_YES
694         bool "yes"
695         default n
696         help
697           yes is used to repeatedly output a specific string, or
698           the default string `y'.
699
700 comment "Common options for cp and mv"
701         depends on CONFIG_CP || CONFIG_MV
702
703 config CONFIG_FEATURE_PRESERVE_HARDLINKS
704         bool "Preserve hard links"
705         default n
706         depends on CONFIG_CP || CONFIG_MV
707         help
708           Allow cp and mv to preserve hard links.
709
710 comment "Common options for ls, more and telnet"
711         depends on CONFIG_LS || CONFIG_MORE || CONFIG_TELNET
712
713 config CONFIG_FEATURE_AUTOWIDTH
714         bool "Calculate terminal & column widths"
715         default y
716         depends on CONFIG_LS || CONFIG_MORE || CONFIG_TELNET
717         help
718           This option allows utilities such as 'ls', 'more' and 'telnet'
719           to determine the width of the screen, which can allow them to 
720           display additional text or avoid wrapping text onto the next line.
721           If you leave this disabled, your utilities will be especially 
722           primitive and will be unable to determine the current screen width.
723
724 comment "Common options for df, du, ls"
725         depends on CONFIG_DF || CONFIG_DU || CONFIG_LS
726
727 config CONFIG_FEATURE_HUMAN_READABLE
728         bool "Support for human readable output (example 13k, 23M, 235G)"
729         default n
730         depends on CONFIG_DF || CONFIG_DU || CONFIG_LS
731         help
732           Allow df, du, and ls to have human readable output.
733
734 comment "Common options for md5sum, sha1sum"
735         depends on CONFIG_MD5SUM || CONFIG_SHA1SUM
736
737 config CONFIG_FEATURE_MD5_SHA1_SUM_CHECK
738         bool "Enable -c, -s and -w options"
739         default n
740         depends on CONFIG_MD5SUM || CONFIG_SHA1SUM
741         help
742           Enabling the -c options allows files to be checked
743           against pre-calculated hash values.
744
745           -s and -w are useful options when verifying checksums.
746
747 endmenu