aboutsummaryrefslogtreecommitdiff
path: root/bpkg/cfg-create.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/cfg-create.cli
parent302834a875804ff943dfb005682949fd3d404d01 (diff)
Reorganize .cli files, add man/xhtml page generation (via script for now)
Diffstat (limited to 'bpkg/cfg-create.cli')
-rw-r--r--bpkg/cfg-create.cli56
1 files changed, 56 insertions, 0 deletions
diff --git a/bpkg/cfg-create.cli b/bpkg/cfg-create.cli
new file mode 100644
index 0000000..e28778e
--- /dev/null
+++ b/bpkg/cfg-create.cli
@@ -0,0 +1,56 @@
+// file : bpkg/cfg-create.cli
+// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
+// license : MIT; see accompanying LICENSE file
+
+include <bpkg/common.cli>;
+
+"\section=1"
+"\name=bpkg-cfg-create"
+"\summary=create configuration"
+
+namespace bpkg
+{
+ {
+ "<options> <module> <conf-var>",
+
+ "\h|SYNOPSIS|
+
+ \c{\b{bpkg cfg-create} [<options>] [(<module> | <conf-var>)...]}
+
+ \h|DESCRIPTION|
+
+ The \cb{cfg-create} command creates a new \cb{bpkg} configuration with
+ the specified \cb{build2} modules and configuration variables. Unless
+ the \cb{--wipe} option is specified, \cb{cfg-create} expects the
+ configuration directory to be empty or to not exist (in which case it
+ will be created).
+
+ By default the resulting configuration loads the \cb{config}, \cb{test},
+ and \cb{install} modules. However, additional modules and, if required,
+ their configuration variables can be specified as the \cb{cfg-create}
+ arguments. For example:
+
+ \
+ bpkg cfg-create cxx config.cxx=clang++ config.install.root=/usr/local
+ \
+ "
+ }
+
+ class cfg_create_options: common_options
+ {
+ "\h|CFG-CREATE OPTIONS|"
+
+ dir_path --directory|-d (".")
+ {
+ "<dir>",
+ "Create configuration in <dir> rather than in the current working
+ directory."
+ }
+
+ bool --wipe
+ {
+ "Wipe the configuration directory clean before creating the new
+ configuration."
+ }
+ };
+}