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