hush: make set -x support optional
[oweals/busybox.git] / shell / Config.src
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 INSERT
9
10 config ASH
11         bool "ash"
12         default y
13         depends on !NOMMU
14         help
15           Tha 'ash' shell adds about 60k in the default configuration and is
16           the most complete and most pedantically correct shell included with
17           busybox. This shell is actually a derivative of the Debian 'dash'
18           shell (by Herbert Xu), which was created by porting the 'ash' shell
19           (written by Kenneth Almquist) from NetBSD.
20
21 config ASH_BASH_COMPAT
22         bool "bash-compatible extensions"
23         default y
24         depends on ASH
25         help
26           Enable bash-compatible extensions.
27
28 config ASH_JOB_CONTROL
29         bool "Job control"
30         default y
31         depends on ASH
32         help
33           Enable job control in the ash shell.
34
35 config ASH_ALIAS
36         bool "alias support"
37         default y
38         depends on ASH
39         help
40           Enable alias support in the ash shell.
41
42 config ASH_GETOPTS
43         bool "Builtin getopt to parse positional parameters"
44         default y
45         depends on ASH
46         help
47           Enable getopts builtin in the ash shell.
48
49 config ASH_BUILTIN_ECHO
50         bool "Builtin version of 'echo'"
51         default y
52         depends on ASH
53         help
54           Enable support for echo, builtin to ash.
55
56 config ASH_BUILTIN_PRINTF
57         bool "Builtin version of 'printf'"
58         default y
59         depends on ASH
60         help
61           Enable support for printf, builtin to ash.
62
63 config ASH_BUILTIN_TEST
64         bool "Builtin version of 'test'"
65         default y
66         depends on ASH
67         help
68           Enable support for test, builtin to ash.
69
70 config ASH_CMDCMD
71         bool "'command' command to override shell builtins"
72         default y
73         depends on ASH
74         help
75           Enable support for the ash 'command' builtin, which allows
76           you to run the specified command with the specified arguments,
77           even when there is an ash builtin command with the same name.
78
79 config ASH_MAIL
80         bool "Check for new mail on interactive shells"
81         default n
82         depends on ASH
83         help
84           Enable "check for new mail" in the ash shell.
85
86 config ASH_OPTIMIZE_FOR_SIZE
87         bool "Optimize for size instead of speed"
88         default y
89         depends on ASH
90         help
91           Compile ash for reduced size at the price of speed.
92
93 config ASH_RANDOM_SUPPORT
94         bool "Pseudorandom generator and $RANDOM variable"
95         default y
96         depends on ASH
97         help
98           Enable pseudorandom generator and dynamic variable "$RANDOM".
99           Each read of "$RANDOM" will generate a new pseudorandom value.
100           You can reset the generator by using a specified start value.
101           After "unset RANDOM" the generator will switch off and this
102           variable will no longer have special treatment.
103
104 config ASH_EXPAND_PRMT
105         bool "Expand prompt string"
106         default y
107         depends on ASH
108         help
109           "PS#" may contain volatile content, such as backquote commands.
110           This option recreates the prompt string from the environment
111           variable each time it is displayed.
112
113
114 choice
115         prompt "Choose which shell is aliased to 'sh' name"
116         default FEATURE_SH_IS_ASH
117         help
118           Choose which shell you want to be executed by 'sh' alias.
119           The ash shell is the most bash compatible and full featured one.
120
121 # note: cannot use "select ASH" here, it breaks "make allnoconfig"
122 config FEATURE_SH_IS_ASH
123         depends on ASH
124         bool "ash"
125         depends on !NOMMU
126
127 config FEATURE_SH_IS_HUSH
128         depends on HUSH
129         bool "hush"
130
131 config FEATURE_SH_IS_NONE
132         bool "none"
133
134 endchoice
135
136 choice
137         prompt "Choose which shell is aliased to 'bash' name"
138         default FEATURE_BASH_IS_NONE
139         help
140           Choose which shell you want to be executed by 'bash' alias.
141           The ash shell is the most bash compatible and full featured one.
142
143           Note that selecting this option does not switch on any bash
144           compatibility code. It merely makes it possible to install
145           /bin/bash (sym)link and run scripts which start with
146           #!/bin/bash line.
147
148           Many systems use it in scripts which use bash-specific features,
149           even simple ones like $RANDOM. Without this option, busybox
150           can't be used for running them because it won't recongnize
151           "bash" as a supported applet name.
152
153 config FEATURE_BASH_IS_ASH
154         depends on ASH
155         bool "ash"
156         depends on !NOMMU
157
158 config FEATURE_BASH_IS_HUSH
159         depends on HUSH
160         bool "hush"
161
162 config FEATURE_BASH_IS_NONE
163         bool "none"
164
165 endchoice
166
167
168 config LASH
169         bool "lash (deprecated: aliased to hush)"
170         default n
171         select HUSH
172         help
173           lash is deprecated and will be removed, please migrate to hush.
174
175 config MSH
176         bool "msh (deprecated: please use hush)"
177         default n
178         select HUSH
179         help
180           msh is deprecated and will be removed, please migrate to hush.
181           If there is a feature msh has but hush does not, please let us know.
182
183 #         The minix shell (adds just 30k) is quite complete and handles things
184 #         like for/do/done, case/esac and all the things you expect a Bourne
185 #         shell to do. It is not always pedantically correct about Bourne
186 #         shell grammar (try running the shell testscript "tests/sh.testcases"
187 #         on it and compare vs bash) but for most things it works quite well.
188 #         It uses only vfork, so it can be used on uClinux systems.
189
190
191 config SH_MATH_SUPPORT
192         bool "POSIX math support"
193         default y
194         depends on ASH || HUSH
195         help
196           Enable math support in the shell via $((...)) syntax.
197
198 config SH_MATH_SUPPORT_64
199         bool "Extend POSIX math support to 64 bit"
200         default y
201         depends on SH_MATH_SUPPORT
202         help
203           Enable 64-bit math support in the shell. This will make the shell
204           slightly larger, but will allow computation with very large numbers.
205           This is not in POSIX, so do not rely on this in portable code.
206
207 config FEATURE_SH_EXTRA_QUIET
208         bool "Hide message on interactive shell startup"
209         default y
210         depends on HUSH || ASH
211         help
212           Remove the busybox introduction when starting a shell.
213
214 config FEATURE_SH_STANDALONE
215         bool "Standalone shell"
216         default n
217         depends on (HUSH || ASH) && FEATURE_PREFER_APPLETS
218         help
219           This option causes busybox shells to use busybox applets
220           in preference to executables in the PATH whenever possible. For
221           example, entering the command 'ifconfig' into the shell would cause
222           busybox to use the ifconfig busybox applet. Specifying the fully
223           qualified executable name, such as '/sbin/ifconfig' will still
224           execute the /sbin/ifconfig executable on the filesystem. This option
225           is generally used when creating a statically linked version of busybox
226           for use as a rescue shell, in the event that you screw up your system.
227
228           This is implemented by re-execing /proc/self/exe (typically)
229           with right parameters. Some selected applets ("NOFORK" applets)
230           can even be executed without creating new process.
231           Instead, busybox will call <applet>_main() internally.
232
233           However, this causes problems in chroot jails without mounted /proc
234           and with ps/top (command name can be shown as 'exe' for applets
235           started this way).
236 # untrue?
237 #         Note that this will *also* cause applets to take precedence
238 #         over shell builtins of the same name. So turning this on will
239 #         eliminate any performance gained by turning on the builtin "echo"
240 #         and "test" commands in ash.
241 # untrue?
242 #         Note that when using this option, the shell will attempt to directly
243 #         run '/bin/busybox'. If you do not have the busybox binary sitting in
244 #         that exact location with that exact name, this option will not work at
245 #         all.
246
247 config FEATURE_SH_NOFORK
248         bool "Run 'nofork' applets directly"
249         default n
250         depends on (HUSH || ASH) && FEATURE_PREFER_APPLETS
251         help
252           This option causes busybox shells [currently only ash]
253           to not execute typical fork/exec/wait sequence, but call <applet>_main
254           directly, if possible. (Sometimes it is not possible: for example,
255           this is not possible in pipes).
256
257           This will be done only for some applets (those which are marked
258           NOFORK in include/applets.h).
259
260           This may significantly speed up some shell scripts.
261
262           This feature is relatively new. Use with care.
263
264 config CTTYHACK
265         bool "cttyhack"
266         default y
267         help
268           One common problem reported on the mailing list is "can't access tty;
269           job control turned off" error message which typically appears when
270           one tries to use shell with stdin/stdout opened to /dev/console.
271           This device is special - it cannot be a controlling tty.
272
273           Proper solution is to use correct device instead of /dev/console.
274
275           cttyhack provides "quick and dirty" solution to this problem.
276           It analyzes stdin with various ioctls, trying to determine whether
277           it is a /dev/ttyN or /dev/ttySN (virtual terminal or serial line).
278           If it detects one, it closes stdin/out/err and reopens that device.
279           Then it executes given program. Opening the device will make
280           that device a controlling tty. This may require cttyhack
281           to be a session leader.
282
283           Example for /etc/inittab (for busybox init):
284
285           ::respawn:/bin/cttyhack /bin/sh
286
287           Giving controlling tty to shell running with PID 1:
288
289           $ exec cttyhack sh
290
291           Starting an interactive shell from boot shell script:
292
293           setsid cttyhack sh
294
295 endmenu