aboutsummaryrefslogtreecommitdiff
path: root/bpkg/help.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-01-11 15:14:32 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-01-11 15:14:32 +0200
commit1c13ae4ed5d84b32c2c1a0698f9e688c312de989 (patch)
tree4977cf7df549e275205e9ced6ae283ac89c685c4 /bpkg/help.cli
parentad257079568746d71d913c6fca96852da6fe3bd6 (diff)
Documentation improvements
Diffstat (limited to 'bpkg/help.cli')
-rw-r--r--bpkg/help.cli18
1 files changed, 14 insertions, 4 deletions
diff --git a/bpkg/help.cli b/bpkg/help.cli
index 69e818c..f50841e 100644
--- a/bpkg/help.cli
+++ b/bpkg/help.cli
@@ -10,11 +10,21 @@ include <bpkg/common.cli>;
namespace bpkg
{
- class help_options: common_options
{
- /*
- "Show detailed help for a command or help topic or the list of
+ "<command> <topic>",
+
+ "\h|SYNOPSIS|
+
+ \c{\b{bpkg help} [<command> | <topic>]}
+
+ \h|DESCRIPTION|
+
+ Show the detailed help for <command> or help <topic> or a summary of
available commands and topics if none was specified."
- */
+ }
+
+ class help_options: common_options
+ {
+ //"\h|HELP OPTIONS|"
};
}