diff options
author | Sami Kerola <kerolasa@iki.fi> | 2011-09-17 12:52:32 +0200 |
---|---|---|
committer | Sami Kerola <kerolasa@iki.fi> | 2011-09-17 15:07:52 +0200 |
commit | 6f162034d0fc9a49ab1dcf2b773fa9677215cba3 (patch) | |
tree | e6f0572f92578723a0c385cb6acd12b4aca13960 /Documentation | |
parent | 7678c735b200d80b888810f4a72a31a51425b8eb (diff) | |
download | util-linux-6f162034d0fc9a49ab1dcf2b773fa9677215cba3.tar.gz |
build-sys: fixes to USAGE_* macros
The USAGE_BEGIN_TAIL is removed as unnecessary.
In between command specific options and --help & --version
USAGE_SEPARATOR is inserted. For now the separator is empty line.
The USAGE_MAN_TAIL is changed to take an argument.
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/howto-usage-function.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/howto-usage-function.txt b/Documentation/howto-usage-function.txt index f717293d..18ee3de8 100644 --- a/Documentation/howto-usage-function.txt +++ b/Documentation/howto-usage-function.txt @@ -56,6 +56,7 @@ Options: description on two, or multiple lines, where the consecutive lines are intended by two spaces -f, --foobar next option description resets indent + -h, --help display this help and exit -V, --version output version information and exit @@ -83,9 +84,8 @@ translation work. The argument, e.g. `arg', can be better. For example if an option is expecting number as argument a `num' is suitable argument description. -Order of the options has no special meaning. It is good idea to write -options that are somehow related next to each other. Usually --help and ---version, in this order, are last options in print out. +Order of the options has no special meaning, with a exception of --help and +--version which are expected to be last ones of the list. Last line of the usage print out is either empty, or a message informing about manual page. For example: `For more details see example(1).' In |