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 --progress
73 Display progress indicators for long-lasting operations, such as
74 network transfers, building, etc.
75 --no-progress
77 Suppress progress indicators for long-lasting operations, such
78 as network transfers, building, etc.
79 --build path
81 The build program to be used to build packages.
82 --build-option opt
84 Additional option to be passed to the build program.
85 --fetch path
87 The fetch program to be used to download resources.
88 --fetch-option opt
90 Additional option to be passed to the fetch program.
91 --fetch-timeout sec
93 The fetch and fetch-like (for example, git) program timeout.
94 --pkg-proxy url
96 HTTP proxy server to use when fetching package manifests and ar‐
97 chives from remote pkg repositories.
98 --git path
100 The git program to be used to fetch git repositories.
101 --git-option opt
103 Additional common option to be passed to the git program.
104 --sha256 path
106 The sha256 program to be used to calculate SHA256 sums.
107 --sha256-option opt
109 Additional option to be passed to the sha256 program.
110 --tar path
112 The tar program to be used to extract package archives.
113 --tar-option opt
115 Additional option to be passed to the tar program.
116 --openssl path
118 The openssl program to be used for crypto operations.
119 --openssl-option opt
121 Additional option to be passed to the openssl program.
122 --auth type
124 Types of repositories to authenticate.
125 --trust fingerprint
127 Trust repository certificate with a SHA256 fingerprint.
128 --trust-yes
130 Assume the answer to all authentication prompts is yes.
131 --trust-no
133 Assume the answer to all authentication prompts is no.
134 --pager path
136 The pager program to be used to show long text.
137 --pager-option opt
139 Additional option to be passed to the pager program.
140 --options-file file
142 Read additional options from 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 --keep-tmp
151 Don't remove the bpkg's temporary directory at the end of the
152 command execution and print its path at the verbosity level 2 or
153 higher.
154
156 See bpkg-default-options-files(1) for an overview of the default op‐
157 tions files. For the pkg-checkout command the search start directory is
158 the configuration directory. The following options files are searched
159 for in each directory and, if found, loaded in the order listed:
160 bpkg.options
162 bpkg-pkg-checkout.options
163 The following pkg-checkout command options cannot be specified in the
165 default options files:
166 --directory|-d
168
170 Send bug reports to the users@build2.org mailing list.
171
173 Copyright (c) 2014-2022 the build2 authors.
174 Permission is granted to copy, distribute and/or modify this document
176 under the terms of the MIT License.
177bpkg 0.15.0 July 2022 bpkg-pkg-checkout(1)