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