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 --progress
72 Display progress indicators for long-lasting operations, such as
73 network transfers, building, etc.
74 --no-progress
76 Suppress progress indicators for long-lasting operations, such
77 as network transfers, building, etc.
78 --build path
80 The build program to be used to build packages.
81 --build-option opt
83 Additional option to be passed to the build program.
84 --fetch path
86 The fetch program to be used to download resources.
87 --fetch-option opt
89 Additional option to be passed to the fetch program.
90 --fetch-timeout sec
92 The fetch and fetch-like (for example, git) program timeout.
93 --pkg-proxy url
95 HTTP proxy server to use when fetching package manifests and ar‐
96 chives from remote pkg repositories.
97 --git path
99 The git program to be used to fetch git repositories.
100 --git-option opt
102 Additional common option to be passed to the git program.
103 --sha256 path
105 The sha256 program to be used to calculate SHA256 sums.
106 --sha256-option opt
108 Additional option to be passed to the sha256 program.
109 --tar path
111 The tar program to be used to extract package archives.
112 --tar-option opt
114 Additional option to be passed to the tar program.
115 --openssl path
117 The openssl program to be used for crypto operations.
118 --openssl-option opt
120 Additional option to be passed to the openssl program.
121 --auth type
123 Types of repositories to authenticate.
124 --trust fingerprint
126 Trust repository certificate with a SHA256 fingerprint.
127 --trust-yes
129 Assume the answer to all authentication prompts is yes.
130 --trust-no
132 Assume the answer to all authentication prompts is no.
133 --pager path
135 The pager program to be used to show long text.
136 --pager-option opt
138 Additional option to be passed to the pager program.
139 --options-file file
141 Read additional options from file.
142 --default-options dir
144 The directory to load additional default options files from.
145 --no-default-options
147 Don't load default options files.
148 --keep-tmp
150 Don't remove the bpkg's temporary directory at the end of the
151 command execution and print its path at the verbosity level 2 or
152 higher.
153
155 See bpkg-default-options-files(1) for an overview of the default op‐
156 tions files. For the cfg-link command the search start directory is the
157 configuration directory. The following options files are searched for
158 in each directory and, if found, loaded in the order listed:
159 bpkg.options
161 bpkg-cfg-link.options
162 The following cfg-link command options cannot be specified in the de‐
164 fault options files:
165 --directory|-d
167
169 Send bug reports to the users@build2.org mailing list.
170
172 Copyright (c) 2014-2022 the build2 authors.
173 Permission is granted to copy, distribute and/or modify this document
175 under the terms of the MIT License.
176bpkg 0.15.0 July 2022 bpkg-cfg-link(1)