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 --replace|-r option is specified, then pkg-checkout will replace
17 the archive and/or source directory of a package that is already in the
18 unpacked or fetched state.
19
21 --replace|-r
22 Replace the source directory if the package is already fetched
23 or unpacked.
24 --directory|-d dir
26 Assume configuration is in dir rather than in the current work‐
27 ing directory.
28
30 The common options are summarized below with a more detailed descrip‐
31 tion available in bpkg-common-options(1).
32 -v Print essential underlying commands being executed.
34 -V Print all underlying commands being executed.
36 --quiet|-q
38 Run quietly, only printing error messages.
39 --verbose level
41 Set the diagnostics verbosity to level between 0 and 6.
42 --jobs|-j num
44 Number of jobs to perform in parallel.
45 --no-result
47 Don't print informational messages about the outcome of perform‐
48 ing a command.
49 --no-progress
51 Suppress progress indicators for long-lasting operations, such
52 as network transfers, building, etc.
53 --build path
55 The build program to be used to build packages.
56 --build-option opt
58 Additional option to be passed to the build program.
59 --fetch path
61 The fetch program to be used to download resources.
62 --fetch-option opt
64 Additional option to be passed to the fetch program.
65 --fetch-timeout sec
67 The fetch and fetch-like (for example, git) program timeout.
68 --pkg-proxy url
70 HTTP proxy server to use when fetching package manifests and ar‐
71 chives from remote pkg repositories.
72 --git path
74 The git program to be used to fetch git repositories.
75 --git-option opt
77 Additional common option to be passed to the git program.
78 --sha256 path
80 The sha256 program to be used to calculate SHA256 sums.
81 --sha256-option opt
83 Additional option to be passed to the sha256 program.
84 --tar path
86 The tar program to be used to extract package archives.
87 --tar-option opt
89 Additional option to be passed to the tar program.
90 --openssl path
92 The openssl program to be used for crypto operations.
93 --openssl-option opt
95 Additional option to be passed to the openssl program.
96 --auth type
98 Types of repositories to authenticate.
99 --trust fingerprint
101 Trust repository certificate with a SHA256 fingerprint.
102 --trust-yes
104 Assume the answer to all authentication prompts is yes.
105 --trust-no
107 Assume the answer to all authentication prompts is no.
108 --pager path
110 The pager program to be used to show long text.
111 --pager-option opt
113 Additional option to be passed to the pager program.
114 --options-file file
116 Read additional options from file.
117 --default-options dir
119 The directory to load additional default options files from.
120 --no-default-options
122 Don't load default options files.
123
125 See bpkg-default-options-files(1) for an overview of the default
126 options files. For the pkg-checkout command the search start directory
127 is the configuration directory. The following options files are
128 searched for in each directory and, if found, loaded in the order
129 listed:
130 bpkg.options
132 bpkg-pkg-checkout.options
133 The following pkg-checkout command options cannot be specified in the
135 default options files:
136 --directory|-d
138
140 Send bug reports to the users@build2.org mailing list.
141
143 Copyright (c) 2014-2020 the build2 authors.
144 Permission is granted to copy, distribute and/or modify this document
146 under the terms of the MIT License.
147bpkg 0.13.0 July 2020 bpkg-pkg-checkout(1)