Merge branch 'master' of git+ssh://vda@busybox.net/var/lib/git/busybox
[oweals/busybox.git] / shell / Config.in
index fd73b156e99ce3943f2208bbaab94a250df93d29..57969f02cdf00f054573a2508ac64becdcb78264 100644 (file)
@@ -7,282 +7,354 @@ menu "Shells"
 
 choice
        prompt "Choose your default shell"
-       default CONFIG_FEATURE_SH_IS_NONE
+       default FEATURE_SH_IS_NONE
        help
          Choose a shell. The ash shell is the most bash compatible
          and full featured one.
 
-config CONFIG_FEATURE_SH_IS_ASH
-       select CONFIG_ASH
+config FEATURE_SH_IS_ASH
+       select ASH
        bool "ash"
 
-config CONFIG_FEATURE_SH_IS_HUSH
-       select CONFIG_HUSH
+config FEATURE_SH_IS_HUSH
+       select HUSH
        bool "hush"
 
-config CONFIG_FEATURE_SH_IS_LASH
-       select CONFIG_LASH
-       bool "lash"
+####config FEATURE_SH_IS_LASH
+####   select LASH
+####   bool "lash"
 
-config CONFIG_FEATURE_SH_IS_MSH
-       select CONFIG_MSH
+config FEATURE_SH_IS_MSH
+       select MSH
        bool "msh"
 
-config CONFIG_FEATURE_SH_IS_NONE
+config FEATURE_SH_IS_NONE
        bool "none"
 
 endchoice
 
-config CONFIG_ASH
+config ASH
        bool "ash"
        default n
-       select CONFIG_TEST
        help
          Tha 'ash' shell adds about 60k in the default configuration and is
          the most complete and most pedantically correct shell included with
-         busybox.  This shell is actually a derivative of the Debian 'dash'
+         busybox. This shell is actually a derivative of the Debian 'dash'
          shell (by Herbert Xu), which was created by porting the 'ash' shell
          (written by Kenneth Almquist) from NetBSD.
 
 comment "Ash Shell Options"
-       depends on CONFIG_ASH
+       depends on ASH
 
-config CONFIG_ASH_JOB_CONTROL
-       bool "  Enable Job control"
+config ASH_BASH_COMPAT
+       bool "bash-compatible extensions"
        default y
-       depends on CONFIG_ASH
+       depends on ASH
+       help
+         Enable bash-compatible extensions.
+
+config ASH_JOB_CONTROL
+       bool "Job control"
+       default y
+       depends on ASH
        help
          Enable job control in the ash shell.
 
-config CONFIG_ASH_READ_NCHARS
-       bool "  Enable 'read -n N' and 'read -s' support"
+config ASH_READ_NCHARS
+       bool "'read -n N' and 'read -s' support"
        default n
-       depends on CONFIG_ASH
+       depends on ASH
        help
          'read -n N' will return a value after N characters have been read.
          'read -s' will read without echoing the user's input.
 
-config CONFIG_ASH_READ_TIMEOUT
-       bool "  Enable 'read -t S' support."
+config ASH_READ_TIMEOUT
+       bool "'read -t S' support"
        default n
-       depends on CONFIG_ASH
+       depends on ASH
        help
          'read -t S' will return a value after S seconds have passed.
          This implementation will allow fractional seconds, expressed
          as a decimal fraction, e.g. 'read -t 2.5 foo'.
 
-config CONFIG_ASH_ALIAS
-       bool "  Enable alias support"
+config ASH_ALIAS
+       bool "alias support"
        default y
-       depends on CONFIG_ASH
+       depends on ASH
        help
          Enable alias support in the ash shell.
 
-config CONFIG_ASH_MATH_SUPPORT
-       bool "  Enable Posix math support"
+config ASH_GETOPTS
+       bool "Builtin getopt to parse positional parameters"
+       default n
+       depends on ASH
+       help
+         Enable getopts builtin in the ash shell.
+
+config ASH_BUILTIN_ECHO
+       bool "Builtin version of 'echo'"
        default y
-       depends on CONFIG_ASH
+       depends on ASH
        help
-         Enable math support in the ash shell.
+         Enable support for echo, builtin to ash.
 
-config CONFIG_ASH_MATH_SUPPORT_64
-       bool "    Extend Posix math support to 64 bit"
-       default n
-       depends on CONFIG_ASH_MATH_SUPPORT
+config ASH_BUILTIN_PRINTF
+       bool "Builtin version of 'printf'"
+       default y
+       depends on ASH
        help
-         Enable 64-bit math support in the ash shell.  This will make
-         the shell slightly larger, but will allow computation with very
-         large numbers.
+         Enable support for printf, builtin to ash.
 
-config CONFIG_ASH_GETOPTS
-       bool "  Enable getopts builtin to parse positional parameters"
-       default n
-       depends on CONFIG_ASH
+config ASH_BUILTIN_TEST
+       bool "Builtin version of 'test'"
+       default y
+       depends on ASH
        help
-         Enable getopts builtin in the ash shell.
+         Enable support for test, builtin to ash.
 
-config CONFIG_ASH_CMDCMD
-       bool "  Enable cmdcmd to override shell builtins"
+config ASH_CMDCMD
+       bool "'command' command to override shell builtins"
        default n
-       depends on CONFIG_ASH
+       depends on ASH
        help
          Enable support for the ash 'command' builtin, which allows
          you to run the specified command with the specified arguments,
          even when there is an ash builtin command with the same name.
 
-config CONFIG_ASH_BUILTIN_ECHO
-       bool "  Enable builtin version of 'echo'"
-       default n
-       depends on CONFIG_ASH
-       help
-         Enable support for echo, built in to ash.
-
-# this entry also appears in coreutils/Config.in, next to the echo applet
-config CONFIG_FEATURE_FANCY_ECHO
-       bool "  Enable echo options (-n and -e)"
+config ASH_MAIL
+       bool "Check for new mail on interactive shells"
        default y
-       depends on CONFIG_ASH_BUILTIN_ECHO
-       help
-         This adds options (-n and -e) to echo.
-
-config CONFIG_ASH_MAIL
-       bool "  Check for new mail on interactive shells"
-       default y
-       depends on CONFIG_ASH
+       depends on ASH
        help
          Enable "check for new mail" in the ash shell.
 
-config CONFIG_ASH_OPTIMIZE_FOR_SIZE
-       bool "  Optimize for size instead of speed"
+config ASH_OPTIMIZE_FOR_SIZE
+       bool "Optimize for size instead of speed"
        default y
-       depends on CONFIG_ASH
+       depends on ASH
        help
          Compile ash for reduced size at the price of speed.
 
-config CONFIG_ASH_RANDOM_SUPPORT
-       bool "  Enable pseudorandom generator and variable $RANDOM"
+config ASH_RANDOM_SUPPORT
+       bool "Pseudorandom generator and $RANDOM variable"
        default n
-       depends on CONFIG_ASH
+       depends on ASH
        help
          Enable pseudorandom generator and dynamic variable "$RANDOM".
          Each read of "$RANDOM" will generate a new pseudorandom value.
          You can reset the generator by using a specified start value.
-         After "unset RANDOM" then generator will switch off and this
+         After "unset RANDOM" the generator will switch off and this
          variable will no longer have special treatment.
 
-config CONFIG_ASH_EXPAND_PRMT
-       bool "  Expand prompt string"
+config ASH_EXPAND_PRMT
+       bool "Expand prompt string"
        default n
-       depends on CONFIG_ASH
+       depends on ASH
        help
-         "PS#" may be contain volatile content, such as backquote commands.
+         "PS#" may contain volatile content, such as backquote commands.
          This option recreates the prompt string from the environment
          variable each time it is displayed.
 
-config CONFIG_HUSH
+config HUSH
        bool "hush"
        default n
-       select CONFIG_TRUE
-       select CONFIG_FALSE
-       select CONFIG_TEST
        help
-         hush is a very small shell (just 18k) and it has fairly complete
-         Bourne shell grammar.  It even handles all the normal flow control
-         options such as if/then/elif/else/fi, for/in/do/done, while loops,
-         etc.
+         hush is a small shell (22k). It handles the normal flow control
+         constructs such as if/then/elif/else/fi, for/in/do/done, while loops,
+         case/esac. Redirections, here documents, $((arithmetic))
+         and functions are supported.
 
-         It does not handle case/esac, select, function, here documents ( <<
-         word ), arithmetic expansion, aliases, brace expansion, tilde
-         expansion, &> and >& redirection of stdout+stderr, etc.
+         It will compile and work on no-mmu systems.
 
+         It does not handle select, aliases, brace expansion,
+         tilde expansion, &>file and >&file redirection of stdout+stderr.
 
-config CONFIG_LASH
-       bool "lash"
+config HUSH_HELP
+       bool "help builtin"
        default n
-       select CONFIG_TRUE
-       select CONFIG_FALSE
-       select CONFIG_TEST
+       depends on HUSH
        help
-         lash is the very smallest shell (adds just 10k) and it is quite
-         usable as a command prompt, but it is not suitable for any but the
-         most trivial scripting (such as an initrd that calls insmod a few
-         times) since it does not understand any Bourne shell grammar.  It
-         does handle pipes, redirects, and job control though.  Adding in
-         command editing makes it a very nice lightweight command prompt.
+         Enable help builtin in hush. Code size + ~1 kbyte.
 
+config HUSH_INTERACTIVE
+       bool "Interactive mode"
+       default y
+       depends on HUSH
+       help
+         Enable interactive mode (prompt and command editing).
+         Without this, hush simply reads and executes commands
+         from stdin just like a shell script from the file.
+         No prompt, no PS1/PS2 magic shell variables.
 
-config CONFIG_MSH
-       bool "msh"
+config HUSH_JOB
+       bool "Job control"
+       default n
+       depends on HUSH_INTERACTIVE
+       help
+         Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
+         command (not entire shell), fg/bg builtins work. Without this option,
+         "cmd &" still works by simply spawning a process and immediately
+         prompting for next command (or executing next command in a script),
+         but no separate process group is formed.
+
+config HUSH_TICK
+       bool "Process substitution"
        default n
-       select CONFIG_TRUE
-       select CONFIG_FALSE
-       select CONFIG_TEST
+       depends on HUSH
        help
-         The minix shell (adds just 30k) is quite complete and handles things
-         like for/do/done, case/esac and all the things you expect a Bourne
-         shell to do.  It is not always pedantically correct about Bourne
-         shell grammar (try running the shell testscript "tests/sh.testcases"
-         on it and compare vs bash) but for most things it works quite well.
-         It also uses only vfork, so it can be used on uClinux systems.
+         Enable process substitution `command` and $(command) in hush.
 
-comment "Bourne Shell Options"
-       depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
+config HUSH_IF
+       bool "Support if/then/elif/else/fi"
+       default n
+       depends on HUSH
+       help
+         Enable if/then/elif/else/fi in hush.
 
-config CONFIG_FEATURE_SH_EXTRA_QUIET
-       bool "Hide message on interactive shell startup"
+config HUSH_LOOPS
+       bool "Support for, while and until loops"
        default n
-       depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
+       depends on HUSH
        help
-         Remove the busybox introduction when starting a shell.
+         Enable for, while and until loops in hush.
 
-config CONFIG_FEATURE_SH_STANDALONE_SHELL
-       bool "Standalone shell"
+config HUSH_CASE
+       bool "Support case ... esac statement"
        default n
-       depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
+       depends on HUSH
        help
-         This option causes the selected busybox shell to use busybox applets
-         in preference to executables in the PATH whenever possible.  For
-         example, entering the command 'ifconfig' into the shell would cause
-         busybox to use the ifconfig busybox applet.  Specifying the fully
-         qualified executable name, such as '/sbin/ifconfig' will still
-         execute the /sbin/ifconfig executable on the filesystem.  This option
-         is generally used when creating a statically linked version of busybox
-         for use as a rescue shell, in the event that you screw up your system.
+         Enable case ... esac statement in hush. +400 bytes.
 
-         Note that when using this option, the shell will attempt to directly
-         run '/bin/busybox'.  If you do not have the busybox binary sitting in
-         that exact location with that exact name, this option will not work at
-         all.
+config HUSH_FUNCTIONS
+       bool "Support funcname() { commands; } syntax"
+       default n
+       depends on HUSH
+       help
+         Enable support for shell functions in hush. +800 bytes.
 
-config CONFIG_FEATURE_COMMAND_EDITING
-       bool "command line editing"
+config HUSH_EXPORT_N
+       bool "Support export '-n' option"
        default n
-       depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
+       depends on HUSH
        help
-         Enable command editing in shell.
+         Enable support for export '-n' option in hush. It is a bash extension.
 
-config CONFIG_FEATURE_COMMAND_EDITING_VI
-       bool "vi-style line editing commands"
+config LASH
+       bool "lash (deprecated: aliased to hush)"
        default n
-       depends on CONFIG_FEATURE_COMMAND_EDITING
+       select HUSH
        help
-         Enable vi-style line editing in the shell.  This mode can be
-         turned on and off with "set -o vi" and "set +o vi".
+         lash is deprecated and will be removed, please migrate to hush.
 
-config CONFIG_FEATURE_COMMAND_HISTORY
-       int "history size"
-       default 15
-       depends on CONFIG_FEATURE_COMMAND_EDITING
+config MSH
+       bool "msh (deprecated: please use hush)"
+       default n
        help
-         Specify command history size in shell.
+         msh is deprecated and will be removed, please migrate to hush.
+         If there is a feature msh has but hush does not, please let us know.
+
+#        The minix shell (adds just 30k) is quite complete and handles things
+#        like for/do/done, case/esac and all the things you expect a Bourne
+#        shell to do. It is not always pedantically correct about Bourne
+#        shell grammar (try running the shell testscript "tests/sh.testcases"
+#        on it and compare vs bash) but for most things it works quite well.
+#        It uses only vfork, so it can be used on uClinux systems.
+
 
-config CONFIG_FEATURE_COMMAND_SAVEHISTORY
-       bool "history saving"
+comment "Bourne Shell Options"
+       depends on MSH || LASH || HUSH || ASH
+
+config SH_MATH_SUPPORT
+       bool "POSIX math support"
+       default y
+       depends on ASH || HUSH
+       help
+         Enable math support in the shell via $((...)) syntax.
+
+config SH_MATH_SUPPORT_64
+       bool "Extend POSIX math support to 64 bit"
        default n
-       depends on CONFIG_ASH && CONFIG_FEATURE_COMMAND_EDITING
+       depends on SH_MATH_SUPPORT
        help
-         Enable history saving in ash shell.
+         Enable 64-bit math support in the shell. This will make the shell
+         slightly larger, but will allow computation with very large numbers.
+         This is not in POSIX, so do not rely on this in portable code.
 
-config CONFIG_FEATURE_COMMAND_TAB_COMPLETION
-       bool "tab completion"
+config FEATURE_SH_EXTRA_QUIET
+       bool "Hide message on interactive shell startup"
        default n
-       depends on CONFIG_FEATURE_COMMAND_EDITING
+       depends on MSH || LASH || HUSH || ASH
        help
-         Enable tab completion in shell.
+         Remove the busybox introduction when starting a shell.
 
-config CONFIG_FEATURE_COMMAND_USERNAME_COMPLETION
-       bool "username completion"
+config FEATURE_SH_STANDALONE
+       bool "Standalone shell"
+       default n
+       depends on (MSH || LASH || HUSH || ASH) && FEATURE_PREFER_APPLETS
+       help
+         This option causes busybox shells to use busybox applets
+         in preference to executables in the PATH whenever possible. For
+         example, entering the command 'ifconfig' into the shell would cause
+         busybox to use the ifconfig busybox applet. Specifying the fully
+         qualified executable name, such as '/sbin/ifconfig' will still
+         execute the /sbin/ifconfig executable on the filesystem. This option
+         is generally used when creating a statically linked version of busybox
+         for use as a rescue shell, in the event that you screw up your system.
+
+         This is implemented by re-execing /proc/self/exe (typically)
+         with right parameters. Some selected applets ("NOFORK" applets)
+         can even be executed without creating new process.
+         Instead, busybox will call <applet>_main() internally.
+
+         However, this causes problems in chroot jails without mounted /proc
+         and with ps/top (command name can be shown as 'exe' for applets
+         started this way).
+# untrue?
+#        Note that this will *also* cause applets to take precedence
+#        over shell builtins of the same name. So turning this on will
+#        eliminate any performance gained by turning on the builtin "echo"
+#        and "test" commands in ash.
+# untrue?
+#        Note that when using this option, the shell will attempt to directly
+#        run '/bin/busybox'. If you do not have the busybox binary sitting in
+#        that exact location with that exact name, this option will not work at
+#        all.
+
+config FEATURE_SH_NOFORK
+       bool "Run 'nofork' applets directly"
        default n
-       depends on CONFIG_FEATURE_COMMAND_TAB_COMPLETION
+       depends on (MSH || LASH || HUSH || ASH) && FEATURE_PREFER_APPLETS
        help
-         Enable username completion in shell.
+         This option causes busybox shells [currently only ash]
+         to not execute typical fork/exec/wait sequence, but call <applet>_main
+         directly, if possible. (Sometimes it is not possible: for example,
+         this is not possible in pipes).
+
+         This will be done only for some applets (those which are marked
+         NOFORK in include/applets.h).
+
+         This may significantly speed up some shell scripts.
+
+         This feature is relatively new. Use with care.
 
-config CONFIG_FEATURE_SH_FANCY_PROMPT
-       bool "Fancy shell prompts"
+config CTTYHACK
+       bool "cttyhack"
        default n
-       depends on CONFIG_FEATURE_COMMAND_EDITING
        help
-         Setting this option allows for prompts to use things like \w and
-         \$ and also using escape codes.
+         One common problem reported on the mailing list is "can't access tty;
+         job control turned off" error message which typically appears when
+         one tries to use shell with stdin/stdout opened to /dev/console.
+         This device is special - it cannot be a controlling tty.
+
+         Proper solution is to use correct device instead of /dev/console.
+
+         cttyhack provides "quick and dirty" solution to this problem.
+         It analyzes stdin with various ioctls, trying to determine whether
+         it is a /dev/ttyN or /dev/ttySN (virtual terminal or serial line).
+         If it detects one, it closes stdin/out/err and reopens that device.
+         Then it executes given program. Usage example for /etc/inittab
+         (for busybox init):
+
+         ::respawn:/bin/cttyhack /bin/sh
 
 endmenu