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