1bpkg-common-options(1) General Commands Manual bpkg-common-options(1)
2
6 bpkg-common-options - details on common options
7
9 bpkg [common-options] ...
10
12 The common options control behavior that is common to all or most of
13 the bpkg commands. They can be specified either before the command or
14 after, together with the command-specific options.
15
17 -v Print essential underlying commands being executed. This is
18 equivalent to --verbose 2.
19 -V Print all underlying commands being executed. This is equivalent
21 to --verbose 3.
22 --quiet|-q
24 Run quietly, only printing error messages. This is equivalent to
25 --verbose 0.
26 --verbose level
28 Set the diagnostics verbosity to level between 0 and 6. Level 0
29 disables any non-error messages while level 6 produces lots of
30 information, with level 1 being the default. The following addi‐
31 tional types of diagnostics are produced at each level:
32 1. High-level information messages.
34 2. Essential underlying commands being executed.
36 3. All underlying commands being executed.
38 4. Information that could be helpful to the user.
40 5. Information that could be helpful to the developer.
42 6. Even more detailed information.
44 --jobs|-j num
46 Number of jobs to perform in parallel. If this option is not
47 specified or specified with the 0 value, then the number of
48 available hardware threads is used. This option is also propa‐
49 gated when performing build system operations such as update,
50 test, etc.
51 --no-result
53 Don't print informational messages about the outcome of perform‐
54 ing a command.
55 --no-progress
57 Suppress progress indicators for long-lasting operations, such
58 as network transfers, building, etc.
59 --build path
61 The build program to be used to build packages. This should be
62 the path to the build2 b executable. You can also specify addi‐
63 tional options that should be passed to the build program with
64 --build-option.
65 If the build program is not explicitly specified, then bpkg will
67 by default use b plus an executable suffix if one was specified
68 when building bpkg. So, for example, if bpkg name was set to
69 bpkg-1.0, then it will look for b-1.0.
70 --build-option opt
72 Additional option to be passed to the build program. See --build
73 for more information on the build program. Repeat this option to
74 specify multiple build options.
75 --fetch path
77 The fetch program to be used to download resources. Currently,
78 bpkg recognizes curl, wget, and fetch. Note that the last compo‐
79 nent of path must contain one of these names as a substring in
80 order for bpkg to recognize which program is being used. You can
81 also specify additional options that should be passed to the
82 fetch program with --fetch-option.
83 If the fetch program is not specified, then bpkg will try to
85 discover if one of the above programs is available and use that.
86 Currently, bpkg has the following preference order: wget 1.16 or
87 higher (supports --show-progress), curl, wget, and fetch.
88 --fetch-option opt
90 Additional option to be passed to the fetch program. See --fetch
91 for more information on the fetch program. Repeat this option to
92 specify multiple fetch options.
93 --fetch-timeout sec
95 The fetch and fetch-like (for example, git) program timeout.
96 While the exact semantics of the value depends on the program
97 used, at a minimum it specifies in seconds the maximum time that
98 can be spent without any network activity.
99 Specifically, it is translated to the --max-time option for curl
101 and to the --timeout option for wget and fetch. For git over
102 HTTP/HTTPS this semantics is achieved using the
103 http.lowSpeedLimit=1 http.lowSpeedTime=sec configuration values
104 (the git:// and ssh:// protocols currently do not support time‐
105 outs).
106 See --fetch and --git for more information on the fetch pro‐
108 grams.
109 --pkg-proxy url
111 HTTP proxy server to use when fetching package manifests and ar‐
112 chives from remote pkg repositories. If specified, the proxy url
113 must be in the http://host[:port] form. If port is omitted, 80
114 is used by default.
115 Note that to allow caching, the proxied https:// URLs are con‐
117 verted to http:// in order to prevent the fetch program from
118 tunneling (which is the standard approach for proxying HTTPS).
119 If both HTTP and HTTPS repositories are used, it is assumed that
120 the proxy server can figure out which URLs need to be converted
121 back to https:// based on the request information (for example,
122 host name). For security, this mechanism should only be used
123 with signed repositories or when the proxy is located inside a
124 trusted network.
125 --git path
127 The git program to be used to fetch git repositories. You can
128 also specify additional options that should be passed to the git
129 program with --git-option.
130 If the git program is not explicitly specified, then bpkg will
132 use git by default.
133 --git-option opt
135 Additional common option to be passed to the git program. Note
136 that the common options are the ones that precede the git com‐
137 mand. See --git for more information on the git program. Repeat
138 this option to specify multiple git options.
139 --sha256 path
141 The sha256 program to be used to calculate SHA256 sums. Cur‐
142 rently, bpkg recognizes sha256, sha256sum, and shasum. Note that
143 the last component of path must contain one of these names as a
144 substring in order for bpkg to recognize which program is being
145 used. You can also specify additional options that should be
146 passed to the sha256 program with --sha256-option.
147 If the sha256 program is not specified, then bpkg will try to
149 discover if one of the above programs is available and use that.
150 Currently, bpkg has the following preference order: sha256,
151 sha256sum, and shasum.
152 --sha256-option opt
154 Additional option to be passed to the sha256 program. See
155 --sha256 for more information on the sha256 program. Repeat this
156 option to specify multiple sha256 options.
157 --tar path
159 The tar program to be used to extract package archives. For
160 example, gtar or bsdtar. You can also specify additional options
161 that should be passed to the tar program with --tar-option. If
162 the tar program is not explicitly specified, then bpkg will use
163 tar by default.
164 --tar-option opt
166 Additional option to be passed to the tar program. See --tar for
167 more information on the tar program. Repeat this option to spec‐
168 ify multiple tar options.
169 --openssl path
171 The openssl program to be used for crypto operations. You can
172 also specify additional options that should be passed to the
173 openssl program with --openssl-option. If the openssl program is
174 not explicitly specified, then bpkg will use openssl by default.
175 The --openssl* values can be optionally qualified with the
177 openssl command in the command:value form. This makes the value
178 only applicable to the specific command, for example:
179 bpkg rep-create \
181 --openssl rsautl:/path/to/openssl \
182 --openssl-option rsautl:-engine \
183 --openssl-option rsautl:pkcs11 \
184 ...
185 An unqualified value that contains a colon can be specified as
187 qualified with an empty command, for example, --openssl
188 :C:\bin\openssl. To see openssl commands executed by bpkg, use
189 the verbose mode (-v option).
190 --openssl-option opt
192 Additional option to be passed to the openssl program. See
193 --openssl for more information on the openssl program. The val‐
194 ues can be optionally qualified with the openssl command, as
195 discussed in --openssl. Repeat this option to specify multiple
196 openssl options.
197 --auth type
199 Types of repositories to authenticate. Valid values for this
200 option are none, remote, all. By default only remote reposito‐
201 ries are authenticated. You can request authentication of local
202 repositories by passing all or disable authentication completely
203 by passing none.
204 --trust fingerprint
206 Trust repository certificate with a SHA256 fingerprint. Such a
207 certificate is trusted automatically, without prompting the user
208 for a confirmation. Repeat this option to trust multiple cer‐
209 tificates.
210 Note that by default openssl prints a SHA1 fingerprint and to
212 obtain a SHA256 one you will need to pass the -sha256 option,
213 for example:
214 openssl x509 -sha256 -fingerprint -noout -in cert.pem
216 --trust-yes
218 Assume the answer to all authentication prompts is yes.
219 --trust-no
221 Assume the answer to all authentication prompts is no.
222 --pager path
224 The pager program to be used to show long text. Commonly used
225 pager programs are less and more. You can also specify addi‐
226 tional options that should be passed to the pager program with
227 --pager-option. If an empty string is specified as the pager
228 program, then no pager will be used. If the pager program is not
229 explicitly specified, then bpkg will try to use less. If it is
230 not available, then no pager will be used.
231 --pager-option opt
233 Additional option to be passed to the pager program. See --pager
234 for more information on the pager program. Repeat this option to
235 specify multiple pager options.
236 --options-file file
238 Read additional options from file. Each option should appear on
239 a separate line optionally followed by space or equal sign (=)
240 and an option value. Empty lines and lines starting with # are
241 ignored. Option values can be enclosed in double (") or single
242 (') quotes to preserve leading and trailing whitespaces as well
243 as to specify empty values. If the value itself contains trail‐
244 ing or leading quotes, enclose it with an extra pair of quotes,
245 for example '"x"'. Non-leading and non-trailing quotes are
246 interpreted as being part of the option value.
247 The semantics of providing options in a file is equivalent to
249 providing the same set of options in the same order on the com‐
250 mand line at the point where the --options-file option is speci‐
251 fied except that the shell escaping and quoting is not required.
252 Repeat this option to specify more than one options file.
253 --default-options dir
255 The directory to load additional default options files from.
256 --no-default-options
258 Don't load default options files.
259
261 Send bug reports to the users@build2.org mailing list.
262
264 Copyright (c) 2014-2020 the build2 authors.
265 Permission is granted to copy, distribute and/or modify this document
267 under the terms of the MIT License.
268bpkg 0.13.0 July 2020 bpkg-common-options(1)