hush: add support for local builtin
[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 small shell (22k). It handles the normal flow control
163           constructs such as if/then/elif/else/fi, for/in/do/done, while loops,
164           case/esac. Redirections, here documents, $((arithmetic))
165           and functions are supported.
166
167           It will compile and work on no-mmu systems.
168
169           It does not handle select, aliases, brace expansion,
170           tilde expansion, &>file and >&file redirection of stdout+stderr.
171
172 config HUSH_HELP
173         bool "help builtin"
174         default n
175         depends on HUSH
176         help
177           Enable help builtin in hush. Code size + ~1 kbyte.
178
179 config HUSH_INTERACTIVE
180         bool "Interactive mode"
181         default y
182         depends on HUSH
183         help
184           Enable interactive mode (prompt and command editing).
185           Without this, hush simply reads and executes commands
186           from stdin just like a shell script from the file.
187           No prompt, no PS1/PS2 magic shell variables.
188
189 config HUSH_JOB
190         bool "Job control"
191         default n
192         depends on HUSH_INTERACTIVE
193         help
194           Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
195           command (not entire shell), fg/bg builtins work. Without this option,
196           "cmd &" still works by simply spawning a process and immediately
197           prompting for next command (or executing next command in a script),
198           but no separate process group is formed.
199
200 config HUSH_TICK
201         bool "Process substitution"
202         default n
203         depends on HUSH
204         help
205           Enable process substitution `command` and $(command) in hush.
206
207 config HUSH_IF
208         bool "Support if/then/elif/else/fi"
209         default n
210         depends on HUSH
211         help
212           Enable if/then/elif/else/fi in hush.
213
214 config HUSH_LOOPS
215         bool "Support for, while and until loops"
216         default n
217         depends on HUSH
218         help
219           Enable for, while and until loops in hush.
220
221 config HUSH_CASE
222         bool "Support case ... esac statement"
223         default n
224         depends on HUSH
225         help
226           Enable case ... esac statement in hush. +400 bytes.
227
228 config HUSH_FUNCTIONS
229         bool "Support funcname() { commands; } syntax"
230         default n
231         depends on HUSH
232         help
233           Enable support for shell functions in hush. +800 bytes.
234
235 config HUSH_LOCAL
236         bool "Support local builtin"
237         default n
238         depends on HUSH_FUNCTIONS
239         help
240           Enable support for local variables in functions.
241
242 config HUSH_EXPORT_N
243         bool "Support export '-n' option"
244         default n
245         depends on HUSH
246         help
247           Enable support for export '-n' option in hush. It is a bash extension.
248
249 config LASH
250         bool "lash (deprecated: aliased to hush)"
251         default n
252         select HUSH
253         help
254           lash is deprecated and will be removed, please migrate to hush.
255
256 config MSH
257         bool "msh (deprecated: please use hush)"
258         default n
259         help
260           msh is deprecated and will be removed, please migrate to hush.
261           If there is a feature msh has but hush does not, please let us know.
262
263 #         The minix shell (adds just 30k) is quite complete and handles things
264 #         like for/do/done, case/esac and all the things you expect a Bourne
265 #         shell to do. It is not always pedantically correct about Bourne
266 #         shell grammar (try running the shell testscript "tests/sh.testcases"
267 #         on it and compare vs bash) but for most things it works quite well.
268 #         It uses only vfork, so it can be used on uClinux systems.
269
270
271 comment "Bourne Shell Options"
272         depends on MSH || LASH || HUSH || ASH
273
274 config SH_MATH_SUPPORT
275         bool "POSIX math support"
276         default y
277         depends on ASH || HUSH
278         help
279           Enable math support in the shell via $((...)) syntax.
280
281 config SH_MATH_SUPPORT_64
282         bool "Extend POSIX math support to 64 bit"
283         default n
284         depends on SH_MATH_SUPPORT
285         help
286           Enable 64-bit math support in the shell. This will make the shell
287           slightly larger, but will allow computation with very large numbers.
288           This is not in POSIX, so do not rely on this in portable code.
289
290 config FEATURE_SH_EXTRA_QUIET
291         bool "Hide message on interactive shell startup"
292         default n
293         depends on MSH || LASH || HUSH || ASH
294         help
295           Remove the busybox introduction when starting a shell.
296
297 config FEATURE_SH_STANDALONE
298         bool "Standalone shell"
299         default n
300         depends on (MSH || LASH || HUSH || ASH) && FEATURE_PREFER_APPLETS
301         help
302           This option causes busybox shells to use busybox applets
303           in preference to executables in the PATH whenever possible. For
304           example, entering the command 'ifconfig' into the shell would cause
305           busybox to use the ifconfig busybox applet. Specifying the fully
306           qualified executable name, such as '/sbin/ifconfig' will still
307           execute the /sbin/ifconfig executable on the filesystem. This option
308           is generally used when creating a statically linked version of busybox
309           for use as a rescue shell, in the event that you screw up your system.
310
311           This is implemented by re-execing /proc/self/exe (typically)
312           with right parameters. Some selected applets ("NOFORK" applets)
313           can even be executed without creating new process.
314           Instead, busybox will call <applet>_main() internally.
315
316           However, this causes problems in chroot jails without mounted /proc
317           and with ps/top (command name can be shown as 'exe' for applets
318           started this way).
319 # untrue?
320 #         Note that this will *also* cause applets to take precedence
321 #         over shell builtins of the same name. So turning this on will
322 #         eliminate any performance gained by turning on the builtin "echo"
323 #         and "test" commands in ash.
324 # untrue?
325 #         Note that when using this option, the shell will attempt to directly
326 #         run '/bin/busybox'. If you do not have the busybox binary sitting in
327 #         that exact location with that exact name, this option will not work at
328 #         all.
329
330 config FEATURE_SH_NOFORK
331         bool "Run 'nofork' applets directly"
332         default n
333         depends on (MSH || LASH || HUSH || ASH) && FEATURE_PREFER_APPLETS
334         help
335           This option causes busybox shells [currently only ash]
336           to not execute typical fork/exec/wait sequence, but call <applet>_main
337           directly, if possible. (Sometimes it is not possible: for example,
338           this is not possible in pipes).
339
340           This will be done only for some applets (those which are marked
341           NOFORK in include/applets.h).
342
343           This may significantly speed up some shell scripts.
344
345           This feature is relatively new. Use with care.
346
347 config CTTYHACK
348         bool "cttyhack"
349         default n
350         help
351           One common problem reported on the mailing list is "can't access tty;
352           job control turned off" error message which typically appears when
353           one tries to use shell with stdin/stdout opened to /dev/console.
354           This device is special - it cannot be a controlling tty.
355
356           Proper solution is to use correct device instead of /dev/console.
357
358           cttyhack provides "quick and dirty" solution to this problem.
359           It analyzes stdin with various ioctls, trying to determine whether
360           it is a /dev/ttyN or /dev/ttySN (virtual terminal or serial line).
361           If it detects one, it closes stdin/out/err and reopens that device.
362           Then it executes given program. Usage example for /etc/inittab
363           (for busybox init):
364
365           ::respawn:/bin/cttyhack /bin/sh
366
367 endmenu