1bpkg-pkg-unpack(1) General Commands Manual bpkg-pkg-unpack(1)
2
6 bpkg-pkg-unpack - unpack package archive
7
9 bpkg pkg-unpack [options] (pkg[/ver] | --existing|-e dir)
10
12 If only the package name is specified, then the pkg-unpack command un‐
13 packs the archive for the previously fetched (bpkg-pkg-fetch(1)) pack‐
14 age. The resulting package state is unpacked (bpkg-pkg-status(1)).
15 If the package version is also specified, then the (source) directory
17 from one of the directory-based repositories (bpkg-rep-add(1)) is used
18 in place, without copying it into the configuration directory. Such a
19 package is called external.
20 If the --existing|-e option is used, then instead of the package name,
22 pkg-unpack expects a local path to an existing package directory. In
23 this case, bpkg will use the (source) directory in place, the same as
24 for packages from directory-based repositories. Also, unless the
25 --purge|-p option is specified, bpkg will not attempt to remove this
26 directory when the package is later purged with the bpkg-pkg-purge(1)
27 command. Such a package is also external.
28 If --existing|-e is specified together with the --replace|-r option,
30 then pkg-unpack will replace the archive and/or source directory of a
31 package that is already in the unpacked or fetched state.
32 An external package triggers several changes in semantics compared to a
34 normal package: The package (output) directory inside the configuration
35 is called just pkg rather than pkg-ver. It is also assumed that the
36 packaging information (package manifest and lockfile) for such packages
37 may change without incrementing the package version (for example, dur‐
38 ing development). To support this, bpkg implements the package itera‐
39 tion mechanism which may result in iteration numbers to be shown as
40 part of the package version, for example, 1.2.3#1 (see Package Version
41 (#package-version)).
42
44 --existing|-e
45 Treat the argument as an existing package directory path rather
46 than the package name to unpack.
47 --purge|-p
49 Remove the existing package directory when the package is
50 purged.
51 --replace|-r
53 Replace the source directory if the package is already unpacked
54 or fetched. Can only be specified with an external package.
55 --directory|-d dir
57 Assume configuration is in dir rather than in the current work‐
58 ing directory.
59
61 The common options are summarized below with a more detailed descrip‐
62 tion available in bpkg-common-options(1).
63 -v Print essential underlying commands being executed.
65 -V Print all underlying commands being executed.
67 --quiet|-q
69 Run quietly, only printing error messages.
70 --verbose level
72 Set the diagnostics verbosity to level between 0 and 6.
73 --stdout-format format
75 Representation format to use for printing to stdout.
76 --jobs|-j num
78 Number of jobs to perform in parallel.
79 --no-result
81 Don't print informational messages about the outcome of perform‐
82 ing a command or some of its parts.
83 --progress
85 Display progress indicators for long-lasting operations, such as
86 network transfers, building, etc.
87 --no-progress
89 Suppress progress indicators for long-lasting operations, such
90 as network transfers, building, etc.
91 --build path
93 The build program to be used to build packages.
94 --build-option opt
96 Additional option to be passed to the build program.
97 --fetch path
99 The fetch program to be used to download resources.
100 --fetch-option opt
102 Additional option to be passed to the fetch program.
103 --fetch-timeout sec
105 The fetch and fetch-like (for example, git) program timeout.
106 --pkg-proxy url
108 HTTP proxy server to use when fetching package manifests and ar‐
109 chives from remote pkg repositories.
110 --git path
112 The git program to be used to fetch git repositories.
113 --git-option opt
115 Additional common option to be passed to the git program.
116 --sha256 path
118 The sha256 program to be used to calculate SHA256 sums.
119 --sha256-option opt
121 Additional option to be passed to the sha256 program.
122 --tar path
124 The tar program to be used to extract package archives.
125 --tar-option opt
127 Additional option to be passed to the tar program.
128 --openssl path
130 The openssl program to be used for crypto operations.
131 --openssl-option opt
133 Additional option to be passed to the openssl program.
134 --auth type
136 Types of repositories to authenticate.
137 --trust fingerprint
139 Trust repository certificate with a SHA256 fingerprint.
140 --trust-yes
142 Assume the answer to all authentication prompts is yes.
143 --trust-no
145 Assume the answer to all authentication prompts is no.
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-unpack 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-unpack.options
175 The following pkg-unpack command options cannot be specified in the de‐
177 fault options files:
178 --directory|-d
180 --purge|-p
181
183 Send bug reports to the users@build2.org mailing list.
184
186 Copyright (c) 2014-2022 the build2 authors.
187 Permission is granted to copy, distribute and/or modify this document
189 under the terms of the MIT License.
190bpkg 0.15.0 July 2022 bpkg-pkg-unpack(1)