aboutsummaryrefslogtreecommitdiff
path: root/bpkg/bpkg.cli
diff options
context:
space:
mode:
Diffstat (limited to 'bpkg/bpkg.cli')
-rw-r--r--bpkg/bpkg.cli160
1 files changed, 160 insertions, 0 deletions
diff --git a/bpkg/bpkg.cli b/bpkg/bpkg.cli
new file mode 100644
index 0000000..e9611ff
--- /dev/null
+++ b/bpkg/bpkg.cli
@@ -0,0 +1,160 @@
+// file : bpkg/bpkg.cli
+// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
+// license : MIT; see accompanying LICENSE file
+
+include <bpkg/common.cli>;
+
+"\section=1"
+"\name=bpkg"
+"\summary=build2 package manager"
+
+namespace bpkg
+{
+ {
+ "<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 commands
+ {
+ "\h|COMMANDS|"
+
+ bool help
+ {
+ "[<topic>]",
+ "Show help for a command or help topic \- \l{bpkg-help(1)}.",
+ ""
+ }
+
+ bool cfg-create|create
+ {
+ "<dir>",
+ "Create configuration.",
+ ""
+ }
+
+ bool cfg-add|add
+ {
+ "<rep>",
+ "Add repository to configuration.",
+ ""
+ }
+
+ bool cfg-fetch|fetch
+ {
+ "Fetch list of available packages."
+ }
+
+ bool pkg-status|status
+ {
+ "Print package status."
+ }
+
+ bool pkg-build|build
+ {
+ "Build package \- \l{bpkg-pkg-build(1)}."
+ }
+
+ bool pkg-drop|drop
+ {
+ "Drop package."
+ }
+
+ bool pkg-install|install
+ {
+ "Install package."
+ }
+
+ bool pkg-uninstall|uninstall
+ {
+ "Uninstall package."
+ }
+
+ bool pkg-update|update
+ {
+ "Update package."
+ }
+
+ bool pkg-clean|clean
+ {
+ "Clean package."
+ }
+
+ bool pkg-verify
+ {
+ "<archive>",
+ "Verify archive is a valid package.",
+ ""
+ }
+
+ bool pkg-fetch
+ {
+ "<pkg>/<ver>",
+ "Fetch package archive.",
+ ""
+ }
+
+ bool pkg-unpack
+ {
+ "Unpack package archive."
+ }
+
+ bool pkg-configure
+ {
+ "Configure package."
+ }
+
+ bool pkg-disfigure
+ {
+ "Disfigure package."
+ }
+
+ bool pkg-purge
+ {
+ "Purge package."
+ }
+
+ bool rep-info
+ {
+ "Print information about repository."
+ }
+
+ bool rep-create
+ {
+ "[<dir>]",
+ "Generate repository packages manifest.",
+ ""
+ }
+ };
+
+ // Make sure these don't conflict with command names above.
+ //
+ class topics
+ {
+ "\h|HELP TOPICS|"
+
+ bool common-options
+ {
+ "Details on common options \- \l{bpkg-common-options(1)}."
+ }
+ };
+
+ class options: common_options
+ {
+ bool --help;
+ bool --version;
+ };
+}