1bpkg-cfg-link(1) General Commands Manual bpkg-cfg-link(1)
2
6 bpkg-cfg-link - link configuration
7
9 bpkg cfg-link [options] dir
10
12 The cfg-link command links the specified bpkg configuration with the
13 current configuration. Note that it also establishes an implicit back‐
14 link from the specified to the current configuration. See bpkg-cfg-cre‐
15 ate(1) for background on linked configurations. To unlink previously
16 linked configurations use bpkg-cfg-unlink(1).
17 The linked configurations are normally referred to using names when
19 specified on the bpkg command line. Unless overridden with the --name
20 option, the original configuration name is used to name the link. If
21 the link is unnamed, then it can be referred to using the numeric id
22 that is automatically assigned when establishing the link or using the
23 configuration UUID.
24 If the specified configuration path is relative, then it is rebased
26 relative to the current configuration directory. This way, when the
27 linked configurations are moved around together, the stored relative
28 paths remain valid. If the specified directory path is absolute, then
29 it is stored as absolute unless the --relative option is specified in
30 which case it is also rebased relative to the current configuration di‐
31 rectory.
32
34 --name name
35 Alternative link name. If this option is not specified, then the
36 configuration name is used as the link name (see bpkg-cfg-cre‐
37 ate(1) for details).
38 --relative
40 Rebase the absolute linked configuration path relative to the
41 current configuration directory.
42 --directory|-d dir
44 Assume configuration is in dir rather than in the current work‐
45 ing directory.
46
48 The common options are summarized below with a more detailed descrip‐
49 tion available in bpkg-common-options(1).
50 -v Print essential underlying commands being executed.
52 -V Print all underlying commands being executed.
54 --quiet|-q
56 Run quietly, only printing error messages.
57 --verbose level
59 Set the diagnostics verbosity to level between 0 and 6.
60 --stdout-format format
62 Representation format to use for printing to stdout.
63 --jobs|-j num
65 Number of jobs to perform in parallel.
66 --no-result
68 Don't print informational messages about the outcome of perform‐
69 ing a command or some of its parts.
70 --structured-result fmt
72 Write the result of performing a command in a structured form.
73 --progress
75 Display progress indicators for long-lasting operations, such as
76 network transfers, building, etc.
77 --no-progress
79 Suppress progress indicators for long-lasting operations, such
80 as network transfers, building, etc.
81 --diag-color
83 Use color in diagnostics.
84 --no-diag-color
86 Don't use color in diagnostics.
87 --build path
89 The build program to be used to build packages.
90 --build-option opt
92 Additional option to be passed to the build program.
93 --fetch path
95 The fetch program to be used to download resources.
96 --fetch-option opt
98 Additional option to be passed to the fetch program.
99 --fetch-timeout sec
101 The fetch and fetch-like (for example, git) program timeout.
102 --pkg-proxy url
104 HTTP proxy server to use when fetching package manifests and ar‐
105 chives from remote pkg repositories.
106 --git path
108 The git program to be used to fetch git repositories.
109 --git-option opt
111 Additional common option to be passed to the git program.
112 --sha256 path
114 The sha256 program to be used to calculate SHA256 sums.
115 --sha256-option opt
117 Additional option to be passed to the sha256 program.
118 --tar path
120 The tar program to be used to extract package archives.
121 --tar-option opt
123 Additional option to be passed to the tar program.
124 --openssl path
126 The openssl program to be used for crypto operations.
127 --openssl-option opt
129 Additional option to be passed to the openssl program.
130 --auth type
132 Types of repositories to authenticate.
133 --trust fingerprint
135 Trust repository certificate with a SHA256 fingerprint.
136 --trust-yes
138 Assume the answer to all authentication prompts is yes.
139 --trust-no
141 Assume the answer to all authentication prompts is no.
142 --git-capabilities up=pc
144 Protocol capabilities (pc) for a git repository URL prefix (up).
145 --pager path
147 The pager program to be used to show long text.
148 --pager-option opt
150 Additional option to be passed to the pager program.
151 --options-file file
153 Read additional options from file.
154 --default-options dir
156 The directory to load additional default options files from.
157 --no-default-options
159 Don't load default options files.
160 --keep-tmp
162 Don't remove the bpkg's temporary directory at the end of the
163 command execution and print its path at the verbosity level 2 or
164 higher.
165
167 See bpkg-default-options-files(1) for an overview of the default op‐
168 tions files. For the cfg-link command the search start directory is the
169 configuration directory. The following options files are searched for
170 in each directory and, if found, loaded in the order listed:
171 bpkg.options
173 bpkg-cfg-link.options
174 The following cfg-link command options cannot be specified in the de‐
176 fault options files:
177 --directory|-d
179
181 Send bug reports to the users@build2.org mailing list.
182
184 Copyright (c) 2014-2023 the build2 authors.
185 Permission is granted to copy, distribute and/or modify this document
187 under the terms of the MIT License.
188bpkg 0.16.0 June 2023 bpkg-cfg-link(1)