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