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 --jobs|-j num
63 Number of jobs to perform in parallel.
64 --no-result
66 Don't print informational messages about the outcome of perform‐
67 ing a command or some of its parts.
68 --no-progress
70 Suppress progress indicators for long-lasting operations, such
71 as network transfers, building, etc.
72 --build path
74 The build program to be used to build packages.
75 --build-option opt
77 Additional option to be passed to the build program.
78 --fetch path
80 The fetch program to be used to download resources.
81 --fetch-option opt
83 Additional option to be passed to the fetch program.
84 --fetch-timeout sec
86 The fetch and fetch-like (for example, git) program timeout.
87 --pkg-proxy url
89 HTTP proxy server to use when fetching package manifests and ar‐
90 chives from remote pkg repositories.
91 --git path
93 The git program to be used to fetch git repositories.
94 --git-option opt
96 Additional common option to be passed to the git program.
97 --sha256 path
99 The sha256 program to be used to calculate SHA256 sums.
100 --sha256-option opt
102 Additional option to be passed to the sha256 program.
103 --tar path
105 The tar program to be used to extract package archives.
106 --tar-option opt
108 Additional option to be passed to the tar program.
109 --openssl path
111 The openssl program to be used for crypto operations.
112 --openssl-option opt
114 Additional option to be passed to the openssl program.
115 --auth type
117 Types of repositories to authenticate.
118 --trust fingerprint
120 Trust repository certificate with a SHA256 fingerprint.
121 --trust-yes
123 Assume the answer to all authentication prompts is yes.
124 --trust-no
126 Assume the answer to all authentication prompts is no.
127 --pager path
129 The pager program to be used to show long text.
130 --pager-option opt
132 Additional option to be passed to the pager program.
133 --options-file file
135 Read additional options from file.
136 --default-options dir
138 The directory to load additional default options files from.
139 --no-default-options
141 Don't load default options files.
142
144 See bpkg-default-options-files(1) for an overview of the default op‐
145 tions files. For the pkg-checkout command the search start directory is
146 the configuration directory. The following options files are searched
147 for in each directory and, if found, loaded in the order listed:
148 bpkg.options
150 bpkg-pkg-checkout.options
151 The following pkg-checkout command options cannot be specified in the
153 default options files:
154 --directory|-d
156
158 Send bug reports to the users@build2.org mailing list.
159
161 Copyright (c) 2014-2021 the build2 authors.
162 Permission is granted to copy, distribute and/or modify this document
164 under the terms of the MIT License.
165bpkg 0.14.0 October 2021 bpkg-pkg-checkout(1)