1bpkg-pkg-checkout(1) General Commands Manual bpkg-pkg-checkout(1)
2
6 bpkg-pkg-checkout - check out package version
7
9 bpkg pkg-checkout [options] pkg/ver
10
12 The pkg-checkout command checks out the specified package version from
13 one of the version control-based repositories (bpkg-rep-add(1)). The
14 resulting package state is unpacked (bpkg-pkg-status(1)).
15 If the --output-root option is passed, then the package is checked out
17 into the specified directory rather than into the configuration direc‐
18 tory. In this case, bpkg uses the package (source) directory in place,
19 similar to the pkg-unpack --existing|-e mode. Also, unless the --out‐
20 put-purge option is specified, bpkg will not attempt to remove this di‐
21 rectory when the package is later purged with the bpkg-pkg-purge(1)
22 command. Note also that such a package is not external (see bpkg-pkg-
23 unpack(1) for details).
24 If the --replace|-r option is specified, then pkg-checkout will replace
26 the archive and/or source directory of a package that is already in the
27 unpacked or fetched state.
28
30 --replace|-r
31 Replace the source directory if the package is already fetched
32 or unpacked.
33 --output-root dir
35 Check out the package into the specified directory rather than
36 into the configuration directory. Note that the package source
37 is placed into the package-version subdirectory of this direc‐
38 tory.
39 --output-purge
41 Remove the checked out package (source) directory when the pack‐
42 age is purged.
43 --directory|-d dir
45 Assume configuration is in dir rather than in the current work‐
46 ing directory.
47
49 The common options are summarized below with a more detailed descrip‐
50 tion available in bpkg-common-options(1).
51 -v Print essential underlying commands being executed.
53 -V Print all underlying commands being executed.
55 --quiet|-q
57 Run quietly, only printing error messages.
58 --verbose level
60 Set the diagnostics verbosity to level between 0 and 6.
61 --stdout-format format
63 Representation format to use for printing to stdout.
64 --jobs|-j num
66 Number of jobs to perform in parallel.
67 --no-result
69 Don't print informational messages about the outcome of perform‐
70 ing a command or some of its parts.
71 --structured-result fmt
73 Write the result of performing a command in a structured form.
74 --progress
76 Display progress indicators for long-lasting operations, such as
77 network transfers, building, etc.
78 --no-progress
80 Suppress progress indicators for long-lasting operations, such
81 as network transfers, building, etc.
82 --diag-color
84 Use color in diagnostics.
85 --no-diag-color
87 Don't use color in diagnostics.
88 --build path
90 The build program to be used to build packages.
91 --build-option opt
93 Additional option to be passed to the build program.
94 --fetch path
96 The fetch program to be used to download resources.
97 --fetch-option opt
99 Additional option to be passed to the fetch program.
100 --fetch-timeout sec
102 The fetch and fetch-like (for example, git) program timeout.
103 --pkg-proxy url
105 HTTP proxy server to use when fetching package manifests and ar‐
106 chives from remote pkg repositories.
107 --git path
109 The git program to be used to fetch git repositories.
110 --git-option opt
112 Additional common option to be passed to the git program.
113 --sha256 path
115 The sha256 program to be used to calculate SHA256 sums.
116 --sha256-option opt
118 Additional option to be passed to the sha256 program.
119 --tar path
121 The tar program to be used to extract package archives.
122 --tar-option opt
124 Additional option to be passed to the tar program.
125 --openssl path
127 The openssl program to be used for crypto operations.
128 --openssl-option opt
130 Additional option to be passed to the openssl program.
131 --auth type
133 Types of repositories to authenticate.
134 --trust fingerprint
136 Trust repository certificate with a SHA256 fingerprint.
137 --trust-yes
139 Assume the answer to all authentication prompts is yes.
140 --trust-no
142 Assume the answer to all authentication prompts is no.
143 --git-capabilities up=pc
145 Protocol capabilities (pc) for a git repository URL prefix (up).
146 --pager path
148 The pager program to be used to show long text.
149 --pager-option opt
151 Additional option to be passed to the pager program.
152 --options-file file
154 Read additional options from 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 --keep-tmp
163 Don't remove the bpkg's temporary directory at the end of the
164 command execution and print its path at the verbosity level 2 or
165 higher.
166
168 See bpkg-default-options-files(1) for an overview of the default op‐
169 tions files. For the pkg-checkout command the search start directory is
170 the configuration directory. The following options files are searched
171 for in each directory and, if found, loaded in the order listed:
172 bpkg.options
174 bpkg-pkg-checkout.options
175 The following pkg-checkout command options cannot be specified in the
177 default options files:
178 --directory|-d
180
182 Send bug reports to the users@build2.org mailing list.
183
185 Copyright (c) 2014-2023 the build2 authors.
186 Permission is granted to copy, distribute and/or modify this document
188 under the terms of the MIT License.
189bpkg 0.16.0 June 2023 bpkg-pkg-checkout(1)