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