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