1bpkg-cfg-create(1) General Commands Manual bpkg-cfg-create(1)
2
6 bpkg-cfg-create - create configuration
7
9 bpkg cfg-create|create [options] [cfg-args]
10 bpkg cfg-create|create [options] --existing|-e
11 cfg-args = (module | cfg-var)...
13
15 The cfg-create command creates a new bpkg configuration with the speci‐
16 fied build2 modules and configuration variables (the first form) or
17 initializes one based on an existing build system configuration (the
18 second form). The bpkg configuration itself is a build system configu‐
19 ration; see build system driver (b(1)) create meta-operation for
20 details.
21 Unless the --existing|-e or --wipe option is specified, cfg-create
23 expects the configuration directory to be empty or to not exist (in
24 which case it will be created).
25 By default, the configuration created with the first form loads the
27 config, test, dist, and install modules. However, additional modules
28 and, if required, their configuration variables can be specified as the
29 cfg-create arguments. For example:
30 bpkg create cxx config.cxx=clang++ config.install.root=/usr/local
32 By default, bpkg appends .config to the names of the modules that you
34 specify so that only their configurations are loaded. You can override
35 this behavior by specifying the period (.) after the module name. You
36 can also instruct bpkg to use the optional module load by prefixing the
37 module name with the question mark (?). For example:
38 bpkg create cxx. "?cli"
40
42 --directory|-d dir
43 Create the configuration in dir rather than in the current work‐
44 ing directory.
45 --existing|-e
47 Initialize a bpkg configuration based on an existing build sys‐
48 tem configuration.
49 --wipe Wipe the configuration directory clean before creating the new
51 configuration. For safety, this option requires that you spec‐
52 ify the configuration directory explicitly with --directory|-d.
53
55 The common options are summarized below with a more detailed descrip‐
56 tion available in bpkg-common-options(1).
57 -v Print essential underlying commands being executed.
59 -V Print all underlying commands being executed.
61 --quiet|-q
63 Run quietly, only printing error messages.
64 --verbose level
66 Set the diagnostics verbosity to level between 0 and 6.
67 --jobs|-j num
69 Number of jobs to perform in parallel.
70 --no-result
72 Don't print informational messages about the outcome of perform‐
73 ing a command.
74 --no-progress
76 Suppress progress indicators for long-lasting operations, such
77 as network transfers, building, etc.
78 --build path
80 The build program to be used to build packages.
81 --build-option opt
83 Additional option to be passed to the build program.
84 --fetch path
86 The fetch program to be used to download resources.
87 --fetch-option opt
89 Additional option to be passed to the fetch program.
90 --fetch-timeout sec
92 The fetch and fetch-like (for example, git) program timeout.
93 --git path
95 The git program to be used to fetch git repositories.
96 --git-option opt
98 Additional common option to be passed to the git program.
99 --sha256 path
101 The sha256 program to be used to calculate SHA256 sums.
102 --sha256-option opt
104 Additional option to be passed to the sha256 program.
105 --tar path
107 The tar program to be used to extract package archives.
108 --tar-option opt
110 Additional option to be passed to the tar program.
111 --openssl path
113 The openssl program to be used for crypto operations.
114 --openssl-option opt
116 Additional option to be passed to the openssl program.
117 --auth type
119 Types of repositories to authenticate.
120 --trust fingerprint
122 Trust repository certificate with a SHA256 fingerprint.
123 --trust-yes
125 Assume the answer to all authentication prompts is yes.
126 --trust-no
128 Assume the answer to all authentication prompts is no.
129 --pager path
131 The pager program to be used to show long text.
132 --pager-option opt
134 Additional option to be passed to the pager program.
135 --options-file file
137 Read additional options from file.
138 --default-options dir
140 The directory to load additional default options files from.
141 --no-default-options
143 Don't load default options files.
144
146 See bpkg-default-options-files(1) for an overview of the default
147 options files. For the cfg-create command the search start directory is
148 the parent directory of the new configuration. The following options
149 files are searched for in each directory and, if found, loaded in the
150 order listed:
151 bpkg.options
153 bpkg-cfg-create.options
154 The following cfg-create command options cannot be specified in the
156 default options files:
157 --directory|-d
159 --wipe
160
162 Send bug reports to the users@build2.org mailing list.
163
165 Copyright (c) 2014-2019 Code Synthesis Ltd
166 Permission is granted to copy, distribute and/or modify this document
168 under the terms of the MIT License.
169bpkg 0.12.0 November 2019 bpkg-cfg-create(1)