annotate Config.in @ 938:812e8c5d026f

Add config option for --help support in all commands.
author Rob Landley <rob@landley.net>
date Sun, 30 Jun 2013 15:58:24 -0500
parents 6988ece404b2
children caa05719070f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
1 mainmenu "ToyBox Configuration"
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
233
d4176f3f3835 Zap toys/Config.in and instead create generated/Config.in from contents of
Rob Landley <rob@landley.net>
parents: 144
diff changeset
11 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
12 bool
d4176f3f3835 Zap toys/Config.in and instead create generated/Config.in from contents of
Rob Landley <rob@landley.net>
parents: 144
diff changeset
13 default n
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
14 help
233
d4176f3f3835 Zap toys/Config.in and instead create generated/Config.in from contents of
Rob Landley <rob@landley.net>
parents: 144
diff changeset
15 usage: toybox [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
16
857
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
17 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
18 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
19
370
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
20 config TOYBOX_SUID
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
21 bool "SUID support"
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
22 default y
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
23 help
857
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
24 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
25 permissions for commands which do not require root access. To use
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
26 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
27 bit in the file permissions:
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
28
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
29 chown root:root toybox; chmod +s toybox
370
c7a26e26ad08 Add TOYBOX_SUID.
Rob Landley <rob@landley.net>
parents: 233
diff changeset
30
417
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
31 config TOYBOX_FLOAT
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
32 bool "Floating point support"
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
33 default y
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
34 help
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
35 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
36 require it.
57e1335e59f6 Commit 415 needs the other two files. (Oops.)
Rob Landley <rob@landley.net>
parents: 370
diff changeset
37
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
38 config TOYBOX_HELP
926
6988ece404b2 Typo fix
Rob Landley <rob@landley.net>
parents: 858
diff changeset
39 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
40 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
41 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
42 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
43
938
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
44 config TOYBOX_HELP_DASHDASH
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
45 bool "--help"
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
46 default y
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
47 depends on TOYBOX_HELP
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
48 help
812e8c5d026f Add config option for --help support in all commands.
Rob Landley <rob@landley.net>
parents: 926
diff changeset
49 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
50 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
51
710
cfdaead45479 Make internalization support optional
Felix Janda <felix.janda@posteo.de>
parents: 679
diff changeset
52 config TOYBOX_I18N
857
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
53 bool "Internationalization support"
710
cfdaead45479 Make internalization support optional
Felix Janda <felix.janda@posteo.de>
parents: 679
diff changeset
54 default y
cfdaead45479 Make internalization support optional
Felix Janda <felix.janda@posteo.de>
parents: 679
diff changeset
55 help
857
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
56 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
57
90
7c77c6ec17ee Add "make defconfig". Modify global options to start with CONFIG_TOYBOX_.
Rob Landley <rob@landley.net>
parents: 25
diff changeset
58 config TOYBOX_FREE
10
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
59 bool "Free memory unnecessarily"
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
60 default n
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
61 help
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
62 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
63 (free memory, close files, etc). To save size, toybox usually relies
da601285a86e Tweak help text.
Rob Landley <rob@landley.net>
parents: 710
diff changeset
64 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
65 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
66 clean up after itself.
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
67
90
7c77c6ec17ee Add "make defconfig". Modify global options to start with CONFIG_TOYBOX_.
Rob Landley <rob@landley.net>
parents: 25
diff changeset
68 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
69 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
70 default n
eb46bb5626cb New option parsing infrastructure (doesn't use getopt). Hook it up to
Rob Landley <rob@landley.net>
parents: 17
diff changeset
71 help
eb46bb5626cb New option parsing infrastructure (doesn't use getopt). Hook it up to
Rob Landley <rob@landley.net>
parents: 17
diff changeset
72 Enable extra checks for debugging purposes.
eb46bb5626cb New option parsing infrastructure (doesn't use getopt). Hook it up to
Rob Landley <rob@landley.net>
parents: 17
diff changeset
73
10
4d21d59f3206 Add menuconfig, plus some basic Config info, lots of which is just future
landley@driftwood
parents:
diff changeset
74 endmenu