1bpkg-cfg-info(1) General Commands Manual bpkg-cfg-info(1)
2
6 bpkg-cfg-info - print configuration information
7
9 bpkg cfg-info [options]
10
12 The cfg-info command prints the current configuration's absolute path,
13 id, type, and name. If the --link and/or --backlink options are speci‐
14 fied, then this information is also printed for each linked and/or im‐
15 plicitly backlinked configuration, if any. Note that the dangling im‐
16 plicit backlinks are silently skipped, unless --dangling is specified,
17 in which case this information is also printed for them. Note that the
18 information is written to stdout, not stderr.
19 If the --recursive option is specified together with --link and/or
21 --backlink, then this information is printed for linked and/or implic‐
22 itly backlinked configuration, recursively.
23 The output format is regular with each value printed on a separate line
25 and prefixed with the value name. If the --link, --backlink, and/or
26 --dangling options are specified, then information blocks corresponding
27 to linked configurations are separated with blank lines. For example:
28 path: /path/to/cfg/
30 uuid: 8d439f03-7342-4502-8b1c-74b173869478
31 type: target
32 name: foo
33 path: /path/to/host-cfg/
35 uuid: 7ee4dab3-07d9-4163-81c0-3779166a7213
36 type: host
37 name: tools
38 path: /path/to/build2-cfg/
40 uuid: d453aa2a-92c4-4066-87e4-c8672eed06e1
41 type: build2
42 name: modules
43
45 --link Print linked configurations.
46 --backlink
48 Print implicitly backlinked configurations.
49 --dangling
51 Print dangling implicit backlinks.
52 --recursive
54 Print linked configurations recursively.
55 --directory|-d dir
57 Assume configuration is in dir rather than in the current work‐
58 ing directory.
59
61 The common options are summarized below with a more detailed descrip‐
62 tion available in bpkg-common-options(1).
63 -v Print essential underlying commands being executed.
65 -V Print all underlying commands being executed.
67 --quiet|-q
69 Run quietly, only printing error messages.
70 --verbose level
72 Set the diagnostics verbosity to level between 0 and 6.
73 --stdout-format format
75 Representation format to use for printing to stdout.
76 --jobs|-j num
78 Number of jobs to perform in parallel.
79 --no-result
81 Don't print informational messages about the outcome of perform‐
82 ing a command or some of its parts.
83 --structured-result fmt
85 Write the result of performing a command in a structured form.
86 --progress
88 Display progress indicators for long-lasting operations, such as
89 network transfers, building, etc.
90 --no-progress
92 Suppress progress indicators for long-lasting operations, such
93 as network transfers, building, etc.
94 --diag-color
96 Use color in diagnostics.
97 --no-diag-color
99 Don't use color in diagnostics.
100 --build path
102 The build program to be used to build packages.
103 --build-option opt
105 Additional option to be passed to the build program.
106 --fetch path
108 The fetch program to be used to download resources.
109 --fetch-option opt
111 Additional option to be passed to the fetch program.
112 --fetch-timeout sec
114 The fetch and fetch-like (for example, git) program timeout.
115 --pkg-proxy url
117 HTTP proxy server to use when fetching package manifests and ar‐
118 chives from remote pkg repositories.
119 --git path
121 The git program to be used to fetch git repositories.
122 --git-option opt
124 Additional common option to be passed to the git program.
125 --sha256 path
127 The sha256 program to be used to calculate SHA256 sums.
128 --sha256-option opt
130 Additional option to be passed to the sha256 program.
131 --tar path
133 The tar program to be used to extract package archives.
134 --tar-option opt
136 Additional option to be passed to the tar program.
137 --openssl path
139 The openssl program to be used for crypto operations.
140 --openssl-option opt
142 Additional option to be passed to the openssl program.
143 --auth type
145 Types of repositories to authenticate.
146 --trust fingerprint
148 Trust repository certificate with a SHA256 fingerprint.
149 --trust-yes
151 Assume the answer to all authentication prompts is yes.
152 --trust-no
154 Assume the answer to all authentication prompts is no.
155 --git-capabilities up=pc
157 Protocol capabilities (pc) for a git repository URL prefix (up).
158 --pager path
160 The pager program to be used to show long text.
161 --pager-option opt
163 Additional option to be passed to the pager program.
164 --options-file file
166 Read additional options from file.
167 --default-options dir
169 The directory to load additional default options files from.
170 --no-default-options
172 Don't load default options files.
173 --keep-tmp
175 Don't remove the bpkg's temporary directory at the end of the
176 command execution and print its path at the verbosity level 2 or
177 higher.
178
180 See bpkg-default-options-files(1) for an overview of the default op‐
181 tions files. For the cfg-info command the search start directory is the
182 configuration directory. The following options files are searched for
183 in each directory and, if found, loaded in the order listed:
184 bpkg.options
186 bpkg-cfg-info.options
187 The following cfg-info command options cannot be specified in the de‐
189 fault options files:
190 --directory|-d
192
194 Send bug reports to the users@build2.org mailing list.
195
197 Copyright (c) 2014-2023 the build2 authors.
198 Permission is granted to copy, distribute and/or modify this document
200 under the terms of the MIT License.
201bpkg 0.16.0 June 2023 bpkg-cfg-info(1)