Better description of the BB_FEATURE_USE_DEVPS_PATCH option.
[oweals/busybox.git] / busybox.def.h
1 /* vi: set sw=4 ts=4: */
2 // This file defines the feature set to be compiled into busybox.
3 // When you turn things off here, they won't be compiled in at all.
4 //
5 //// This file is parsed by sed. You MUST use single line comments.
6 //   i.e.  //#define BB_BLAH
7 //
8 //
9 // BusyBox Applications
10 #define BB_AR
11 #define BB_BASENAME
12 #define BB_CAT
13 #define BB_CHMOD_CHOWN_CHGRP
14 #define BB_CHROOT
15 #define BB_CHVT
16 #define BB_CLEAR
17 #define BB_CP_MV
18 #define BB_CUT
19 #define BB_DATE
20 #define BB_DC
21 #define BB_DD
22 #define BB_DEALLOCVT
23 #define BB_DF
24 #define BB_DIRNAME
25 #define BB_DMESG
26 #define BB_DUTMP
27 #define BB_DU
28 #define BB_ECHO
29 #define BB_FBSET
30 #define BB_FDFLUSH
31 #define BB_FIND
32 #define BB_FREE
33 #define BB_FREERAMDISK
34 #define BB_FSCK_MINIX
35 #define BB_GREP
36 #define BB_GUNZIP
37 #define BB_GZIP
38 #define BB_HALT
39 #define BB_HEAD
40 #define BB_HOSTID
41 #define BB_HOSTNAME
42 #define BB_ID
43 #define BB_INIT
44 #define BB_INSMOD
45 #define BB_KILL
46 #define BB_KILLALL
47 #define BB_LENGTH
48 #define BB_LN
49 #define BB_LOADACM
50 #define BB_LOADFONT
51 #define BB_LOADKMAP
52 #define BB_LOGGER
53 #define BB_LOGNAME
54 #define BB_LS
55 #define BB_LSMOD
56 #define BB_MAKEDEVS
57 #define BB_MD5SUM
58 #define BB_MKDIR
59 #define BB_MKFIFO
60 #define BB_MKFS_MINIX
61 #define BB_MKNOD
62 #define BB_MKSWAP
63 #define BB_MKTEMP
64 #define BB_NC
65 #define BB_MORE
66 #define BB_MOUNT
67 #define BB_MT
68 #define BB_NSLOOKUP
69 #define BB_PING
70 #define BB_POWEROFF
71 #define BB_PRINTF
72 #define BB_PS
73 #define BB_PWD
74 #define BB_REBOOT
75 #define BB_RM
76 #define BB_RMDIR
77 #define BB_RMMOD
78 #define BB_SED
79 #define BB_SETKEYCODES
80 #define BB_SH
81 #define BB_SLEEP
82 #define BB_SORT
83 #define BB_SWAPONOFF
84 #define BB_SYNC
85 #define BB_SYSLOGD
86 #define BB_TAIL
87 #define BB_TAR
88 #define BB_TEE
89 #define BB_TEST
90 #define BB_TELNET
91 #define BB_TOUCH
92 #define BB_TR
93 #define BB_TRUE_FALSE
94 #define BB_TTY
95 #define BB_UPTIME
96 #define BB_USLEEP
97 #define BB_WC
98 #define BB_WHICH
99 #define BB_WHOAMI
100 #define BB_UUENCODE
101 #define BB_UUDECODE
102 #define BB_UMOUNT
103 #define BB_UNIQ
104 #define BB_UNAME
105 #define BB_UPDATE
106 #define BB_YES
107 // End of Applications List
108 //
109 //
110 //
111 // ---------------------------------------------------------
112 // This is where feature definitions go.  Generally speaking,
113 // turning this stuff off makes things a bit smaller (and less 
114 // pretty/useful).
115 //
116 //
117 //
118 // Turn this on to use Erik's very cool devps, devmtab, etc kernel drivers,
119 // thereby eliminating the need for the /proc filesystem and thereby saving
120 // lots and lots memory for more important things.  You can not use this and
121 // USE_PROCFS at the same time...  NOTE:  If you enable this feature, you
122 // _must_ have patched the kernel to include the devps patch that is included
123 // in the busybox/kernel-patches directory.  You will also need to create some
124 // device special files /dev on your embedded system:
125 //        mknod /dev/modules c 10 23
126 //        mknod /dev/mtab c 10 22
127 //        mknod /dev/ps c 10 21
128 // I emailed Linus and this patch will not be going into the stock kernel.
129 //#define BB_FEATURE_USE_DEVPS_PATCH
130 //
131 // enable features that use the /proc filesystem (apps that 
132 // break without this will tell you on compile)...
133 // You can't use this and BB_FEATURE_USE_DEVPS_PATCH 
134 // at the same time...
135 #define BB_FEATURE_USE_PROCFS
136 //
137 // Enable full regular expressions.  This adds about 
138 // 4k.  When this is off, things that would normally
139 // use regualr expressions (like grep) will just use
140 // normal strings.
141 #define BB_FEATURE_FULL_REGULAR_EXPRESSIONS
142 //
143 // This compiles out everything but the most 
144 // trivial --help usage information (i.e. reduces binary size)
145 //#define BB_FEATURE_TRIVIAL_HELP
146 //
147 // Use termios to manipulate the screen ('more' is prettier with this on)
148 #define BB_FEATURE_USE_TERMIOS
149 //
150 // calculate terminal & column widths (for more and ls)
151 #define BB_FEATURE_AUTOWIDTH
152 //
153 // show username/groupnames (bypasses libc6 NSS) for ls
154 #define BB_FEATURE_LS_USERNAME
155 //
156 // show file timestamps in ls
157 #define BB_FEATURE_LS_TIMESTAMPS
158 //
159 // enable ls -p and -F
160 #define BB_FEATURE_LS_FILETYPES
161 //
162 // enable ls -R
163 #define BB_FEATURE_LS_RECURSIVE
164 //
165 // Change ping implementation -- simplified, featureless, but really small.
166 //#define BB_FEATURE_SIMPLE_PING
167 //
168 // Make init use a simplified /etc/inittab file (recommended).
169 #define BB_FEATURE_USE_INITTAB
170 //
171 //Enable init being called as /linuxrc
172 //#define BB_FEATURE_LINUXRC
173 //
174 //Have init enable core dumping for child processes (for debugging only) 
175 //#define BB_FEATURE_INIT_COREDUMPS
176 //
177 // Allow init to permenently chroot, and umount the old root fs
178 // just like an initrd does.  Requires a kernel patch by Werner Almesberger. 
179 // ftp://icaftp.epfl.ch/pub/people/almesber/misc/umount-root-*.tar.gz
180 //#define BB_FEATURE_INIT_CHROOT
181 //
182 //Make sure nothing is printed to the console on boot
183 #define BB_FEATURE_EXTRA_QUIET
184 //
185 //Should syslogd also provide klogd support?
186 #define BB_FEATURE_KLOGD
187 //
188 //Simple tail implementation (2k vs 6k for the full one).  Still
189 //provides 'tail -f' support -- but for only one file at a time.
190 #define BB_FEATURE_SIMPLE_TAIL
191 //
192 // Enable support for loop devices in mount
193 #define BB_FEATURE_MOUNT_LOOP
194 //
195 // Enable support for a real /etc/mtab file instead of /proc/mounts
196 //#define BB_FEATURE_MOUNT_MTAB_SUPPORT
197 //
198 // Enable support forced filesystem unmounting 
199 // (i.e. in case of an unreachable NFS system).
200 #define BB_FEATURE_MOUNT_FORCE
201 //
202 // Enable support for mounting remote NFS volumes
203 // (This does not yet work with Linux 2.[34].x kernels)
204 //#define BB_FEATURE_NFSMOUNT
205 //
206 // Enable support for creation of tar files.
207 #define BB_FEATURE_TAR_CREATE
208 //
209 // Enable support for "--exclude" for excluding files
210 #define BB_FEATURE_TAR_EXCLUDE
211 //
212 //// Enable reverse sort
213 #define BB_FEATURE_SORT_REVERSE
214 //
215 // Enable command line editing in the shell
216 #define BB_FEATURE_SH_COMMAND_EDITING
217 //
218 //Allow the shell to invoke all the compiled in BusyBox commands as if they
219 //were shell builtins.  Nice for staticly linking an emergency rescue shell
220 //amoung other thing.
221 #define BB_FEATURE_SH_STANDALONE_SHELL
222 //
223 // Enable tab completion in the shell (not yet 
224 // working very well -- so don't turn this on)
225 //#define BB_FEATURE_SH_TAB_COMPLETION
226 //
227 //Turn on extra fbset options
228 //#define BB_FEATURE_FBSET_FANCY
229 //
230 //Turn on fbset readmode support
231 //#define BB_FEATURE_FBSET_READMODE
232 //
233 // You must enable one or both of these features
234 // Support installing modules from pre 2.1 kernels
235 //#define BB_FEATURE_INSMOD_OLD_KERNEL
236 // Support installing modules from kernel versions after 2.1.18
237 #define BB_FEATURE_INSMOD_NEW_KERNEL
238 //
239 // Support module version checking
240 //#define BB_FEATURE_INSMOD_VERSION_CHECKING
241 //
242 //
243 // Enable busybox --install [-s]
244 // to create links (or symlinks) for all the commands that are 
245 // compiled into the binary.  (needs /proc filesystem)
246 // #define BB_FEATURE_INSTALLER
247 //
248 // End of Features List
249 //
250 //
251 //
252 //
253 //
254 //
255 //---------------------------------------------------
256 // Nothing beyond this point should ever be touched by 
257 // mere mortals so leave this stuff alone.
258 //
259 #ifdef BB_FEATURE_MOUNT_MTAB_SUPPORT
260 #define BB_MTAB
261 #endif
262 //
263 #if defined BB_FEATURE_FULL_REGULAR_EXPRESSIONS && (defined BB_SED || defined BB_GREP )
264 #define BB_REGEXP
265 #endif
266 //
267 #if defined BB_FEATURE_SH_COMMAND_EDITING && defined BB_SH
268 #define BB_CMDEDIT
269 #endif
270 //
271 #ifdef BB_KILLALL
272 #ifndef BB_KILL
273 #define BB_KILL
274 #endif
275 #endif
276 //
277 #ifdef BB_FEATURE_LINUXRC
278 #ifndef BB_INIT
279 #define BB_INIT
280 #define BB_LINUXRC
281 #endif
282 #endif
283 //
284 #ifdef BB_GZIP
285 #ifndef BB_GUNZIP
286 #define BB_GUNZIP
287 #endif
288 #endif
289 //
290 #if defined BB_MOUNT && defined BB_FEATURE_NFSMOUNT
291 #define BB_NFSMOUNT
292 #endif
293 //
294 #if defined BB_FEATURE_SH_COMMAND_EDITING
295 #ifndef BB_FEATURE_USE_TERMIOS
296 #define BB_FEATURE_USE_TERMIOS
297 #endif
298 #endif
299 //
300 #if defined BB_FEATURE_AUTOWIDTH
301 #ifndef BB_FEATURE_USE_TERMIOS
302 #define BB_FEATURE_USE_TERMIOS
303 #endif
304 #endif
305 //
306 #if defined BB_INSMOD
307 #ifndef BB_FEATURE_INSMOD_OLD_KERNEL
308 #define BB_FEATURE_INSMOD_NEW_KERNEL
309 #endif
310 #endif