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 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 CAL
  17         bool "cal"
  18         default n
  19         help
  20           cal is used to display a monthly calender.
  21
  22 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 CATV
  30         bool "catv"
  31         default n
  32         help
  33           Display nonprinting characters as escape sequences (like some
  34           implementations' cat -v option).
  35
  36 config CHGRP
  37         bool "chgrp"
  38         default n
  39         help
  40           chgrp is used to change the group ownership of files.
  41
  42 config CHMOD
  43         bool "chmod"
  44         default n
  45         help
  46           chmod is used to change the access permission of files.
  47
  48 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 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 CKSUM
  63         bool "cksum"
  64         default n
  65         help
  66           cksum is used to calculate the CRC32 checksum of a file.
  67
  68 config COMM
  69         bool "comm"
  70         default n
  71         help
  72           comm is used to compare two files line by line and return
  73           a three-column output.
  74
  75 config CP
  76         bool "cp"
  77         default n
  78         help
  79           cp is used to copy files and directories.
  80
  81 config CUT
  82         bool "cut"
  83         default n
  84         help
  85           cut is used to print selected parts of lines from
  86           each file to stdout.
  87
  88 config DATE
  89         bool "date"
  90         default n
  91         help
  92           date is used to set the system date or display the
  93           current time in the given format.
  94
  95 config FEATURE_DATE_ISOFMT
  96         bool "Enable ISO date format output (-I)"
  97         default y
  98         depends on DATE
  99         help
 100           Enable option (-I) to output an ISO-8601 compliant
 101           date/time string.
 102
 103 config DD
 104         bool "dd"
 105         default n
 106         help
 107           dd copies a file (from standard input to standard output,
 108           by default) using specific input and output blocksizes,
 109           while optionally performing conversions on it.
 110
 111 config FEATURE_DD_SIGNAL_HANDLING
 112         bool "Enable DD signal handling for status reporting"
 113         default y
 114         depends on DD
 115         help
 116           sending a SIGUSR1 signal to a running `dd' process makes it
 117           print to standard error the number of records read and written
 118           so far, then to resume copying.
 119
 120           $ dd if=/dev/zero of=/dev/null& pid=$! $ kill -USR1 $pid; sleep 1; kill $pid
 121           10899206+0 records in 10899206+0 records out
 122
 123 config FEATURE_DD_IBS_OBS
 124         bool "Enable ibs, obs and conv options"
 125         default n
 126         depends on DD
 127         help
 128           Enables support for writing a certain number of bytes in and out,
 129           at a time, and performing conversions on the data stream.
 130
 131 config DF
 132         bool "df"
 133         default n
 134         help
 135           df reports the amount of disk space used and available
 136           on filesystems.
 137
 138 config FEATURE_DF_INODE
 139         bool "Enable -i (inode information)"
 140         default n
 141         depends on DF
 142         help
 143           This option enables support for df -i.
 144
 145 config DIRNAME
 146         bool "dirname"
 147         default n
 148         help
 149           dirname is used to strip a non-directory suffix from
 150           a file name.
 151
 152 config DOS2UNIX
 153         bool "dos2unix/unix2dos"
 154         default n
 155         help
 156           dos2unix is used to convert a text file from DOS format to
 157           UNIX format, and vice versa.
 158
 159 config UNIX2DOS
 160         bool
 161         default y
 162         depends on DOS2UNIX
 163         help
 164           unix2dos is used to convert a text file from UNIX format to
 165           DOS format, and vice versa.
 166
 167 config DU
 168         bool "du (default blocksize of 512 bytes)"
 169         default n
 170         help
 171           du is used to report the amount of disk space used
 172           for specified files.
 173
 174 config FEATURE_DU_DEFAULT_BLOCKSIZE_1K
 175         bool "Use a default blocksize of 1024 bytes (1K)"
 176         default y
 177         depends on DU
 178         help
 179           Use a blocksize of (1K) instead of the default 512b.
 180
 181 config ECHO
 182         bool "echo (basic SuSv3 version taking no options)"
 183         default n
 184         help
 185           echo is used to print a specified string to stdout.
 186
 187 # this entry also appears in shell/Config.in, next to the echo builtin
 188 config FEATURE_FANCY_ECHO
 189         bool "Enable echo options (-n and -e)"
 190         default y
 191         depends on ECHO
 192         help
 193           This adds options (-n and -e) to echo.
 194
 195 config ENV
 196         bool "env"
 197         default n
 198         help
 199           env is used to set an environment variable and run
 200           a command; without options it displays the current
 201           environment.
 202
 203 config FEATURE_ENV_LONG_OPTIONS
 204         bool "Enable long options"
 205         default n
 206         depends on ENV && GETOPT_LONG
 207         help
 208           Support long options for the env applet.
 209
 210 config EXPAND
 211         bool "expand"
 212         default n
 213         help
 214           By default, convert all tabs to spaces.
 215
 216 config FEATURE_EXPAND_LONG_OPTIONS
 217         bool "Enable long options"
 218         default n
 219         depends on EXPAND && GETOPT_LONG
 220         help
 221           Support long options for the expand applet.
 222
 223 config EXPR
 224         bool "expr"
 225         default n
 226         help
 227           expr is used to calculate numbers and print the result
 228           to standard output.
 229
 230 config EXPR_MATH_SUPPORT_64
 231         bool "Extend Posix numbers support to 64 bit"
 232         default n
 233         depends on EXPR
 234         help
 235           Enable 64-bit math support in the expr applet.  This will make
 236           the applet slightly larger, but will allow computation with very
 237           large numbers.
 238
 239 config FALSE
 240         bool "false"
 241         default n
 242         help
 243           false returns an exit code of FALSE (1).
 244
 245 config FOLD
 246         bool "fold"
 247         default n
 248         help
 249           Wrap text to fit a specific width.
 250
 251 config HEAD
 252         bool "head"
 253         default n
 254         help
 255           head is used to print the first specified number of lines
 256           from files.
 257
 258 config FEATURE_FANCY_HEAD
 259         bool "Enable head options (-c, -q, and -v)"
 260         default n
 261         depends on HEAD
 262         help
 263           This enables the head options (-c, -q, and -v).
 264
 265 config HOSTID
 266         bool "hostid"
 267         default n
 268         help
 269           hostid prints the numeric identifier (in hexadecimal) for
 270           the current host.
 271
 272 config ID
 273         bool "id"
 274         default n
 275         help
 276           id displays the current user and group ID names.
 277
 278 config INSTALL
 279         bool "install"
 280         default n
 281         help
 282           Copy files and set attributes.
 283
 284 config FEATURE_INSTALL_LONG_OPTIONS
 285         bool "Enable long options"
 286         default n
 287         depends on INSTALL && GETOPT_LONG
 288         help
 289           Support long options for the install applet.
 290
 291 config LENGTH
 292         bool "length"
 293         default n
 294         help
 295           length is used to print out the length of a specified string.
 296
 297 config LN
 298         bool "ln"
 299         default n
 300         help
 301           ln is used to create hard or soft links between files.
 302
 303 config LOGNAME
 304         bool "logname"
 305         default n
 306         help
 307           logname is used to print the current user's login name.
 308
 309 config LS
 310         bool "ls"
 311         default n
 312         help
 313           ls is used to list the contents of directories.
 314
 315 config FEATURE_LS_FILETYPES
 316         bool "Enable filetyping options (-p and -F)"
 317         default y
 318         depends on LS
 319         help
 320           Enable the ls options (-p and -F).
 321
 322 config FEATURE_LS_FOLLOWLINKS
 323         bool "Enable symlinks dereferencing (-L)"
 324         default y
 325         depends on LS
 326         help
 327           Enable the ls option (-L).
 328
 329 config FEATURE_LS_RECURSIVE
 330         bool "Enable recursion (-R)"
 331         default y
 332         depends on LS
 333         help
 334           Enable the ls option (-R).
 335
 336 config FEATURE_LS_SORTFILES
 337         bool "Sort the file names"
 338         default y
 339         depends on LS
 340         help
 341           Allow ls to sort file names alphabetically.
 342
 343 config FEATURE_LS_TIMESTAMPS
 344         bool "Show file timestamps"
 345         default y
 346         depends on LS
 347         help
 348           Allow ls to display timestamps for files.
 349
 350 config FEATURE_LS_USERNAME
 351         bool "Show username/groupnames"
 352         default y
 353         depends on LS
 354         help
 355           Allow ls to display username/groupname for files.
 356
 357 config FEATURE_LS_COLOR
 358         bool "Allow use of color to identify file types"
 359         default y
 360         depends on LS && GETOPT_LONG
 361         help
 362           This enables the --color option to ls.
 363
 364 config FEATURE_LS_COLOR_IS_DEFAULT
 365         bool "Produce colored ls output by default"
 366         default n
 367         depends on FEATURE_LS_COLOR
 368         help
 369           Saying yes here will turn coloring on by default,
 370           even if no "--color" option is given to the ls command.
 371           This is not recommended, since the colors are not
 372           configurable, and the output may not be legible on
 373           many output screens.
 374
 375 config MD5SUM
 376         bool "md5sum"
 377         default n
 378         help
 379           md5sum is used to print or check MD5 checksums.
 380
 381 config MKDIR
 382         bool "mkdir"
 383         default n
 384         help
 385           mkdir is used to create directories with the specified names.
 386
 387 config FEATURE_MKDIR_LONG_OPTIONS
 388         bool "Enable long options"
 389         default n
 390         depends on MKDIR && GETOPT_LONG
 391         help
 392           Support long options for the mkdir applet.
 393
 394 config MKFIFO
 395         bool "mkfifo"
 396         default n
 397         help
 398           mkfifo is used to create FIFOs (named pipes).
 399           The `mknod' program can also create FIFOs.
 400
 401 config MKNOD
 402         bool "mknod"
 403         default n
 404         help
 405           mknod is used to create FIFOs or block/character special
 406           files with the specified names.
 407
 408 config MV
 409         bool "mv"
 410         default n
 411         help
 412           mv is used to move or rename files or directories.
 413
 414 config FEATURE_MV_LONG_OPTIONS
 415         bool "Enable long options"
 416         default n
 417         depends on MV && GETOPT_LONG
 418         help
 419           Support long options for the mv applet.
 420
 421 config NICE
 422         bool "nice"
 423         default n
 424         help
 425           nice runs a program with modified scheduling priority.
 426
 427 config NOHUP
 428         bool "nohup"
 429         default n
 430         help
 431           run a command immune to hangups, with output to a non-tty.
 432
 433 config OD
 434         bool "od"
 435         default n
 436         help
 437           od is used to dump binary files in octal and other formats.
 438
 439 config PRINTENV
 440         bool "printenv"
 441         default n
 442         help
 443           printenv is used to print all or part of environment.
 444
 445 config PRINTF
 446         bool "printf"
 447         default n
 448         help
 449           printf is used to format and print specified strings.
 450           It's similar to `echo' except it has more options.
 451
 452 config PWD
 453         bool "pwd"
 454         default n
 455         help
 456           pwd is used to print the current directory.
 457
 458 config READLINK
 459         bool "readlink"
 460         default n
 461         help
 462           This program reads a symbolic link and returns the name
 463           of the file it points to
 464
 465 config FEATURE_READLINK_FOLLOW
 466         bool "Enable canonicalization by following all symlinks (-f)"
 467         default n
 468         depends on READLINK
 469         help
 470           Enable the readlink option (-f).
 471
 472 config REALPATH
 473         bool "realpath"
 474         default n
 475         help
 476           Return the canonicalized absolute pathname.
 477           This isn't provided by GNU shellutils, but where else does it belong.
 478
 479 config RM
 480         bool "rm"
 481         default n
 482         help
 483           rm is used to remove files or directories.
 484
 485 config RMDIR
 486         bool "rmdir"
 487         default n
 488         help
 489           rmdir is used to remove empty directories.
 490
 491 config FEATURE_RMDIR_LONG_OPTIONS
 492         bool "Enable long options"
 493         default n
 494         depends on RMDIR && GETOPT_LONG
 495         help
 496           Support long options for the rmdir applet, including
 497           --ignore-fail-on-non-empty for compatibility with GNU rmdir.
 498
 499 config SEQ
 500         bool "seq"
 501         default n
 502         help
 503           print a sequence of numbers
 504
 505 config SHA1SUM
 506         bool "sha1sum"
 507         default n
 508         help
 509           Compute and check SHA1 message digest
 510
 511 config SLEEP
 512         bool "sleep"
 513         default n
 514         help
 515           sleep is used to pause for a specified number of seconds.
 516           It comes in 3 versions:
 517           - small: takes one integer parameter
 518           - fancy: takes multiple integer arguments with suffixes:
 519             sleep 1d 2h 3m 15s
 520           - fancy with fractional numbers:
 521             sleep 2.3s 4.5h sleeps for 16202.3 seconds
 522           Last one is "the most compatible" with coreutils sleep,
 523           but it adds around 1k of code.
 524
 525 config FEATURE_FANCY_SLEEP
 526         bool "Enable multiple arguments and s/m/h/d suffixes"
 527         default n
 528         depends on SLEEP
 529         help
 530           Allow sleep to pause for specified minutes, hours, and days.
 531
 532 config FEATURE_FLOAT_SLEEP
 533         bool "Enable fractional arguments"
 534         default n
 535         depends on FEATURE_FANCY_SLEEP
 536         help
 537           Allow for fractional numeric parameters.
 538
 539 config SORT
 540         bool "sort"
 541         default n
 542         help
 543           sort is used to sort lines of text in specified files.
 544
 545 config FEATURE_SORT_BIG
 546         bool "Full SuSv3 compliant sort (support -ktcsbdfiozgM)"
 547         default y
 548         depends on SORT
 549         help
 550           Without this, sort only supports -r, -u, and an integer version
 551           of -n.  Selecting this adds sort keys, floating point support, and
 552           more.  This adds a little over 3k to a nonstatic build on x86.
 553
 554           The SuSv3 sort standard is available at:
 555           http://www.opengroup.org/onlinepubs/007904975/utilities/sort.html
 556
 557 config SPLIT
 558         bool "split"
 559         default n
 560         help
 561           split a file into pieces.
 562
 563 config FEATURE_SPLIT_FANCY
 564         bool "Fancy extensions"
 565         default n
 566         depends on SPLIT
 567         help
 568           Add support for features not required by SUSv3.
 569           Supports additional suffixes 'b' for 512 bytes,
 570           'g' for 1GiB for the -b option.
 571
 572 config STAT
 573         bool "stat"
 574         default n
 575         help
 576           display file or filesystem status.
 577
 578 config FEATURE_STAT_FORMAT
 579         bool "Enable custom formats (-c)"
 580         default n
 581         depends on STAT
 582         help
 583           Without this, stat will not support the '-c format' option where
 584           users can pass a custom format string for output.  This adds about
 585           7k to a nonstatic build on amd64.
 586
 587 config STTY
 588         bool "stty"
 589         default n
 590         help
 591           stty is used to change and print terminal line settings.
 592
 593 config SUM
 594         bool "sum"
 595         default n
 596         help
 597           checksum and count the blocks in a file
 598
 599 config SYNC
 600         bool "sync"
 601         default n
 602         help
 603           sync is used to flush filesystem buffers.
 604
 605 config TAC
 606         bool "tac"
 607         default n
 608         help
 609           tac is used to concatenate and print files in reverse.
 610
 611 config TAIL
 612         bool "tail"
 613         default n
 614         help
 615           tail is used to print the last specified number of lines
 616           from files.
 617
 618 config FEATURE_FANCY_TAIL
 619         bool "Enable extra tail options (-q, -s, and -v)"
 620         default y
 621         depends on TAIL
 622         help
 623           The options (-q, -s, and -v) are provided by GNU tail, but
 624           are not specific in the SUSv3 standard.
 625
 626 config TEE
 627         bool "tee"
 628         default n
 629         help
 630           tee is used to read from standard input and write
 631           to standard output and files.
 632
 633 config FEATURE_TEE_USE_BLOCK_IO
 634         bool "Enable block I/O (larger/faster) instead of byte I/O"
 635         default n
 636         depends on TEE
 637         help
 638           Enable this option for a faster tee, at expense of size.
 639
 640 config TEST
 641         bool "test"
 642         default n
 643         help
 644           test is used to check file types and compare values,
 645           returning an appropriate exit code.  The bash shell
 646           has test built in, ash can build it in optionally.
 647
 648 config FEATURE_TEST_64
 649         bool "Extend test to 64 bit"
 650         default n
 651         depends on TEST
 652         help
 653           Enable 64-bit support in test.
 654
 655 config TOUCH
 656         bool "touch"
 657         default n
 658         help
 659           touch is used to create or change the access and/or
 660           modification timestamp of specified files.
 661
 662 config TR
 663         bool "tr"
 664         default n
 665         help
 666           tr is used to squeeze, and/or delete characters from standard
 667           input, writing to standard output.
 668
 669 config FEATURE_TR_CLASSES
 670         bool "Enable character classes (such as [:upper:])"
 671         default n
 672         depends on TR
 673         help
 674           Enable character classes, enabling commands such as:
 675           tr [:upper:] [:lower:] to convert input into lowercase.
 676
 677 config FEATURE_TR_EQUIV
 678         bool "Enable equivalence classes"
 679         default n
 680         depends on TR
 681         help
 682           Enable equivalence classes, which essentially add the enclosed
 683           character to the current set. For instance, tr [=a=] xyz would
 684           replace all instances of 'a' with 'xyz'. This option is mainly
 685           useful for cases when no other way of expressing a character
 686           is possible.
 687
 688 config TRUE
 689         bool "true"
 690         default n
 691         help
 692           true returns an exit code of TRUE (0).
 693
 694 config TTY
 695         bool "tty"
 696         default n
 697         help
 698           tty is used to print the name of the current terminal to
 699           standard output.
 700
 701 config UNAME
 702         bool "uname"
 703         default n
 704         help
 705           uname is used to print system information.
 706
 707 config UNEXPAND
 708         bool "unexpand"
 709         default n
 710         help
 711           By default, convert only leading sequences of blanks to tabs.
 712
 713 config FEATURE_UNEXPAND_LONG_OPTIONS
 714         bool "Enable long options"
 715         default n
 716         depends on UNEXPAND && GETOPT_LONG
 717         help
 718           Support long options for the unexpand applet.
 719
 720 config UNIQ
 721         bool "uniq"
 722         default n
 723         help
 724           uniq is used to remove duplicate lines from a sorted file.
 725
 726 config USLEEP
 727         bool "usleep"
 728         default n
 729         help
 730           usleep is used to pause for a specified number of microseconds.
 731
 732 config UUDECODE
 733         bool "uudecode"
 734         default n
 735         help
 736           uudecode is used to decode a uuencoded file.
 737
 738 config UUENCODE
 739         bool "uuencode"
 740         default n
 741         help
 742           uuencode is used to uuencode a file.
 743
 744 config WC
 745         bool "wc"
 746         default n
 747         help
 748           wc is used to print the number of bytes, words, and lines,
 749           in specified files.
 750
 751 config FEATURE_WC_LARGE
 752         bool "Support very large files in wc"
 753         default n
 754         depends on WC
 755         help
 756           Use "unsigned long long" in wc for count variables
 757
 758 config WHO
 759         bool "who"
 760         default n
 761         select FEATURE_UTMP
 762         help
 763           who is used to show who is logged on.
 764
 765 config WHOAMI
 766         bool "whoami"
 767         default n
 768         help
 769           whoami is used to print the username of the current
 770           user id (same as id -un).
 771
 772 config YES
 773         bool "yes"
 774         default n
 775         help
 776           yes is used to repeatedly output a specific string, or
 777           the default string `y'.
 778
 779 comment "Common options for cp and mv"
 780         depends on CP || MV
 781
 782 config FEATURE_PRESERVE_HARDLINKS
 783         bool "Preserve hard links"
 784         default n
 785         depends on CP || MV
 786         help
 787           Allow cp and mv to preserve hard links.
 788
 789 comment "Common options for ls, more and telnet"
 790         depends on LS || MORE || TELNET
 791
 792 config FEATURE_AUTOWIDTH
 793         bool "Calculate terminal & column widths"
 794         default y
 795         depends on LS || MORE || TELNET
 796         help
 797           This option allows utilities such as 'ls', 'more' and 'telnet'
 798           to determine the width of the screen, which can allow them to
 799           display additional text or avoid wrapping text onto the next line.
 800           If you leave this disabled, your utilities will be especially
 801           primitive and will be unable to determine the current screen width.
 802
 803 comment "Common options for df, du, ls"
 804         depends on DF || DU || LS
 805
 806 config FEATURE_HUMAN_READABLE
 807         bool "Support for human readable output (example 13k, 23M, 235G)"
 808         default n
 809         depends on DF || DU || LS
 810         help
 811           Allow df, du, and ls to have human readable output.
 812
 813 comment "Common options for md5sum, sha1sum"
 814         depends on MD5SUM || SHA1SUM
 815
 816 config FEATURE_MD5_SHA1_SUM_CHECK
 817         bool "Enable -c, -s and -w options"
 818         default n
 819         depends on MD5SUM || SHA1SUM
 820         help
 821           Enabling the -c options allows files to be checked
 822           against pre-calculated hash values.
 823
 824           -s and -w are useful options when verifying checksums.
 825
 826 endmenu