aboutsummaryrefslogtreecommitdiff
path: root/bpkg/bpkg-options.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2015-11-25 09:19:19 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2015-11-25 09:19:19 +0200
commit87e476cf192b70c133a1bf00efa8586348326092 (patch)
tree88d70237857ceec7416c8edd7a3d8cf2d8093fb5 /bpkg/bpkg-options.cli
parentb244bc6ef9d36d651c40de818ef33246919fc859 (diff)
New command line help setup
Diffstat (limited to 'bpkg/bpkg-options.cli')
-rw-r--r--bpkg/bpkg-options.cli42
1 files changed, 32 insertions, 10 deletions
diff --git a/bpkg/bpkg-options.cli b/bpkg/bpkg-options.cli
index 5da4213..b0f14e3 100644
--- a/bpkg/bpkg-options.cli
+++ b/bpkg/bpkg-options.cli
@@ -10,25 +10,39 @@ include <bpkg/common-options.cli>;
namespace bpkg
{
- class bpkg_options: common_options
{
- bool --help;
- bool --version;
- };
+ "<command> <topic> <common-options> <command-options> <command-args>",
+
+ "\h|SYNOPSIS|
+
+ \cb{bpkg --help}\n
+ \cb{bpkg --version}\n
+ \c{\b{bpkg help} [<command>|<topic>]}\n
+ \c{\b{bpkg} [<common-options>] <command> [<command-options>] <command-args>}
+
+ \h|DESCRIPTION|
+
+ @@ TODO
+
+ Note that the common options can also be specified as part of the
+ command-specific options."
+ }
- class bpkg_commands
+ class commands
{
+ "\h|COMMANDS|"
+
bool help
{
"[<topic>]",
- "Show detailed help for a command or help topic.",
+ "Show help for a command or help topic \- \l{bpkg-help(1)}.",
""
};
bool build
{
"<pkg>...",
- "Build one or more packages.",
+ "Build one or more packages \- \l{bpkg-build-options(1)}.",
""
};
@@ -140,11 +154,19 @@ namespace bpkg
// Make sure these don't conflict with command names above.
//
- class bpkg_topics
+ class topics
{
- bool common
+ "\h|HELP TOPICS|"
+
+ bool common-options
{
- "Detailed description of common options."
+ "Options common for all commands \- \l{bpkg-common-options(1)}."
};
};
+
+ class options: common_options
+ {
+ bool --help;
+ bool --version;
+ };
}