1bdep-common-options(1) General Commands Manual bdep-common-options(1)
2
6 bdep-common-options - details on common options
7
9 bdep [common-options] ...
10
12 The common options control behavior that is common to all or most of
13 the bdep 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 --stdout-format format
46 Representation format to use for printing to stdout. Valid val‐
47 ues for this option are lines (default) and json. See the JSON
48 OUTPUT section below for details on the json format.
49 --jobs|-j num
51 Number of jobs to perform in parallel. If this option is not
52 specified or specified with the 0 value, then the number of
53 available hardware threads is used. This option is also propa‐
54 gated when executing package manager commands such as bpkg-pkg-
55 update(1), bpkg-pkg-test(1), etc., which in turn propagate it to
56 the build system.
57 --progress
59 Display progress indicators for long-lasting operations, such as
60 network transfers, building, etc. If printing to a terminal the
61 progress is displayed by default for low verbosity levels. Use
62 --no-progress to suppress.
63 --no-progress
65 Suppress progress indicators for long-lasting operations, such
66 as network transfers, building, etc.
67 --diag-color
69 Use color in diagnostics. If printing to a terminal the color is
70 used by default provided the terminal is not dumb. Use --no-
71 diag-color to suppress.
72 --no-diag-color
74 Don't use color in diagnostics.
75 --bpkg path
77 The package manager program to be used for build configuration
78 management. This should be the path to the bpkg executable. You
79 can also specify additional options that should be passed to the
80 package manager program with --bpkg-option.
81 If the package manager program is not explicitly specified, then
83 bdep will by default use bpkg plus an executable suffix if one
84 was specified when building bdep. So, for example, if bdep name
85 was set to bdep-1.0, then it will look for bpkg-1.0.
86 --bpkg-option opt
88 Additional option to be passed to the package manager program.
89 See --bpkg for more information on the package manager program.
90 Repeat this option to specify multiple package manager options.
91 --build path
93 The build program to be used to build packages. This should be
94 the path to the build2 b executable. You can also specify addi‐
95 tional options that should be passed to the build program with
96 --build-option.
97 If the build program is not explicitly specified, then bdep will
99 by default use b plus an executable suffix if one was specified
100 when building bdep. So, for example, if bdep name was set to
101 bdep-1.0, then it will look for b-1.0.
102 --build-option opt
104 Additional option to be passed to the build program. See --build
105 for more information on the build program. Repeat this option to
106 specify multiple build options.
107 --curl path
109 The curl program to be used for network operations. You can also
110 specify additional options that should be passed to the curl
111 program with --curl-option.
112 If the curl program is not explicitly specified, then bdep will
114 use curl by default. Note that this program will also be used by
115 the underlying bpkg invocations unless overridden.
116 --curl-option opt
118 Additional option to be passed to the curl program. See --curl
119 for more information on the curl program. Repeat this option to
120 specify multiple curl options.
121 Note that these options will also be used by the underlying bpkg
123 invocations provided that curl is used.
124 --pager path
126 The pager program to be used to show long text. Commonly used
127 pager programs are less and more. You can also specify addi‐
128 tional options that should be passed to the pager program with
129 --pager-option. If an empty string is specified as the pager
130 program, then no pager will be used. If the pager program is not
131 explicitly specified, then bdep will try to use less. If it is
132 not available, then no pager will be used.
133 --pager-option opt
135 Additional option to be passed to the pager program. See --pager
136 for more information on the pager program. Repeat this option to
137 specify multiple pager options.
138 --options-file file
140 Read additional options from file. Each option should appear on
141 a separate line optionally followed by space or equal sign (=)
142 and an option value. Empty lines and lines starting with # are
143 ignored. Option values can be enclosed in double (") or single
144 (') quotes to preserve leading and trailing whitespaces as well
145 as to specify empty values. If the value itself contains trail‐
146 ing or leading quotes, enclose it with an extra pair of quotes,
147 for example '"x"'. Non-leading and non-trailing quotes are in‐
148 terpreted as being part of the option value.
149 The semantics of providing options in a file is equivalent to
151 providing the same set of options in the same order on the com‐
152 mand line at the point where the --options-file option is speci‐
153 fied except that the shell escaping and quoting is not required.
154 Repeat this option to specify more than one options file.
155 --default-options dir
157 The directory to load additional default options files from.
158 --no-default-options
160 Don't load default options files.
161
163 Commands that support the JSON output specify their formats as a seri‐
164 alized representation of a C++ struct or an array thereof. For example:
165 struct package
167 {
168 string name;
169 };
170 struct configuration
172 {
173 uint64_t id;
174 string path;
175 optional<string> name;
176 bool default;
177 vector<package> packages;
178 };
179 An example of the serialized JSON representation of struct configura‐
181 tion:
182 {
184 "id": 1,
185 "path": "/tmp/hello-gcc",
186 "name": "gcc",
187 "default": true,
188 "packages": [
189 {
190 "name": "hello"
191 }
192 ]
193 }
194 This sections provides details on the overall properties of such for‐
196 mats and the semantics of the struct serialization.
197 The order of members in a JSON object is fixed as specified in the cor‐
199 responding struct. While new members may be added in the future (and
200 should be ignored by older consumers), the semantics of the existing
201 members (including whether the top-level entry is an object or array)
202 may not change.
203 An object member is required unless its type is optional<>, bool, or
205 vector<> (array). For bool members absent means false. For vector<>
206 members absent means empty. An empty top-level array is always present.
207 For example, the following JSON text is a possible serialization of the
209 above struct configuration:
210 {
212 "id": 1,
213 "path": "/tmp/hello-gcc"
214 }
215
217 Send bug reports to the users@build2.org mailing list.
218
220 Copyright (c) 2014-2023 the build2 authors.
221 Permission is granted to copy, distribute and/or modify this document
223 under the terms of the MIT License.
224bdep 0.16.0 June 2023 bdep-common-options(1)