[package] firewall: clean up description (#7875)

[openwrt.git] / package / busybox / config / shell / Config.in

diff --git a/package/busybox/config/shell/Config.in b/package/busybox/config/shell/Config.in
index 4107e12..d652dd3 100644 (file)
--- a/package/busybox/config/shell/Config.in
+++ b/package/busybox/config/shell/Config.in
@@ -5,37 +5,12 @@
 
 menu "Shells"
 
 
 menu "Shells"
 

-choice
-       prompt "Choose your default shell"
-       default BUSYBOX_CONFIG_FEATURE_SH_IS_ASH
-       help
-         Choose a shell. The ash shell is the most bash compatible
-         and full featured one.
-
-config BUSYBOX_CONFIG_FEATURE_SH_IS_ASH
-       select BUSYBOX_CONFIG_ASH
-       bool "ash"
-
-config BUSYBOX_CONFIG_FEATURE_SH_IS_HUSH
-       select BUSYBOX_CONFIG_HUSH
-       bool "hush"
-
-####config FEATURE_SH_IS_LASH
-####   select LASH
-####   bool "lash"
-
-config BUSYBOX_CONFIG_FEATURE_SH_IS_MSH
-       select BUSYBOX_CONFIG_MSH
-       bool "msh"
-
-config BUSYBOX_CONFIG_FEATURE_SH_IS_NONE
-       bool "none"

 
 

-endchoice

 
 config BUSYBOX_CONFIG_ASH
        bool "ash"
        default y
 
 config BUSYBOX_CONFIG_ASH
        bool "ash"
        default y

+       depends on !BUSYBOX_CONFIG_NOMMU

        help
          Tha 'ash' shell adds about 60k in the default configuration and is
          the most complete and most pedantically correct shell included with
        help
          Tha 'ash' shell adds about 60k in the default configuration and is
          the most complete and most pedantically correct shell included with


@@ -43,9 +18,6 @@ config BUSYBOX_CONFIG_ASH
          shell (by Herbert Xu), which was created by porting the 'ash' shell
          (written by Kenneth Almquist) from NetBSD.
 
          shell (by Herbert Xu), which was created by porting the 'ash' shell
          (written by Kenneth Almquist) from NetBSD.
 

-comment "Ash Shell Options"
-       depends on BUSYBOX_CONFIG_ASH
-

 config BUSYBOX_CONFIG_ASH_BASH_COMPAT
        bool "bash-compatible extensions"
        default y
 config BUSYBOX_CONFIG_ASH_BASH_COMPAT
        bool "bash-compatible extensions"
        default y


@@ -60,23 +32,6 @@ config BUSYBOX_CONFIG_ASH_JOB_CONTROL
        help
          Enable job control in the ash shell.
 
        help
          Enable job control in the ash shell.
 

-config BUSYBOX_CONFIG_ASH_READ_NCHARS
-       bool "'read -n N' and 'read -s' support"
-       default n
-       depends on BUSYBOX_CONFIG_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 BUSYBOX_CONFIG_ASH_READ_TIMEOUT
-       bool "'read -t S' support"
-       default y
-       depends on BUSYBOX_CONFIG_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 BUSYBOX_CONFIG_ASH_ALIAS
        bool "alias support"
        default y
 config BUSYBOX_CONFIG_ASH_ALIAS
        bool "alias support"
        default y


@@ -84,22 +39,6 @@ config BUSYBOX_CONFIG_ASH_ALIAS
        help
          Enable alias support in the ash shell.
 
        help
          Enable alias support in the ash shell.
 

-config BUSYBOX_CONFIG_ASH_MATH_SUPPORT
-       bool "Posix math support"
-       default y
-       depends on BUSYBOX_CONFIG_ASH
-       help
-         Enable math support in the ash shell.
-
-config BUSYBOX_CONFIG_ASH_MATH_SUPPORT_64
-       bool "Extend Posix math support to 64 bit"
-       default y
-       depends on BUSYBOX_CONFIG_ASH_MATH_SUPPORT
-       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.
-

 config BUSYBOX_CONFIG_ASH_GETOPTS
        bool "Builtin getopt to parse positional parameters"
        default y
 config BUSYBOX_CONFIG_ASH_GETOPTS
        bool "Builtin getopt to parse positional parameters"
        default y


@@ -152,14 +91,14 @@ config BUSYBOX_CONFIG_ASH_OPTIMIZE_FOR_SIZE
          Compile ash for reduced size at the price of speed.
 
 config BUSYBOX_CONFIG_ASH_RANDOM_SUPPORT
          Compile ash for reduced size at the price of speed.
 
 config BUSYBOX_CONFIG_ASH_RANDOM_SUPPORT

-       bool "Pseudorandom generator and variable $RANDOM"
+       bool "Pseudorandom generator and $RANDOM variable"

        default n
        depends on BUSYBOX_CONFIG_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.
        default n
        depends on BUSYBOX_CONFIG_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 BUSYBOX_CONFIG_ASH_EXPAND_PRMT
          variable will no longer have special treatment.
 
 config BUSYBOX_CONFIG_ASH_EXPAND_PRMT


@@ -167,7 +106,7 @@ config BUSYBOX_CONFIG_ASH_EXPAND_PRMT
        default y
        depends on BUSYBOX_CONFIG_ASH
        help
        default y
        depends on BUSYBOX_CONFIG_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.
 
          This option recreates the prompt string from the environment
          variable each time it is displayed.
 


@@ -175,37 +114,43 @@ config BUSYBOX_CONFIG_HUSH
        bool "hush"
        default n
        help
        bool "hush"
        default n
        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,
-         case/esac.
+         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 uses only vfork, so it can be used on uClinux systems.
+         It will compile and work on no-mmu systems.

 
 

-         It does not handle select, functions, here documents ( <<
-         word ), arithmetic expansion, aliases, brace expansion, tilde
-         expansion, &> and >& redirection of stdout+stderr, etc.
+         It does not handle select, aliases, brace expansion,
+         tilde expansion, &>file and >&file redirection of stdout+stderr.
+
+config BUSYBOX_CONFIG_HUSH_BASH_COMPAT
+       bool "bash-compatible extensions"
+       default y
+       depends on BUSYBOX_CONFIG_HUSH
+       help
+         Enable bash-compatible extensions.

 
 config BUSYBOX_CONFIG_HUSH_HELP
        bool "help builtin"
 
 config BUSYBOX_CONFIG_HUSH_HELP
        bool "help builtin"

-       default n
+       default y

        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable help builtin in hush. Code size + ~1 kbyte.
 
 config BUSYBOX_CONFIG_HUSH_INTERACTIVE
        bool "Interactive mode"
        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable help builtin in hush. Code size + ~1 kbyte.
 
 config BUSYBOX_CONFIG_HUSH_INTERACTIVE
        bool "Interactive mode"

-       default n
+       default y

        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable interactive mode (prompt and command editing).
          Without this, hush simply reads and executes commands
        depends on BUSYBOX_CONFIG_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.
+         from stdin just like a shell script from a file.

          No prompt, no PS1/PS2 magic shell variables.
 
 config BUSYBOX_CONFIG_HUSH_JOB
        bool "Job control"
          No prompt, no PS1/PS2 magic shell variables.
 
 config BUSYBOX_CONFIG_HUSH_JOB
        bool "Job control"

-       default n
+       default y

        depends on BUSYBOX_CONFIG_HUSH_INTERACTIVE
        help
          Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
        depends on BUSYBOX_CONFIG_HUSH_INTERACTIVE
        help
          Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current


@@ -216,65 +161,166 @@ config BUSYBOX_CONFIG_HUSH_JOB
 
 config BUSYBOX_CONFIG_HUSH_TICK
        bool "Process substitution"
 
 config BUSYBOX_CONFIG_HUSH_TICK
        bool "Process substitution"

-       default n
+       default y

        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable process substitution `command` and $(command) in hush.
 
 config BUSYBOX_CONFIG_HUSH_IF
        bool "Support if/then/elif/else/fi"
        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable process substitution `command` and $(command) in hush.
 
 config BUSYBOX_CONFIG_HUSH_IF
        bool "Support if/then/elif/else/fi"

-       default n
+       default y

        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable if/then/elif/else/fi in hush.
 
 config BUSYBOX_CONFIG_HUSH_LOOPS
        bool "Support for, while and until loops"
        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable if/then/elif/else/fi in hush.
 
 config BUSYBOX_CONFIG_HUSH_LOOPS
        bool "Support for, while and until loops"

-       default n
+       default y

        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable for, while and until loops in hush.
        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable for, while and until loops in hush.

-         As of 2008-07, break and continue statements are not supported.

 
 config BUSYBOX_CONFIG_HUSH_CASE
        bool "Support case ... esac statement"
 
 config BUSYBOX_CONFIG_HUSH_CASE
        bool "Support case ... esac statement"

-       default n
+       default y

        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable case ... esac statement in hush. +400 bytes.
 
        depends on BUSYBOX_CONFIG_HUSH
        help
          Enable case ... esac statement in hush. +400 bytes.
 

+config BUSYBOX_CONFIG_HUSH_FUNCTIONS
+       bool "Support funcname() { commands; } syntax"
+       default y
+       depends on BUSYBOX_CONFIG_HUSH
+       help
+         Enable support for shell functions in hush. +800 bytes.
+
+config BUSYBOX_CONFIG_HUSH_LOCAL
+       bool "Support local builtin"
+       default y
+       depends on BUSYBOX_CONFIG_HUSH_FUNCTIONS
+       help
+         Enable support for local variables in functions.
+
+config BUSYBOX_CONFIG_HUSH_EXPORT_N
+       bool "Support export '-n' option"
+       default y
+       depends on BUSYBOX_CONFIG_HUSH
+       help
+         Enable support for export '-n' option in hush. It is a bash extension.
+
+config BUSYBOX_CONFIG_HUSH_RANDOM_SUPPORT
+       bool "Pseudorandom generator and $RANDOM variable"
+       default n
+       depends on BUSYBOX_CONFIG_HUSH
+       help
+         Enable pseudorandom generator and dynamic variable "$RANDOM".
+         Each read of "$RANDOM" will generate a new pseudorandom value.
+
+
+choice
+       prompt "Choose which shell is aliased to 'sh' name"
+       default BUSYBOX_CONFIG_FEATURE_SH_IS_ASH
+       help
+         Choose which shell you want to be executed by 'sh' alias.
+         The ash shell is the most bash compatible and full featured one.
+
+# note: cannot use "select ASH" here, it breaks "make allnoconfig"
+config BUSYBOX_CONFIG_FEATURE_SH_IS_ASH
+       depends on BUSYBOX_CONFIG_ASH
+       bool "ash"
+       depends on !BUSYBOX_CONFIG_NOMMU
+
+config BUSYBOX_CONFIG_FEATURE_SH_IS_HUSH
+       depends on BUSYBOX_CONFIG_HUSH
+       bool "hush"
+
+config BUSYBOX_CONFIG_FEATURE_SH_IS_NONE
+       bool "none"
+
+endchoice
+
+choice
+       prompt "Choose which shell is aliased to 'bash' name"
+       default BUSYBOX_CONFIG_FEATURE_BASH_IS_NONE
+       help
+         Choose which shell you want to be executed by 'bash' alias.
+         The ash shell is the most bash compatible and full featured one.
+
+         Note that selecting this option does not switch on any bash
+         compatibility code. It merely makes it possible to install
+         /bin/bash (sym)link and run scripts which start with
+         #!/bin/bash line.
+
+         Many systems use it in scripts which use bash-specific features,
+         even simple ones like $RANDOM. Without this option, busybox
+         can't be used for running them because it won't recongnize
+         "bash" as a supported applet name.
+
+config BUSYBOX_CONFIG_FEATURE_BASH_IS_ASH
+       depends on BUSYBOX_CONFIG_ASH
+       bool "ash"
+       depends on !BUSYBOX_CONFIG_NOMMU
+
+config BUSYBOX_CONFIG_FEATURE_BASH_IS_HUSH
+       depends on BUSYBOX_CONFIG_HUSH
+       bool "hush"
+
+config BUSYBOX_CONFIG_FEATURE_BASH_IS_NONE
+       bool "none"
+
+endchoice
+
+

 config BUSYBOX_CONFIG_LASH
 config BUSYBOX_CONFIG_LASH

-       bool "lash"
+       bool "lash (deprecated: aliased to hush)"

        default n
        select BUSYBOX_CONFIG_HUSH
        help
          lash is deprecated and will be removed, please migrate to hush.
 
 config BUSYBOX_CONFIG_MSH
        default n
        select BUSYBOX_CONFIG_HUSH
        help
          lash is deprecated and will be removed, please migrate to hush.
 
 config BUSYBOX_CONFIG_MSH

-       bool "msh"
+       bool "msh (deprecated: please use hush)"

        default n
        default n

+       select BUSYBOX_CONFIG_HUSH
+       help
+         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 BUSYBOX_CONFIG_SH_MATH_SUPPORT
+       bool "POSIX math support"
+       default y
+       depends on BUSYBOX_CONFIG_ASH || BUSYBOX_CONFIG_HUSH

        help
        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 uses only vfork, so it can be used on uClinux systems.
+         Enable math support in the shell via $((...)) syntax.

 
 

-comment "Bourne Shell Options"
-       depends on BUSYBOX_CONFIG_MSH || BUSYBOX_CONFIG_LASH || BUSYBOX_CONFIG_HUSH || BUSYBOX_CONFIG_ASH
+config BUSYBOX_CONFIG_SH_MATH_SUPPORT_64
+       bool "Extend POSIX math support to 64 bit"
+       default y
+       depends on BUSYBOX_CONFIG_SH_MATH_SUPPORT
+       help
+         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 BUSYBOX_CONFIG_FEATURE_SH_EXTRA_QUIET
        bool "Hide message on interactive shell startup"
        default n
 
 config BUSYBOX_CONFIG_FEATURE_SH_EXTRA_QUIET
        bool "Hide message on interactive shell startup"
        default n

-       depends on BUSYBOX_CONFIG_MSH || BUSYBOX_CONFIG_LASH || BUSYBOX_CONFIG_HUSH || BUSYBOX_CONFIG_ASH
+       depends on BUSYBOX_CONFIG_HUSH || BUSYBOX_CONFIG_ASH

        help
          Remove the busybox introduction when starting a shell.
 
 config BUSYBOX_CONFIG_FEATURE_SH_STANDALONE
        bool "Standalone shell"
        default n
        help
          Remove the busybox introduction when starting a shell.
 
 config BUSYBOX_CONFIG_FEATURE_SH_STANDALONE
        bool "Standalone shell"
        default n

-       depends on (BUSYBOX_CONFIG_MSH || BUSYBOX_CONFIG_LASH || BUSYBOX_CONFIG_HUSH || BUSYBOX_CONFIG_ASH) && BUSYBOX_CONFIG_FEATURE_PREFER_APPLETS
+       depends on (BUSYBOX_CONFIG_HUSH || BUSYBOX_CONFIG_ASH) && BUSYBOX_CONFIG_FEATURE_PREFER_APPLETS

        help
          This option causes busybox shells to use busybox applets
          in preference to executables in the PATH whenever possible. For
        help
          This option causes busybox shells to use busybox applets
          in preference to executables in the PATH whenever possible. For


@@ -307,7 +353,7 @@ config BUSYBOX_CONFIG_FEATURE_SH_STANDALONE
 config BUSYBOX_CONFIG_FEATURE_SH_NOFORK
        bool "Run 'nofork' applets directly"
        default n
 config BUSYBOX_CONFIG_FEATURE_SH_NOFORK
        bool "Run 'nofork' applets directly"
        default n

-       depends on (BUSYBOX_CONFIG_MSH || BUSYBOX_CONFIG_LASH || BUSYBOX_CONFIG_HUSH || BUSYBOX_CONFIG_ASH) && BUSYBOX_CONFIG_FEATURE_PREFER_APPLETS
+       depends on (BUSYBOX_CONFIG_HUSH || BUSYBOX_CONFIG_ASH) && BUSYBOX_CONFIG_FEATURE_PREFER_APPLETS

        help
          This option causes busybox shells [currently only ash]
          to not execute typical fork/exec/wait sequence, but call <applet>_main
        help
          This option causes busybox shells [currently only ash]
          to not execute typical fork/exec/wait sequence, but call <applet>_main


@@ -336,9 +382,20 @@ config BUSYBOX_CONFIG_CTTYHACK
          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.
          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):
+         Then it executes given program. Opening the device will make
+         that device a controlling tty. This may require cttyhack
+         to be a session leader.
+
+         Example for /etc/inittab (for busybox init):

 
          ::respawn:/bin/cttyhack /bin/sh
 
 
          ::respawn:/bin/cttyhack /bin/sh
 

+         Giving controlling tty to shell running with PID 1:
+
+         $ exec cttyhack sh
+
+         Starting an interactive shell from boot shell script:
+
+         setsid cttyhack sh
+

 endmenu
 endmenu