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 or some of its parts. Note that if this option is
55 specified, then for certain long-running command parts progress
56 is displayed instead, unless suppressed with --no-progress.
57 --no-progress
59 Suppress progress indicators for long-lasting operations, such
60 as network transfers, building, etc.
61 --build path
63 The build program to be used to build packages. This should be
64 the path to the build2 b executable. You can also specify addi‐
65 tional options that should be passed to the build program with
66 --build-option.
67 If the build program is not explicitly specified, then bpkg will
69 by default use b plus an executable suffix if one was specified
70 when building bpkg. So, for example, if bpkg name was set to
71 bpkg-1.0, then it will look for b-1.0.
72 --build-option opt
74 Additional option to be passed to the build program. See --build
75 for more information on the build program. Repeat this option to
76 specify multiple build options.
77 --fetch path
79 The fetch program to be used to download resources. Currently,
80 bpkg recognizes curl, wget, and fetch. Note that the last compo‐
81 nent of path must contain one of these names as a substring in
82 order for bpkg to recognize which program is being used. You can
83 also specify additional options that should be passed to the
84 fetch program with --fetch-option.
85 If the fetch program is not specified, then bpkg will try to
87 discover if one of the above programs is available and use that.
88 Currently, bpkg has the following preference order: wget 1.16 or
89 higher (supports --show-progress), curl, wget, and fetch.
90 --fetch-option opt
92 Additional option to be passed to the fetch program. See --fetch
93 for more information on the fetch program. Repeat this option to
94 specify multiple fetch options.
95 --fetch-timeout sec
97 The fetch and fetch-like (for example, git) program timeout.
98 While the exact semantics of the value depends on the program
99 used, at a minimum it specifies in seconds the maximum time that
100 can be spent without any network activity.
101 Specifically, it is translated to the --max-time option for curl
103 and to the --timeout option for wget and fetch. For git over
104 HTTP/HTTPS this semantics is achieved using the
105 http.lowSpeedLimit=1 http.lowSpeedTime=sec configuration values
106 (the git:// and ssh:// protocols currently do not support time‐
107 outs).
108 See --fetch and --git for more information on the fetch pro‐
110 grams.
111 --pkg-proxy url
113 HTTP proxy server to use when fetching package manifests and ar‐
114 chives from remote pkg repositories. If specified, the proxy url
115 must be in the http://host[:port] form. If port is omitted, 80
116 is used by default.
117 Note that to allow caching, the proxied https:// URLs are con‐
119 verted to http:// in order to prevent the fetch program from
120 tunneling (which is the standard approach for proxying HTTPS).
121 If both HTTP and HTTPS repositories are used, it is assumed that
122 the proxy server can figure out which URLs need to be converted
123 back to https:// based on the request information (for example,
124 host name). For security, this mechanism should only be used
125 with signed repositories or when the proxy is located inside a
126 trusted network.
127 --git path
129 The git program to be used to fetch git repositories. You can
130 also specify additional options that should be passed to the git
131 program with --git-option.
132 If the git program is not explicitly specified, then bpkg will
134 use git by default.
135 --git-option opt
137 Additional common option to be passed to the git program. Note
138 that the common options are the ones that precede the git com‐
139 mand. See --git for more information on the git program. Repeat
140 this option to specify multiple git options.
141 --sha256 path
143 The sha256 program to be used to calculate SHA256 sums. Cur‐
144 rently, bpkg recognizes sha256, sha256sum, and shasum. Note that
145 the last component of path must contain one of these names as a
146 substring in order for bpkg to recognize which program is being
147 used. You can also specify additional options that should be
148 passed to the sha256 program with --sha256-option.
149 If the sha256 program is not specified, then bpkg will try to
151 discover if one of the above programs is available and use that.
152 Currently, bpkg has the following preference order: sha256,
153 sha256sum, and shasum.
154 --sha256-option opt
156 Additional option to be passed to the sha256 program. See
157 --sha256 for more information on the sha256 program. Repeat this
158 option to specify multiple sha256 options.
159 --tar path
161 The tar program to be used to extract package archives. For ex‐
162 ample, gtar or bsdtar. You can also specify additional options
163 that should be passed to the tar program with --tar-option. If
164 the tar program is not explicitly specified, then bpkg will use
165 tar by default.
166 --tar-option opt
168 Additional option to be passed to the tar program. See --tar for
169 more information on the tar program. Repeat this option to spec‐
170 ify multiple tar options.
171 --openssl path
173 The openssl program to be used for crypto operations. You can
174 also specify additional options that should be passed to the
175 openssl program with --openssl-option. If the openssl program is
176 not explicitly specified, then bpkg will use openssl by default.
177 The --openssl* values can be optionally qualified with the
179 openssl command in the command:value form. This makes the value
180 only applicable to the specific command, for example:
181 bpkg rep-create \
183 --openssl rsautl:/path/to/openssl \
184 --openssl-option rsautl:-engine \
185 --openssl-option rsautl:pkcs11 \
186 ...
187 An unqualified value that contains a colon can be specified as
189 qualified with an empty command, for example, --openssl
190 :C:\bin\openssl. To see openssl commands executed by bpkg, use
191 the verbose mode (-v option).
192 --openssl-option opt
194 Additional option to be passed to the openssl program. See
195 --openssl for more information on the openssl program. The val‐
196 ues can be optionally qualified with the openssl command, as
197 discussed in --openssl. Repeat this option to specify multiple
198 openssl options.
199 --auth type
201 Types of repositories to authenticate. Valid values for this op‐
202 tion are none, remote, all. By default only remote repositories
203 are authenticated. You can request authentication of local
204 repositories by passing all or disable authentication completely
205 by passing none.
206 --trust fingerprint
208 Trust repository certificate with a SHA256 fingerprint. Such a
209 certificate is trusted automatically, without prompting the user
210 for a confirmation. Repeat this option to trust multiple cer‐
211 tificates.
212 Note that by default openssl prints a SHA1 fingerprint and to
214 obtain a SHA256 one you will need to pass the -sha256 option,
215 for example:
216 openssl x509 -sha256 -fingerprint -noout -in cert.pem
218 --trust-yes
220 Assume the answer to all authentication prompts is yes.
221 --trust-no
223 Assume the answer to all authentication prompts is no.
224 --pager path
226 The pager program to be used to show long text. Commonly used
227 pager programs are less and more. You can also specify addi‐
228 tional options that should be passed to the pager program with
229 --pager-option. If an empty string is specified as the pager
230 program, then no pager will be used. If the pager program is not
231 explicitly specified, then bpkg will try to use less. If it is
232 not available, then no pager will be used.
233 --pager-option opt
235 Additional option to be passed to the pager program. See --pager
236 for more information on the pager program. Repeat this option to
237 specify multiple pager options.
238 --options-file file
240 Read additional options from file. Each option should appear on
241 a separate line optionally followed by space or equal sign (=)
242 and an option value. Empty lines and lines starting with # are
243 ignored. Option values can be enclosed in double (") or single
244 (') quotes to preserve leading and trailing whitespaces as well
245 as to specify empty values. If the value itself contains trail‐
246 ing or leading quotes, enclose it with an extra pair of quotes,
247 for example '"x"'. Non-leading and non-trailing quotes are in‐
248 terpreted as being part of the option value.
249 The semantics of providing options in a file is equivalent to
251 providing the same set of options in the same order on the com‐
252 mand line at the point where the --options-file option is speci‐
253 fied except that the shell escaping and quoting is not required.
254 Repeat this option to specify more than one options file.
255 --default-options dir
257 The directory to load additional default options files from.
258 --no-default-options
260 Don't load default options files.
261
263 Send bug reports to the users@build2.org mailing list.
264
266 Copyright (c) 2014-2021 the build2 authors.
267 Permission is granted to copy, distribute and/or modify this document
269 under the terms of the MIT License.
270bpkg 0.14.0 October 2021 bpkg-common-options(1)