summaryrefslogtreecommitdiff
path: root/package/busybox/config/shell/Config.in
blob: bc96b0267b7d969dc6a2318763cde645275d97d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
# DO NOT EDIT. This file is generated from Config.src
#
# For a description of the syntax of this configuration file,
# see docs/Kconfig-language.txt.
#

menu "Shells"


choice
	prompt "Choose which shell is aliased to 'sh' name"
	default BUSYBOX_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 BUSYBOX_ASH" here, it breaks "make allnoconfig"
config BUSYBOX_SH_IS_ASH
	depends on !BUSYBOX_NOMMU
	bool "ash"
	select BUSYBOX_SHELL_ASH
	help
	Choose ash to be the shell executed by 'sh' name.
	The ash code will be built into busybox. If you don't select
	"ash" choice (CONFIG_ASH), this shell may only be invoked by
	the name 'sh' (and not 'ash').

config BUSYBOX_SH_IS_HUSH
	bool "hush"
	select BUSYBOX_SHELL_HUSH
	help
	Choose hush to be the shell executed by 'sh' name.
	The hush code will be built into busybox. If you don't select
	"hush" choice (CONFIG_HUSH), this shell may only be invoked by
	the name 'sh' (and not 'hush').

config BUSYBOX_SH_IS_NONE
	bool "none"

endchoice

choice
	prompt "Choose which shell is aliased to 'bash' name"
	default BUSYBOX_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,
	although compatibility is far from being complete.

	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_BASH_IS_ASH
	depends on !BUSYBOX_NOMMU
	bool "ash"
	select BUSYBOX_SHELL_ASH
	help
	Choose ash to be the shell executed by 'bash' name.
	The ash code will be built into busybox. If you don't select
	"ash" choice (CONFIG_ASH), this shell may only be invoked by
	the name 'bash' (and not 'ash').

config BUSYBOX_BASH_IS_HUSH
	bool "hush"
	select BUSYBOX_SHELL_HUSH
	help
	Choose hush to be the shell executed by 'bash' name.
	The hush code will be built into busybox. If you don't select
	"hush" choice (CONFIG_HUSH), this shell may only be invoked by
	the name 'bash' (and not 'hush').

config BUSYBOX_BASH_IS_NONE
	bool "none"

endchoice


config BUSYBOX_SHELL_ASH
	bool #hidden option
	depends on !BUSYBOX_NOMMU

config BUSYBOX_ASH
	bool "ash (78 kb)"
	default y
	depends on !BUSYBOX_NOMMU
	select BUSYBOX_SHELL_ASH
	help
	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.

# ash options
# note: Don't remove !NOMMU part in the next line; it would break
# menuconfig's indenting.
if !BUSYBOX_NOMMU && (BUSYBOX_SHELL_ASH || BUSYBOX_ASH || BUSYBOX_SH_IS_ASH || BUSYBOX_BASH_IS_ASH)

config BUSYBOX_ASH_OPTIMIZE_FOR_SIZE
	bool "Optimize for size instead of speed"
	default y
	depends on BUSYBOX_SHELL_ASH

config BUSYBOX_ASH_INTERNAL_GLOB
	bool "Use internal glob() implementation"
	default y	# Y is bigger, but because of uclibc glob() bug, let Y be default for now
	depends on BUSYBOX_SHELL_ASH
	help
	Do not use glob() function from libc, use internal implementation.
	Use this if you are getting "glob.h: No such file or directory"
	or similar build errors.
	Note that as of now (2017-01), uclibc and musl glob() both have bugs
	which would break ash if you select N here.

config BUSYBOX_ASH_BASH_COMPAT
	bool "bash-compatible extensions"
	default y
	depends on BUSYBOX_SHELL_ASH

config BUSYBOX_ASH_BASH_SOURCE_CURDIR
	bool "'source' and '.' builtins search current directory after $PATH"
	default n   # do not encourage non-standard behavior
	depends on BUSYBOX_ASH_BASH_COMPAT
	help
	This is not compliant with standards. Avoid if possible.

config BUSYBOX_ASH_BASH_NOT_FOUND_HOOK
	bool "command_not_found_handle hook support"
	default y
	depends on BUSYBOX_ASH_BASH_COMPAT
	help
	Enable support for the 'command_not_found_handle' hook function,
	from GNU bash, which allows for alternative command not found
	handling.

config BUSYBOX_ASH_JOB_CONTROL
	bool "Job control"
	default y
	depends on BUSYBOX_SHELL_ASH

config BUSYBOX_ASH_ALIAS
	bool "Alias support"
	default y
	depends on BUSYBOX_SHELL_ASH

config BUSYBOX_ASH_RANDOM_SUPPORT
	bool "Pseudorandom generator and $RANDOM variable"
	default y
	depends on BUSYBOX_SHELL_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" the generator will switch off and this
	variable will no longer have special treatment.

config BUSYBOX_ASH_EXPAND_PRMT
	bool "Expand prompt string"
	default y
	depends on BUSYBOX_SHELL_ASH
	help
	$PS# may contain volatile content, such as backquote commands.
	This option recreates the prompt string from the environment
	variable each time it is displayed.

config BUSYBOX_ASH_IDLE_TIMEOUT
	bool "Idle timeout variable $TMOUT"
	default y
	depends on BUSYBOX_SHELL_ASH
	help
	Enable bash-like auto-logout after $TMOUT seconds of idle time.

config BUSYBOX_ASH_MAIL
	bool "Check for new mail in interactive shell"
	default y
	depends on BUSYBOX_SHELL_ASH
	help
	Enable "check for new mail" function:
	if set, $MAIL file and $MAILPATH list of files
	are checked for mtime changes, and "you have mail"
	message is printed if change is detected.

config BUSYBOX_ASH_ECHO
	bool "echo builtin"
	default y
	depends on BUSYBOX_SHELL_ASH

config BUSYBOX_ASH_PRINTF
	bool "printf builtin"
	default y
	depends on BUSYBOX_SHELL_ASH

config BUSYBOX_ASH_TEST
	bool "test builtin"
	default y
	depends on BUSYBOX_SHELL_ASH

config BUSYBOX_ASH_HELP
	bool "help builtin"
	default y
	depends on BUSYBOX_SHELL_ASH

config BUSYBOX_ASH_GETOPTS
	bool "getopts builtin"
	default y
	depends on BUSYBOX_SHELL_ASH

config BUSYBOX_ASH_CMDCMD
	bool "command builtin"
	default y
	depends on BUSYBOX_SHELL_ASH
	help
	Enable support for the 'command' builtin, which allows
	you to run the specified command or builtin,
	even when there is a function with the same name.

endif # ash options
config BUSYBOX_CTTYHACK
	bool "cttyhack (2.4 kb)"
	default y
	help
	One common problem reported on the mailing list is the "can't
	access tty; job control turned off" error message, which typically
	appears when one tries to use a shell with stdin/stdout on
	/dev/console.
	This device is special - it cannot be a controlling tty.

	The proper solution is to use the correct device instead of
	/dev/console.

	cttyhack provides a "quick and dirty" solution to this problem.
	It analyzes stdin with various ioctls, trying to determine whether
	it is a /dev/ttyN or /dev/ttySN (virtual terminal or serial line).
	On Linux it also checks sysfs for a pointer to the active console.
	If cttyhack is able to find the real console device, it closes
	stdin/out/err and reopens that device.
	Then it executes the 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

	Starting an interactive shell from boot shell script:

	setsid cttyhack sh

	Giving controlling tty to shell running with PID 1:

	# exec cttyhack sh

	Without cttyhack, you need to know exact tty name,
	and do something like this:

	# exec setsid sh -c 'exec sh </dev/tty1 >/dev/tty1 2>&1'

	Starting getty on a controlling tty from a shell script:

	# getty 115200 $(cttyhack)
config BUSYBOX_HUSH
	bool "hush (68 kb)"
	default y
	select BUSYBOX_SHELL_HUSH
	help
	hush is a small shell. 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 will compile and work on no-mmu systems.

	It does not handle select, aliases, tilde expansion,
	&>file and >&file redirection of stdout+stderr.

config BUSYBOX_SHELL_HUSH
	bool "Internal shell for embedded script support"
	default n

# hush options
# It's only needed to get "nice" menuconfig indenting.
if BUSYBOX_SHELL_HUSH || BUSYBOX_HUSH || BUSYBOX_SH_IS_HUSH || BUSYBOX_BASH_IS_HUSH

config BUSYBOX_HUSH_BASH_COMPAT
	bool "bash-compatible extensions"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_BRACE_EXPANSION
	bool "Brace expansion"
	default y
	depends on BUSYBOX_HUSH_BASH_COMPAT
	help
	Enable {abc,def} extension.

config BUSYBOX_HUSH_LINENO_VAR
	bool "$LINENO variable"
	default y
	depends on BUSYBOX_HUSH_BASH_COMPAT

config BUSYBOX_HUSH_BASH_SOURCE_CURDIR
	bool "'source' and '.' builtins search current directory after $PATH"
	default n   # do not encourage non-standard behavior
	depends on BUSYBOX_HUSH_BASH_COMPAT
	help
	This is not compliant with standards. Avoid if possible.

config BUSYBOX_HUSH_INTERACTIVE
	bool "Interactive mode"
	default y
	depends on BUSYBOX_SHELL_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 a file.
	No prompt, no PS1/PS2 magic shell variables.

config BUSYBOX_HUSH_SAVEHISTORY
	bool "Save command history to .hush_history"
	default y
	depends on BUSYBOX_HUSH_INTERACTIVE && BUSYBOX_FEATURE_EDITING_SAVEHISTORY

config BUSYBOX_HUSH_JOB
	bool "Job control"
	default y
	depends on BUSYBOX_HUSH_INTERACTIVE
	help
	Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
	command (not entire shell), fg/bg builtins work. Without this option,
	"cmd &" still works by simply spawning a process and immediately
	prompting for next command (or executing next command in a script),
	but no separate process group is formed.

config BUSYBOX_HUSH_TICK
	bool "Support command substitution"
	default y
	depends on BUSYBOX_SHELL_HUSH
	help
	Enable `command` and $(command).

config BUSYBOX_HUSH_IF
	bool "Support if/then/elif/else/fi"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_LOOPS
	bool "Support for, while and until loops"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_CASE
	bool "Support case ... esac statement"
	default y
	depends on BUSYBOX_SHELL_HUSH
	help
	Enable case ... esac statement. +400 bytes.

config BUSYBOX_HUSH_FUNCTIONS
	bool "Support funcname() { commands; } syntax"
	default y
	depends on BUSYBOX_SHELL_HUSH
	help
	Enable support for shell functions. +800 bytes.

config BUSYBOX_HUSH_LOCAL
	bool "local builtin"
	default y
	depends on BUSYBOX_HUSH_FUNCTIONS
	help
	Enable support for local variables in functions.

config BUSYBOX_HUSH_RANDOM_SUPPORT
	bool "Pseudorandom generator and $RANDOM variable"
	default y
	depends on BUSYBOX_SHELL_HUSH
	help
	Enable pseudorandom generator and dynamic variable "$RANDOM".
	Each read of "$RANDOM" will generate a new pseudorandom value.

config BUSYBOX_HUSH_MODE_X
	bool "Support 'hush -x' option and 'set -x' command"
	default y
	depends on BUSYBOX_SHELL_HUSH
	help
	This instructs hush to print commands before execution.
	Adds ~300 bytes.

config BUSYBOX_HUSH_ECHO
	bool "echo builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_PRINTF
	bool "printf builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_TEST
	bool "test builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_HELP
	bool "help builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_EXPORT
	bool "export builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_EXPORT_N
	bool "Support 'export -n' option"
	default y
	depends on BUSYBOX_HUSH_EXPORT
	help
	export -n unexports variables. It is a bash extension.

config BUSYBOX_HUSH_READONLY
	bool "readonly builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH
	help
	Enable support for read-only variables.

config BUSYBOX_HUSH_KILL
	bool "kill builtin (supports kill %jobspec)"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_WAIT
	bool "wait builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_COMMAND
	bool "command builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_TRAP
	bool "trap builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_TYPE
	bool "type builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_TIMES
	bool "times builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_READ
	bool "read builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_SET
	bool "set builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_UNSET
	bool "unset builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_ULIMIT
	bool "ulimit builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_UMASK
	bool "umask builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_GETOPTS
	bool "getopts builtin"
	default y
	depends on BUSYBOX_SHELL_HUSH

config BUSYBOX_HUSH_MEMLEAK
	bool "memleak builtin (debugging)"
	default n
	depends on BUSYBOX_SHELL_HUSH

endif # hush options


comment "Options common to all shells"
if BUSYBOX_SHELL_ASH || BUSYBOX_SHELL_HUSH

config BUSYBOX_FEATURE_SH_MATH
	bool "POSIX math support"
	default y
	depends on BUSYBOX_SHELL_ASH || BUSYBOX_SHELL_HUSH
	help
	Enable math support in the shell via $((...)) syntax.

config BUSYBOX_FEATURE_SH_MATH_64
	bool "Extend POSIX math support to 64 bit"
	default y
	depends on BUSYBOX_FEATURE_SH_MATH
	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_FEATURE_SH_MATH_BASE
	bool "Support BASE#nnnn literals"
	default y
	depends on BUSYBOX_FEATURE_SH_MATH

config BUSYBOX_FEATURE_SH_EXTRA_QUIET
	bool "Hide message on interactive shell startup"
	default y
	depends on BUSYBOX_SHELL_ASH || BUSYBOX_SHELL_HUSH
	help
	Remove the busybox introduction when starting a shell.

config BUSYBOX_FEATURE_SH_STANDALONE
	bool "Standalone shell"
	default n
	depends on BUSYBOX_SHELL_ASH || BUSYBOX_SHELL_HUSH
	help
	This option causes busybox shells 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 statically linked version of busybox
	for use as a rescue shell, in the event that you screw up your system.

	This is implemented by re-execing /proc/self/exe (typically)
	with right parameters.

	However, there are drawbacks: it is problematic in chroot jails
	without mounted /proc, and ps/top may show command name as 'exe'
	for applets started this way.

config BUSYBOX_FEATURE_SH_NOFORK
	bool "Run 'nofork' applets directly"
	default n
	depends on BUSYBOX_SHELL_ASH || BUSYBOX_SHELL_HUSH
	help
	This option causes busybox shells to not execute typical
	fork/exec/wait sequence, but call <applet>_main directly,
	if possible. (Sometimes it is not possible: for example,
	this is not possible in pipes).

	This will be done only for some applets (those which are marked
	NOFORK in include/applets.h).

	This may significantly speed up some shell scripts.

	This feature is relatively new. Use with care. Report bugs
	to project mailing list.

config BUSYBOX_FEATURE_SH_READ_FRAC
	bool "read -t N.NNN support (+110 bytes)"
	default y
	depends on BUSYBOX_SHELL_ASH || BUSYBOX_SHELL_HUSH
	help
	Enable support for fractional second timeout in read builtin.

config BUSYBOX_FEATURE_SH_HISTFILESIZE
	bool "Use $HISTFILESIZE"
	default y
	depends on BUSYBOX_SHELL_ASH || BUSYBOX_SHELL_HUSH
	help
	This option makes busybox shells to use $HISTFILESIZE variable
	to set shell history size. Note that its max value is capped
	by "History size" setting in library tuning section.

config BUSYBOX_FEATURE_SH_EMBEDDED_SCRIPTS
	bool "Embed scripts in the binary"
	default y
	depends on BUSYBOX_SHELL_ASH || BUSYBOX_SHELL_HUSH
	help
	Allow scripts to be compressed and embedded in the busybox
	binary. The scripts should be placed in the 'embed' directory
	at build time. Like applets, scripts can be run as
	'busybox SCRIPT ...' or by linking their name to the binary.

	This also allows applets to be implemented as scripts: place
	the script in 'applets_sh' and a stub C file containing
	configuration in the appropriate subsystem directory.

endif # Options common to all shells

endmenu