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