annotate Config.in @ 1776:7bf68329eb3b draft default tip

Repository switched to git at https://github.com/landley/toybox
author Rob Landley <rob@landley.net>
date Thu, 09 Apr 2015 02:28:32 -0500
parents b84024067049
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1487
87d95673a398 Typo from the dawn of time: toybox is not capitalized the way BusyBox was.
Rob Landley <rob@landley.net>
parents: 1439
diff changeset
1 mainmenu "Toybox Configuration"
10
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
2
679
ed6ce9f11bf7 Put the commands at the start of menuconfig and the toybox library options at the end. (Aesthetic tweak.)
Rob Landley <rob@landley.net>
parents: 653
diff changeset
3
ed6ce9f11bf7 Put the commands at the start of menuconfig and the toybox library options at the end. (Aesthetic tweak.)
Rob Landley <rob@landley.net>
parents: 653
diff changeset
4 source generated/Config.probed
ed6ce9f11bf7 Put the commands at the start of menuconfig and the toybox library options at the end. (Aesthetic tweak.)
Rob Landley <rob@landley.net>
parents: 653
diff changeset
5 source generated/Config.in
ed6ce9f11bf7 Put the commands at the start of menuconfig and the toybox library options at the end. (Aesthetic tweak.)
Rob Landley <rob@landley.net>
parents: 653
diff changeset
6
ed6ce9f11bf7 Put the commands at the start of menuconfig and the toybox library options at the end. (Aesthetic tweak.)
Rob Landley <rob@landley.net>
parents: 653
diff changeset
7 comment ""
ed6ce9f11bf7 Put the commands at the start of menuconfig and the toybox library options at the end. (Aesthetic tweak.)
Rob Landley <rob@landley.net>
parents: 653
diff changeset
8
653
2986aa63a021 Move commands into "posix", "lsb", and "other" menus/directories.
Rob Landley <rob@landley.net>
parents: 496
diff changeset
9 menu "Toybox global settings"
10
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
10
1439
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
11 # This entry controls the multiplexer, disabled for single command builds
233
d4176f3f3835 Zap toys/Config.in and instead create generated/Config.in from contents of
Rob Landley <rob@landley.net>
parents: 144
diff changeset
12 config TOYBOX
d4176f3f3835 Zap toys/Config.in and instead create generated/Config.in from contents of
Rob Landley <rob@landley.net>
parents: 144
diff changeset
13 bool
1032
40d0c96a8e89 Add scripts/single.sh to build individual non-multiplexed standalone commands.
Rob Landley <rob@landley.net>
parents: 956
diff changeset
14 default y
144
1fbc50374a30 Promote help to global config option, teach error_exit() to output usage message when called
Rob Landley <rob@landley.net>
parents: 90
diff changeset
15 help
1348
63d8181b0f92 Update toybox help to say how to install the static binary.
Rob Landley <rob@landley.net>
parents: 1032
diff changeset
16 usage: toybox [--long | [command] [arguments...]]
144
1fbc50374a30 Promote help to global config option, teach error_exit() to output usage message when called
Rob Landley <rob@landley.net>
parents: 90
diff changeset
17
857
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
18 With no arguments, shows available commands. First argument is
233
d4176f3f3835 Zap toys/Config.in and instead create generated/Config.in from contents of
Rob Landley <rob@landley.net>
parents: 144
diff changeset
19 name of a command to run, followed by any arguments to that command.
144
1fbc50374a30 Promote help to global config option, teach error_exit() to output usage message when called
Rob Landley <rob@landley.net>
parents: 90
diff changeset
20
1348
63d8181b0f92 Update toybox help to say how to install the static binary.
Rob Landley <rob@landley.net>
parents: 1032
diff changeset
21 --long Show path to each command
63d8181b0f92 Update toybox help to say how to install the static binary.
Rob Landley <rob@landley.net>
parents: 1032
diff changeset
22
63d8181b0f92 Update toybox help to say how to install the static binary.
Rob Landley <rob@landley.net>
parents: 1032
diff changeset
23 To install command symlinks, try:
63d8181b0f92 Update toybox help to say how to install the static binary.
Rob Landley <rob@landley.net>
parents: 1032
diff changeset
24 for i in $(/bin/toybox --long); do ln -s /bin/toybox $i; done
63d8181b0f92 Update toybox help to say how to install the static binary.
Rob Landley <rob@landley.net>
parents: 1032
diff changeset
25
370
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
26 config TOYBOX_SUID
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
27 bool "SUID support"
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
28 default y
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
29 help
857
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
30 Support for the Set User ID bit, to install toybox suid root and drop
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
31 permissions for commands which do not require root access. To use
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
32 this change ownership of the file to the root user and set the suid
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
33 bit in the file permissions:
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
34
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
35 chown root:root toybox; chmod +s toybox
370
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
36
1660
b84024067049 This patch adds a TOYBOX_SELINUX configuration option to control both
Elliott Hughes <enh@google.com>
parents: 1528
diff changeset
37 config TOYBOX_SELINUX
b84024067049 This patch adds a TOYBOX_SELINUX configuration option to control both
Elliott Hughes <enh@google.com>
parents: 1528
diff changeset
38 bool "SELinux support"
b84024067049 This patch adds a TOYBOX_SELINUX configuration option to control both
Elliott Hughes <enh@google.com>
parents: 1528
diff changeset
39 default n
b84024067049 This patch adds a TOYBOX_SELINUX configuration option to control both
Elliott Hughes <enh@google.com>
parents: 1528
diff changeset
40 help
b84024067049 This patch adds a TOYBOX_SELINUX configuration option to control both
Elliott Hughes <enh@google.com>
parents: 1528
diff changeset
41 Include SELinux options in commands such as ls, and add
b84024067049 This patch adds a TOYBOX_SELINUX configuration option to control both
Elliott Hughes <enh@google.com>
parents: 1528
diff changeset
42 SELinux-specific commands such as chcon.
b84024067049 This patch adds a TOYBOX_SELINUX configuration option to control both
Elliott Hughes <enh@google.com>
parents: 1528
diff changeset
43
417
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
44 config TOYBOX_FLOAT
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
45 bool "Floating point support"
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
46 default y
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
47 help
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
48 Include floating point support infrastructure and commands that
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
49 require it.
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
50
858
34ac05521d94 Move guts of help command into show_help() in lib/help.c, with config TOYBOX_HELP controlling infrastructure.
Rob Landley <rob@landley.net>
parents: 857
diff changeset
51 config TOYBOX_HELP
926
6988ece404b2 Typo fix
Rob Landley <rob@landley.net>
parents: 858
diff changeset
52 bool "Help messages"
858
34ac05521d94 Move guts of help command into show_help() in lib/help.c, with config TOYBOX_HELP controlling infrastructure.
Rob Landley <rob@landley.net>
parents: 857
diff changeset
53 default y
34ac05521d94 Move guts of help command into show_help() in lib/help.c, with config TOYBOX_HELP controlling infrastructure.
Rob Landley <rob@landley.net>
parents: 857
diff changeset
54 help
34ac05521d94 Move guts of help command into show_help() in lib/help.c, with config TOYBOX_HELP controlling infrastructure.
Rob Landley <rob@landley.net>
parents: 857
diff changeset
55 Include help text for each command.
34ac05521d94 Move guts of help command into show_help() in lib/help.c, with config TOYBOX_HELP controlling infrastructure.
Rob Landley <rob@landley.net>
parents: 857
diff changeset
56
938
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
57 config TOYBOX_HELP_DASHDASH
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
58 bool "--help"
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
59 default y
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
60 depends on TOYBOX_HELP
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
61 help
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
62 Support --help argument in all commands, even ones with a NULL
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
63 optstring. Produces the same output as "help command".
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
64
710
cfdaead45479 Make internalization support optional
Felix Janda <felix.janda@posteo.de>
parents: 679
diff changeset
65 config TOYBOX_I18N
857
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
66 bool "Internationalization support"
710
cfdaead45479 Make internalization support optional
Felix Janda <felix.janda@posteo.de>
parents: 679
diff changeset
67 default y
cfdaead45479 Make internalization support optional
Felix Janda <felix.janda@posteo.de>
parents: 679
diff changeset
68 help
857
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
69 Support for UTF-8 character sets, and some locale support.
710
cfdaead45479 Make internalization support optional
Felix Janda <felix.janda@posteo.de>
parents: 679
diff changeset
70
90
7c77c6ec17ee Add "make defconfig". Modify global options to start with CONFIG_TOYBOX_.
Rob Landley <rob@landley.net>
parents: 25
diff changeset
71 config TOYBOX_FREE
10
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
72 bool "Free memory unnecessarily"
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
73 default n
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
74 help
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
75 When a program exits, the operating system will clean up after it
857
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
76 (free memory, close files, etc). To save size, toybox usually relies
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
77 on this behavior. If you're running toybox under a debugger or
10
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
78 without a real OS (ala newlib+libgloss), enable this to make toybox
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
79 clean up after itself.
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
80
1528
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
81 config TOYBOX_NORECURSE
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
82 bool "Disable recursive execution"
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
83 default n
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
84 help
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
85 When one toybox command calls another, usually it just calls the new
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
86 command's main() function rather than searching the $PATH and calling
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
87 exec on another file (which is much slower).
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
88
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
89 This disables that optimization, so toybox will run external commands
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
90 even when it has a built-in version of that command. This requires
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
91 toybox symlinks to be installed in the $PATH, or re-invoking the
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
92 "toybox" multiplexer command by name.
ec07449e8e4a Add TOYBOX_NORECURSE so xexec() won't make internal function calls.
Rob Landley <rob@landley.net>
parents: 1487
diff changeset
93
90
7c77c6ec17ee Add "make defconfig". Modify global options to start with CONFIG_TOYBOX_.
Rob Landley <rob@landley.net>
parents: 25
diff changeset
94 config TOYBOX_DEBUG
25
eb46bb5626cb New option parsing infrastructure (doesn't use getopt). Hook it up to
Rob Landley <rob@landley.net>
parents: 17
diff changeset
95 bool "Debugging tests"
eb46bb5626cb New option parsing infrastructure (doesn't use getopt). Hook it up to
Rob Landley <rob@landley.net>
parents: 17
diff changeset
96 default n
eb46bb5626cb New option parsing infrastructure (doesn't use getopt). Hook it up to
Rob Landley <rob@landley.net>
parents: 17
diff changeset
97 help
1439
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
98 Enable extra checks for debugging purposes. All of them catch
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
99 things that can only go wrong at development time, not runtime.
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
100
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
101 config TOYBOX_UID_SYS
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
102 int "First system UID"
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
103 default 100
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
104 help
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
105 When commands like useradd/groupadd allocate system IDs, start here.
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
106
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
107 config TOYBOX_UID_USR
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
108 int "First user UID"
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
109 default 500
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
110 help
ed28d4d9558d Cleanups on useradd/groupadd/groupdel, and put TOYBOX_UID_SYS and TOYBOX_UID_USR in the top level Config.
Rob Landley <rob@landley.net>
parents: 1348
diff changeset
111 When commands like useradd/groupadd allocate user IDs, start here.
10
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
112 endmenu