Cut-n-paste strikes again
[oweals/busybox.git] / shell / Config.in
index b643c8f3d3fbb2fd5edadc46f038c29c7e7559c3..bdba40d3b24dbf911fb4d28eb7e4dde0c53cb25a 100644 (file)
@@ -7,20 +7,25 @@ menu "Another Bourne-like Shell"
 
 choice
        prompt "Choose your default shell"
-       default "none"
+       default CONFIG_FEATURE_SH_IS_NONE
        help
-         Please submit a patch to add help text for this item.
+         Choose a shell. The ash shell is the most bash compatible
+         and full featured one.
 
 config CONFIG_FEATURE_SH_IS_ASH
+       select CONFIG_ASH
        bool "ash"
 
 config CONFIG_FEATURE_SH_IS_HUSH
+       select CONFIG_HUSH
        bool "hush"
 
 config CONFIG_FEATURE_SH_IS_LASH
+       select CONFIG_LASH
        bool "lash"
 
 config CONFIG_FEATURE_SH_IS_MSH
+       select CONFIG_MSH
        bool "msh"
 
 config CONFIG_FEATURE_SH_IS_NONE
@@ -28,20 +33,15 @@ config CONFIG_FEATURE_SH_IS_NONE
 
 endchoice
 
-if CONFIG_FEATURE_SH_IS_ASH
-       config CONFIG_ASH
-       default y
-
-       comment "ash (forced enabled as default shell)"
-endif
-       
-if !CONFIG_FEATURE_SH_IS_ASH
 config CONFIG_ASH
        bool "ash"
        default y
        help
-         Please submit a patch to add help text for this item.
-endif
+         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'
+         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
@@ -51,162 +51,179 @@ config CONFIG_ASH_JOB_CONTROL
        default y
        depends on CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         Enable job control in the ash shell.
 
 config CONFIG_ASH_ALIAS
        bool "  Enable alias support"
        default y
        depends on CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         Enable alias support in the ash shell.
 
 config CONFIG_ASH_MATH_SUPPORT
        bool "  Enable Posix math support"
        default y
        depends on CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         Enable math support in the ash shell.
+
+config CONFIG_ASH_MATH_SUPPORT_64
+       bool "    Extend Posix math support to 64 bit"
+       default n
+       depends on 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 CONFIG_ASH_GETOPTS
-       bool "  Enable getopt builtin to parse positional parameters"
+       bool "  Enable getopts builtin to parse positional parameters"
        default n
        depends on CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         Enable getopts builtin in the ash shell.
 
 config CONFIG_ASH_CMDCMD
        bool "  Enable cmdcmd to override shell builtins"
        default n
        depends on CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         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_MAIL
        bool "  Check for new mail on interactive shells"
        default y
        depends on CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         Enable "check for new mail" in the ash shell.
 
 config CONFIG_ASH_OPTIMIZE_FOR_SIZE
        bool "  Optimize for size instead of speed"
        default y
        depends on CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
-
+         Compile ash for reduced size at price of speed.
 
-if CONFIG_FEATURE_SH_IS_HUSH
-       config CONFIG_HUSH
-       default y
+config CONFIG_ASH_RANDOM_SUPPORT
+       bool "  Enable pseudorandom generator and variable $RANDOM"
+       default n
+       depends on 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
+         variable will no longer have special treatment.
 
-       comment "hush (forced enabled as default shell)"
-endif
-       
-if !CONFIG_FEATURE_SH_IS_HUSH
 config CONFIG_HUSH
        bool "hush"
        default n
        help
-         Please submit a patch to add help text for this item.
-endif
+         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.
 
-if CONFIG_FEATURE_SH_IS_LASH
-       config CONFIG_LASH
-       default y
+         It does not handle case/esac, select, function, here documents ( <<
+         word ), arithmetic expansion, aliases, brace expansion, tilde
+         expansion, &> and >& redirection of stdout+stderr, etc.
 
-       comment "lash (forced enabled as default shell)"
-endif
 
-if !CONFIG_FEATURE_SH_IS_LASH
 config CONFIG_LASH
        bool "lash"
        default n
        help
-         Please submit a patch to add help text for this item.
-endif
-
-if CONFIG_FEATURE_SH_IS_MSH
-       config CONFIG_MSH
-       default y
+         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.
 
-       comment "msh (forced enabled as default shell)"
-endif
 
-if !CONFIG_FEATURE_SH_IS_MSH
 config CONFIG_MSH
        bool "msh"
        default n
        help
-         Please submit a patch to add help text for this item.
-endif
-
+         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.
 
 comment "Bourne Shell Options"
        depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
 
-config CONFIG_FEATURE_COMMAND_EDITING
-       bool "command line editing"
+config CONFIG_FEATURE_SH_EXTRA_QUIET
+       bool "Hide message on interactive shell startup"
        default n
        depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         Remove the busybox introduction when starting a shell.
 
-config CONFIG_FEATURE_COMMAND_SAVEHISTORY
-       bool "  history saving"
-       default n
-       depends on CONFIG_ASH
-       help
-         Please submit a patch to add help text for this item.
-
-config CONFIG_FEATURE_COMMAND_TAB_COMPLETION
-       bool "tab completion"
+config CONFIG_FEATURE_SH_STANDALONE_SHELL
+       bool "Standalone shell"
        default n
        depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         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 staticly linked version of busybox
+         for use as a rescue shell, in the event that you screw up your system.
 
-config CONFIG_FEATURE_COMMAND_USERNAME_COMPLETION
-       bool "username completion"
+         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 CONFIG_FEATURE_COMMAND_EDITING
+       bool "command line editing"
        default n
        depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         Enable command editing in shell.
 
 config CONFIG_FEATURE_COMMAND_HISTORY
        int "history size"
        default 15
-       depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
+       depends on CONFIG_FEATURE_COMMAND_EDITING
        help
-         Please submit a patch to add help text for this item.
+         Specify command history size in shell.
 
-config CONFIG_FEATURE_SH_STANDALONE_SHELL
-       bool "Standalone shell"
+config CONFIG_FEATURE_COMMAND_SAVEHISTORY
+       bool "history saving"
        default n
-       depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
+       depends on CONFIG_ASH && CONFIG_FEATURE_COMMAND_EDITING
        help
-         Please submit a patch to add help text for this item.
+         Enable history saving in ash shell.
 
-config CONFIG_FEATURE_SH_APPLETS_ALWAYS_WIN
-       bool "Standalone shell -- applets always win"
+config CONFIG_FEATURE_COMMAND_TAB_COMPLETION
+       bool "tab completion"
        default n
-       depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
+       depends on CONFIG_FEATURE_COMMAND_EDITING
        help
-         Please submit a patch to add help text for this item.
+         Enable tab completion in shell.
 
-config CONFIG_FEATURE_SH_FANCY_PROMPT
-       bool "Fancy shell prompts"
+config CONFIG_FEATURE_COMMAND_USERNAME_COMPLETION
+       bool "username completion"
        default n
-       depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
+       depends on CONFIG_FEATURE_COMMAND_TAB_COMPLETION
        help
-         Please submit a patch to add help text for this item.
+         Enable username completion in shell.
 
-config CONFIG_FEATURE_SH_EXTRA_QUIET
-       bool "Hide message on interactive shell startup"
+config CONFIG_FEATURE_SH_FANCY_PROMPT
+       bool "Fancy shell prompts"
        default n
-       depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
+       depends on CONFIG_FEATURE_COMMAND_EDITING
        help
-         Please submit a patch to add help text for this item.
+         Setting this option allows for prompts to use things like \w and
+         \$ and also using escape codes.
 
 endmenu
-