fix #>&- syntax for closing fds
[oweals/busybox.git] / shell / 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 "Shells"
7
8 choice
9         prompt "Choose your default shell"
10         default FEATURE_SH_IS_NONE
11         help
12           Choose a shell. The ash shell is the most bash compatible
13           and full featured one.
14
15 config FEATURE_SH_IS_ASH
16         select ASH
17         bool "ash"
18
19 config FEATURE_SH_IS_HUSH
20         select HUSH
21         bool "hush"
22
23 ####config FEATURE_SH_IS_LASH
24 ####    select LASH
25 ####    bool "lash"
26
27 config FEATURE_SH_IS_MSH
28         select MSH
29         bool "msh"
30
31 config FEATURE_SH_IS_NONE
32         bool "none"
33
34 endchoice
35
36 config ASH
37         bool "ash"
38         default n
39         help
40           Tha 'ash' shell adds about 60k in the default configuration and is
41           the most complete and most pedantically correct shell included with
42           busybox. This shell is actually a derivative of the Debian 'dash'
43           shell (by Herbert Xu), which was created by porting the 'ash' shell
44           (written by Kenneth Almquist) from NetBSD.
45
46 comment "Ash Shell Options"
47         depends on ASH
48
49 config ASH_BASH_COMPAT
50         bool "bash-compatible extensions"
51         default y
52         depends on ASH
53         help
54           Enable bash-compatible extensions.
55
56 config ASH_JOB_CONTROL
57         bool "Job control"
58         default y
59         depends on ASH
60         help
61           Enable job control in the ash shell.
62
63 config ASH_READ_NCHARS
64         bool "'read -n N' and 'read -s' support"
65         default n
66         depends on ASH
67         help
68           'read -n N' will return a value after N characters have been read.
69           'read -s' will read without echoing the user's input.
70
71 config ASH_READ_TIMEOUT
72         bool "'read -t S' support"
73         default n
74         depends on ASH
75         help
76           'read -t S' will return a value after S seconds have passed.
77           This implementation will allow fractional seconds, expressed
78           as a decimal fraction, e.g. 'read -t 2.5 foo'.
79
80 config ASH_ALIAS
81         bool "alias support"
82         default y
83         depends on ASH
84         help
85           Enable alias support in the ash shell.
86
87 config ASH_GETOPTS
88         bool "Builtin getopt to parse positional parameters"
89         default n
90         depends on ASH
91         help
92           Enable getopts builtin in the ash shell.
93
94 config ASH_BUILTIN_ECHO
95         bool "Builtin version of 'echo'"
96         default y
97         depends on ASH
98         help
99           Enable support for echo, builtin to ash.
100
101 config ASH_BUILTIN_PRINTF
102         bool "Builtin version of 'printf'"
103         default y
104         depends on ASH
105         help
106           Enable support for printf, builtin to ash.
107
108 config ASH_BUILTIN_TEST
109         bool "Builtin version of 'test'"
110         default y
111         depends on ASH
112         help
113           Enable support for test, builtin to ash.
114
115 config ASH_CMDCMD
116         bool "'command' command to override shell builtins"
117         default n
118         depends on ASH
119         help
120           Enable support for the ash 'command' builtin, which allows
121           you to run the specified command with the specified arguments,
122           even when there is an ash builtin command with the same name.
123
124 config ASH_MAIL
125         bool "Check for new mail on interactive shells"
126         default y
127         depends on ASH
128         help
129           Enable "check for new mail" in the ash shell.
130
131 config ASH_OPTIMIZE_FOR_SIZE
132         bool "Optimize for size instead of speed"
133         default y
134         depends on ASH
135         help
136           Compile ash for reduced size at the price of speed.
137
138 config ASH_RANDOM_SUPPORT
139         bool "Pseudorandom generator and $RANDOM variable"
140         default n
141         depends on ASH
142         help
143           Enable pseudorandom generator and dynamic variable "$RANDOM".
144           Each read of "$RANDOM" will generate a new pseudorandom value.
145           You can reset the generator by using a specified start value.
146           After "unset RANDOM" the generator will switch off and this
147           variable will no longer have special treatment.
148
149 config ASH_EXPAND_PRMT
150         bool "Expand prompt string"
151         default n
152         depends on ASH
153         help
154           "PS#" may contain volatile content, such as backquote commands.
155           This option recreates the prompt string from the environment
156           variable each time it is displayed.
157
158 config HUSH
159         bool "hush"
160         default n
161         help
162           hush is a very small shell (just 18k) and it has fairly complete
163           Bourne shell grammar. It even handles all the normal flow control
164           options such as if/then/elif/else/fi, for/in/do/done, while loops,
165           case/esac.
166
167           It will compile and work on no-mmu systems.
168
169           It does not handle select, functions, here documents ( <<
170           word ), aliases, brace expansion, tilde expansion,
171           &> and >& redirection of stdout+stderr, etc.
172
173 config HUSH_HELP
174         bool "help builtin"
175         default n
176         depends on HUSH
177         help
178           Enable help builtin in hush. Code size + ~1 kbyte.
179
180 config HUSH_INTERACTIVE
181         bool "Interactive mode"
182         default y
183         depends on HUSH
184         help
185           Enable interactive mode (prompt and command editing).
186           Without this, hush simply reads and executes commands
187           from stdin just like a shell script from the file.
188           No prompt, no PS1/PS2 magic shell variables.
189
190 config HUSH_JOB
191         bool "Job control"
192         default n
193         depends on HUSH_INTERACTIVE
194         help
195           Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
196           command (not entire shell), fg/bg builtins work. Without this option,
197           "cmd &" still works by simply spawning a process and immediately
198           prompting for next command (or executing next command in a script),
199           but no separate process group is formed.
200
201 config HUSH_TICK
202         bool "Process substitution"
203         default n
204         depends on HUSH
205         help
206           Enable process substitution `command` and $(command) in hush.
207
208 config HUSH_IF
209         bool "Support if/then/elif/else/fi"
210         default n
211         depends on HUSH
212         help
213           Enable if/then/elif/else/fi in hush.
214
215 config HUSH_LOOPS
216         bool "Support for, while and until loops"
217         default n
218         depends on HUSH
219         help
220           Enable for, while and until loops in hush.
221
222 config HUSH_CASE
223         bool "Support case ... esac statement"
224         default n
225         depends on HUSH
226         help
227           Enable case ... esac statement in hush. +400 bytes.
228
229 config LASH
230         bool "lash (deprecated: aliased to hush)"
231         default n
232         select HUSH
233         help
234           lash is deprecated and will be removed, please migrate to hush.
235
236 config MSH
237         bool "msh (deprecated: please use hush)"
238         default n
239         help
240           The minix shell (adds just 30k) is quite complete and handles things
241           like for/do/done, case/esac and all the things you expect a Bourne
242           shell to do. It is not always pedantically correct about Bourne
243           shell grammar (try running the shell testscript "tests/sh.testcases"
244           on it and compare vs bash) but for most things it works quite well.
245           It uses only vfork, so it can be used on uClinux systems.
246
247           msh is deprecated and will be removed, please migrate to hush.
248           If there is a feature msh has but hush does not, please let us know.
249
250 comment "Bourne Shell Options"
251         depends on MSH || LASH || HUSH || ASH
252
253 config SH_MATH_SUPPORT
254         bool "POSIX math support"
255         default y
256         depends on ASH || HUSH
257         help
258           Enable math support in the shell via $((...)) syntax.
259
260 config SH_MATH_SUPPORT_64
261         bool "Extend POSIX math support to 64 bit"
262         default n
263         depends on SH_MATH_SUPPORT
264         help
265           Enable 64-bit math support in the shell. This will make the shell
266           slightly larger, but will allow computation with very large numbers.
267           This is not in POSIX, so do not rely on this in portable code.
268
269 config FEATURE_SH_EXTRA_QUIET
270         bool "Hide message on interactive shell startup"
271         default n
272         depends on MSH || LASH || HUSH || ASH
273         help
274           Remove the busybox introduction when starting a shell.
275
276 config FEATURE_SH_STANDALONE
277         bool "Standalone shell"
278         default n
279         depends on (MSH || LASH || HUSH || ASH) && FEATURE_PREFER_APPLETS
280         help
281           This option causes busybox shells to use busybox applets
282           in preference to executables in the PATH whenever possible. For
283           example, entering the command 'ifconfig' into the shell would cause
284           busybox to use the ifconfig busybox applet. Specifying the fully
285           qualified executable name, such as '/sbin/ifconfig' will still
286           execute the /sbin/ifconfig executable on the filesystem. This option
287           is generally used when creating a statically linked version of busybox
288           for use as a rescue shell, in the event that you screw up your system.
289
290           This is implemented by re-execing /proc/self/exe (typically)
291           with right parameters. Some selected applets ("NOFORK" applets)
292           can even be executed without creating new process.
293           Instead, busybox will call <applet>_main() internally.
294
295           However, this causes problems in chroot jails without mounted /proc
296           and with ps/top (command name can be shown as 'exe' for applets
297           started this way).
298 # untrue?
299 #         Note that this will *also* cause applets to take precedence
300 #         over shell builtins of the same name. So turning this on will
301 #         eliminate any performance gained by turning on the builtin "echo"
302 #         and "test" commands in ash.
303 # untrue?
304 #         Note that when using this option, the shell will attempt to directly
305 #         run '/bin/busybox'. If you do not have the busybox binary sitting in
306 #         that exact location with that exact name, this option will not work at
307 #         all.
308
309 config FEATURE_SH_NOFORK
310         bool "Run 'nofork' applets directly"
311         default n
312         depends on (MSH || LASH || HUSH || ASH) && FEATURE_PREFER_APPLETS
313         help
314           This option causes busybox shells [currently only ash]
315           to not execute typical fork/exec/wait sequence, but call <applet>_main
316           directly, if possible. (Sometimes it is not possible: for example,
317           this is not possible in pipes).
318
319           This will be done only for some applets (those which are marked
320           NOFORK in include/applets.h).
321
322           This may significantly speed up some shell scripts.
323
324           This feature is relatively new. Use with care.
325
326 config CTTYHACK
327         bool "cttyhack"
328         default n
329         help
330           One common problem reported on the mailing list is "can't access tty;
331           job control turned off" error message which typically appears when
332           one tries to use shell with stdin/stdout opened to /dev/console.
333           This device is special - it cannot be a controlling tty.
334
335           Proper solution is to use correct device instead of /dev/console.
336
337           cttyhack provides "quick and dirty" solution to this problem.
338           It analyzes stdin with various ioctls, trying to determine whether
339           it is a /dev/ttyN or /dev/ttySN (virtual terminal or serial line).
340           If it detects one, it closes stdin/out/err and reopens that device.
341           Then it executes given program. Usage example for /etc/inittab
342           (for busybox init):
343
344           ::respawn:/bin/cttyhack /bin/sh
345
346 endmenu