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