aboutsummaryrefslogtreecommitdiff
path: root/bdep/help.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2018-03-01 16:37:07 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2018-03-01 16:37:07 +0200
commit100150a3598d931fbbee361c33374cd5b95a8d86 (patch)
treedafe8fdd5acd73c3832756faccad0a34c8f807ee /bdep/help.cli
parentdeb9b06626141481681cd82e08eddb6627a9a81c (diff)
Setup documentation infrastructure
Diffstat (limited to 'bdep/help.cli')
-rw-r--r--bdep/help.cli30
1 files changed, 30 insertions, 0 deletions
diff --git a/bdep/help.cli b/bdep/help.cli
new file mode 100644
index 0000000..c62a604
--- /dev/null
+++ b/bdep/help.cli
@@ -0,0 +1,30 @@
+// file : bdep/help.cli
+// copyright : Copyright (c) 2014-2017 Code Synthesis Ltd
+// license : MIT; see accompanying LICENSE file
+
+include <bdep/common.cli>;
+
+"\section=1"
+"\name=bdep-help"
+"\summary=show help for a command or help topic"
+
+namespace bdep
+{
+ {
+ "<command> <topic>",
+
+ "\h|SYNOPSIS|
+
+ \c{\b{bdep 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|"
+ };
+}