aboutsummaryrefslogtreecommitdiff
path: root/bpkg/pkg-build.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-01-11 10:04:02 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-01-11 10:04:02 +0200
commitad257079568746d71d913c6fca96852da6fe3bd6 (patch)
treed7a59392a1159c630c4fd0ccad816e9fd3acadf3 /bpkg/pkg-build.cli
parent302834a875804ff943dfb005682949fd3d404d01 (diff)
Reorganize .cli files, add man/xhtml page generation (via script for now)
Diffstat (limited to 'bpkg/pkg-build.cli')
-rw-r--r--bpkg/pkg-build.cli63
1 files changed, 63 insertions, 0 deletions
diff --git a/bpkg/pkg-build.cli b/bpkg/pkg-build.cli
new file mode 100644
index 0000000..54e0252
--- /dev/null
+++ b/bpkg/pkg-build.cli
@@ -0,0 +1,63 @@
+// file : bpkg/pkg-build.cli
+// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
+// license : MIT; see accompanying LICENSE file
+
+include <bpkg/configuration.cli>;
+
+"\section=1"
+"\name=bpkg-pkg-build"
+"\summary=build one or more packages"
+
+namespace bpkg
+{
+ {
+ "<options> <pkg> <ver> <file> <dir>",
+
+ "\h|SYNOPSIS|
+
+ \c{\b{bpkg pkg-build} [<options>] (<pkg>[/<ver>] | <file> | <dir>)...}
+
+ \h|DESCRIPTION|
+
+ The \cb{pkg-build} command builds one or more packages including all their
+ prerequisites. Each package can be specified as just the name (<pkg>) with
+ optional package version (<ver>) in which case the package will be
+ automatically fetched from one of the configuration's source repositories
+ (see the \cb{cfg-add} and \cb{cfg-fetch} commands). Alternatively, the
+ package can be specified as either the path to the package source archive
+ (<file>) or package source directory (<dir>). See the \cb{pkg-fetch} and
+ \cb{pkg-unpack} commands for more information on the semantics of
+ specifying the package as an archive or directory.
+
+ Packages that are specified explicitly on the command line will be
+ \i{held}, that is, they will not be considered for automatic removal if
+ they no longer have any dependents. Packages that are specified with the
+ explicit package version (<ver>) or as an archive or directory, will, in
+ addition, have their versions held, that is, they will not be
+ automatically upgraded.
+
+ The \cb{pkg-build} command also supports several \cb{--*-only} options
+ that allow you to limit the amount of work that will be done."
+ }
+
+ class pkg_build_options: configuration_options
+ {
+ "\h|PKG-BUILD OPTIONS|"
+
+ bool --yes|-y
+ {
+ "Assume the answer to all prompts is \cb{yes}."
+ }
+
+ bool --configure-only|-c
+ {
+ "Configure all the packages but don't update."
+ }
+
+ bool --print-only|-p
+ {
+ "Print to \cb{STDOUT} what would be done without actually doing
+ anything."
+ }
+ };
+}