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 --bpkg path
69 The package manager program to be used for build configuration
70 management. This should be the path to the bpkg executable. You
71 can also specify additional options that should be passed to the
72 package manager program with --bpkg-option.
73 If the package manager program is not explicitly specified, then
75 bdep will by default use bpkg plus an executable suffix if one
76 was specified when building bdep. So, for example, if bdep name
77 was set to bdep-1.0, then it will look for bpkg-1.0.
78 --bpkg-option opt
80 Additional option to be passed to the package manager program.
81 See --bpkg for more information on the package manager program.
82 Repeat this option to specify multiple package manager options.
83 --build path
85 The build program to be used to build packages. This should be
86 the path to the build2 b executable. You can also specify addi‐
87 tional options that should be passed to the build program with
88 --build-option.
89 If the build program is not explicitly specified, then bdep will
91 by default use b plus an executable suffix if one was specified
92 when building bdep. So, for example, if bdep name was set to
93 bdep-1.0, then it will look for b-1.0.
94 --build-option opt
96 Additional option to be passed to the build program. See --build
97 for more information on the build program. Repeat this option to
98 specify multiple build options.
99 --curl path
101 The curl program to be used for network operations. You can also
102 specify additional options that should be passed to the curl
103 program with --curl-option.
104 If the curl program is not explicitly specified, then bdep will
106 use curl by default.
107 --curl-option opt
109 Additional option to be passed to the curl program. See --curl
110 for more information on the curl program. Repeat this option to
111 specify multiple curl options.
112 --pager path
114 The pager program to be used to show long text. Commonly used
115 pager programs are less and more. You can also specify addi‐
116 tional options that should be passed to the pager program with
117 --pager-option. If an empty string is specified as the pager
118 program, then no pager will be used. If the pager program is not
119 explicitly specified, then bdep will try to use less. If it is
120 not available, then no pager will be used.
121 --pager-option opt
123 Additional option to be passed to the pager program. See --pager
124 for more information on the pager program. Repeat this option to
125 specify multiple pager options.
126 --options-file file
128 Read additional options from file. Each option should appear on
129 a separate line optionally followed by space or equal sign (=)
130 and an option value. Empty lines and lines starting with # are
131 ignored. Option values can be enclosed in double (") or single
132 (') quotes to preserve leading and trailing whitespaces as well
133 as to specify empty values. If the value itself contains trail‐
134 ing or leading quotes, enclose it with an extra pair of quotes,
135 for example '"x"'. Non-leading and non-trailing quotes are in‐
136 terpreted as being part of the option value.
137 The semantics of providing options in a file is equivalent to
139 providing the same set of options in the same order on the com‐
140 mand line at the point where the --options-file option is speci‐
141 fied except that the shell escaping and quoting is not required.
142 Repeat this option to specify more than one options file.
143 --default-options dir
145 The directory to load additional default options files from.
146 --no-default-options
148 Don't load default options files.
149
151 Commands that support the JSON output specify their formats as a seri‐
152 alized representation of a C++ struct or an array thereof. For example:
153 struct package
155 {
156 string name;
157 };
158 struct configuration
160 {
161 uint64_t id;
162 string path;
163 optional<string> name;
164 bool default;
165 vector<package> packages;
166 };
167 An example of the serialized JSON representation of struct configura‐
169 tion:
170 {
172 "id": 1,
173 "path": "/tmp/hello-gcc",
174 "name": "gcc",
175 "default": true,
176 "packages": [
177 {
178 "name": "hello"
179 }
180 ]
181 }
182 This sections provides details on the overall properties of such for‐
184 mats and the semantics of the struct serialization.
185 The order of members in a JSON object is fixed as specified in the cor‐
187 responding struct. While new members may be added in the future (and
188 should be ignored by older consumers), the semantics of the existing
189 members (including whether the top-level entry is an object or array)
190 may not change.
191 An object member is required unless its type is optional<>, bool, or
193 vector<> (array). For bool members absent means false. For vector<>
194 members absent means empty. An empty top-level array is always present.
195 For example, the following JSON text is a possible serialization of the
197 above struct configuration:
198 {
200 "id": 1,
201 "path": "/tmp/hello-gcc"
202 }
203
205 Send bug reports to the users@build2.org mailing list.
206
208 Copyright (c) 2014-2022 the build2 authors.
209 Permission is granted to copy, distribute and/or modify this document
211 under the terms of the MIT License.
212bdep 0.15.0 July 2022 bdep-common-options(1)