add help text
[oweals/busybox.git] / libbb / 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 "Busybox Library Tuning"
7
8 INSERT
9
10 config PASSWORD_MINLEN
11         int "Minimum password length"
12         default 6
13         range 5 32
14         help
15           Minimum allowable password length.
16
17 config MD5_SIZE_VS_SPEED
18         int "MD5: Trade bytes for speed (0:fast, 3:slow)"
19         default 2
20         range 0 3
21         help
22           Trade binary size versus speed for the md5sum algorithm.
23           Approximate values running uClibc and hashing
24           linux-2.4.4.tar.bz2 were:
25                             user times (sec)  text size (386)
26           0 (fastest)         1.1                6144
27           1                   1.4                5392
28           2                   3.0                5088
29           3 (smallest)        5.1                4912
30
31 config FEATURE_FAST_TOP
32         bool "Faster /proc scanning code (+100 bytes)"
33         default y
34         help
35           This option makes top (and ps) ~20% faster (or 20% less CPU hungry),
36           but code size is slightly bigger.
37
38 config FEATURE_ETC_NETWORKS
39         bool "Support for /etc/networks"
40         default n
41         help
42           Enable support for network names in /etc/networks. This is
43           a rarely used feature which allows you to use names
44           instead of IP/mask pairs in route command.
45
46 config FEATURE_USE_TERMIOS
47         bool "Use termios to manipulate the screen"
48         default y
49         depends on MORE || TOP || POWERTOP
50         help
51           This option allows utilities such as 'more' and 'top' to determine
52           the size of the screen. If you leave this disabled, your utilities
53           that display things on the screen will be especially primitive and
54           will be unable to determine the current screen size, and will be
55           unable to move the cursor.
56
57 config FEATURE_EDITING
58         bool "Command line editing"
59         default y
60         help
61           Enable line editing (mainly for shell command line).
62
63 config FEATURE_EDITING_MAX_LEN
64         int "Maximum length of input"
65         range 128 8192
66         default 1024
67         depends on FEATURE_EDITING
68         help
69           Line editing code uses on-stack buffers for storage.
70           You may want to decrease this parameter if your target machine
71           benefits from smaller stack usage.
72
73 config FEATURE_EDITING_VI
74         bool "vi-style line editing commands"
75         default n
76         depends on FEATURE_EDITING
77         help
78           Enable vi-style line editing. In shells, this mode can be
79           turned on and off with "set -o vi" and "set +o vi".
80
81 config FEATURE_EDITING_HISTORY
82         int "History size"
83         # Don't allow way too big values here, code uses fixed "char *history[N]" struct member
84         range 0 9999
85         default 255
86         depends on FEATURE_EDITING
87         help
88           Specify command history size (0 - disable).
89
90 config FEATURE_EDITING_SAVEHISTORY
91         bool "History saving"
92         default y
93         depends on FEATURE_EDITING
94         help
95           Enable history saving in shells.
96
97 config FEATURE_TAB_COMPLETION
98         bool "Tab completion"
99         default y
100         depends on FEATURE_EDITING
101         help
102           Enable tab completion.
103
104 config FEATURE_USERNAME_COMPLETION
105         bool "Username completion"
106         default n
107         depends on FEATURE_TAB_COMPLETION
108         help
109           Enable username completion.
110
111 config FEATURE_EDITING_FANCY_PROMPT
112         bool "Fancy shell prompts"
113         default y
114         depends on FEATURE_EDITING
115         help
116           Setting this option allows for prompts to use things like \w and
117           \$ and escape codes.
118
119 config FEATURE_EDITING_ASK_TERMINAL
120         bool "Query cursor position from terminal"
121         default n
122         depends on FEATURE_EDITING
123         help
124           Allow usage of "ESC [ 6 n" sequence. Terminal answers back with
125           current cursor position. This information is used to make line
126           editing more robust in some cases.
127           If you are not sure whether your terminals respond to this code
128           correctly, or want to save on code size (about 400 bytes),
129           then do not turn this option on.
130
131 config FEATURE_NON_POSIX_CP
132         bool "Non-POSIX, but safer, copying to special nodes"
133         default y
134         help
135           With this option, "cp file symlink" will delete symlink
136           and create a regular file. This does not conform to POSIX,
137           but prevents a symlink attack.
138           Similarly, "cp file device" will not send file's data
139           to the device. (To do that, use "cat file >device")
140
141 config FEATURE_VERBOSE_CP_MESSAGE
142         bool "Give more precise messages when copy fails (cp, mv etc)"
143         default n
144         help
145           Error messages with this feature enabled:
146             $ cp file /does_not_exist/file
147             cp: cannot create '/does_not_exist/file': Path does not exist
148             $ cp file /vmlinuz/file
149             cp: cannot stat '/vmlinuz/file': Path has non-directory component
150           If this feature is not enabled, they will be, respectively:
151             cp: cannot create '/does_not_exist/file': No such file or directory
152             cp: cannot stat '/vmlinuz/file': Not a directory
153           This will cost you ~60 bytes.
154
155 config FEATURE_COPYBUF_KB
156         int "Copy buffer size, in kilobytes"
157         range 1 1024
158         default 4
159         help
160           Size of buffer used by cp, mv, install, wget etc.
161           Buffers which are 4 kb or less will be allocated on stack.
162           Bigger buffers will be allocated with mmap, with fallback to 4 kb
163           stack buffer if mmap fails.
164
165 config FEATURE_SKIP_ROOTFS
166         bool "Skip rootfs in mount table"
167         default y
168         help
169           Ignore rootfs entry in mount table.
170
171           In Linux, kernel has a special filesystem, rootfs, which is initially
172           mounted on /. It contains initramfs data, if kernel is configured
173           to have one. Usually, another file system is mounted over / early
174           in boot process, and therefore most tools which manipulate
175           mount table, such as df, will skip rootfs entry.
176
177           However, some systems do not mount anything on /.
178           If you need to configure busybox for one of these systems,
179           you may find useful to turn this option off to make df show
180           initramfs statistic.
181
182           Otherwise, choose Y.
183
184 config MONOTONIC_SYSCALL
185         bool "Use clock_gettime(CLOCK_MONOTONIC) syscall"
186         default n
187         select PLATFORM_LINUX
188         help
189           Use clock_gettime(CLOCK_MONOTONIC) syscall for measuring
190           time intervals (time, ping, traceroute etc need this).
191           Probably requires Linux 2.6+. If not selected, gettimeofday
192           will be used instead (which gives wrong results if date/time
193           is reset).
194
195 config IOCTL_HEX2STR_ERROR
196         bool "Use ioctl names rather than hex values in error messages"
197         default y
198         help
199           Use ioctl names rather than hex values in error messages
200           (e.g. VT_DISALLOCATE rather than 0x5608). If disabled this
201           saves about 1400 bytes.
202
203 config FEATURE_HWIB
204         bool "Support infiniband HW"
205         default y
206         help
207           Support for printing infiniband addresses in
208           network applets.
209
210 endmenu