1bpkg-pkg-unpack(1)          General Commands Manual         bpkg-pkg-unpack(1)
2
3
4

NAME

6       bpkg-pkg-unpack - unpack package archive
7

SYNOPSIS

9       bpkg pkg-unpack [options] (pkg[/ver] | --existing|-e dir)
10

DESCRIPTION

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
16       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
21       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
29       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
33       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

PKG-UNPACK OPTIONS

44       --existing|-e
45              Treat the argument as an existing package directory path  rather
46              than the package name to unpack.
47
48       --purge|-p
49              Remove  the  existing  package  directory  when  the  package is
50              purged.
51
52       --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
56       --directory|-d dir
57              Assume  configuration is in dir rather than in the current work‐
58              ing directory.
59

COMMON OPTIONS

61       The common options are summarized below with a more  detailed  descrip‐
62       tion available in bpkg-common-options(1).
63
64       -v     Print essential underlying commands being executed.
65
66       -V     Print all underlying commands being executed.
67
68       --quiet|-q
69              Run quietly, only printing error messages.
70
71       --verbose level
72              Set the diagnostics verbosity to level between 0 and 6.
73
74       --jobs|-j num
75              Number of jobs to perform in parallel.
76
77       --no-result
78              Don't print informational messages about the outcome of perform‐
79              ing a command or some of its parts.
80
81       --no-progress
82              Suppress progress indicators for long-lasting  operations,  such
83              as network transfers, building, etc.
84
85       --build path
86              The build program to be used to build packages.
87
88       --build-option opt
89              Additional option to be passed to the build program.
90
91       --fetch path
92              The fetch program to be used to download resources.
93
94       --fetch-option opt
95              Additional option to be passed to the fetch program.
96
97       --fetch-timeout sec
98              The fetch and fetch-like (for example, git) program timeout.
99
100       --pkg-proxy url
101              HTTP proxy server to use when fetching package manifests and ar‐
102              chives from remote pkg repositories.
103
104       --git path
105              The git program to be used to fetch git repositories.
106
107       --git-option opt
108              Additional common option to be passed to the git program.
109
110       --sha256 path
111              The sha256 program to be used to calculate SHA256 sums.
112
113       --sha256-option opt
114              Additional option to be passed to the sha256 program.
115
116       --tar path
117              The tar program to be used to extract package archives.
118
119       --tar-option opt
120              Additional option to be passed to the tar program.
121
122       --openssl path
123              The openssl program to be used for crypto operations.
124
125       --openssl-option opt
126              Additional option to be passed to the openssl program.
127
128       --auth type
129              Types of repositories to authenticate.
130
131       --trust fingerprint
132              Trust repository certificate with a SHA256 fingerprint.
133
134       --trust-yes
135              Assume the answer to all authentication prompts is yes.
136
137       --trust-no
138              Assume the answer to all authentication prompts is no.
139
140       --pager path
141              The pager program to be used to show long text.
142
143       --pager-option opt
144              Additional option to be passed to the pager program.
145
146       --options-file file
147              Read additional options from file.
148
149       --default-options dir
150              The directory to load additional default options files from.
151
152       --no-default-options
153              Don't load default options files.
154

DEFAULT OPTIONS FILES

156       See bpkg-default-options-files(1) for an overview of  the  default  op‐
157       tions  files.  For the pkg-unpack 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
161       bpkg.options
162       bpkg-pkg-unpack.options
163
164       The following pkg-unpack command options cannot be specified in the de‐
165       fault options files:
166
167       --directory|-d
168       --purge|-p
169

BUGS

171       Send bug reports to the users@build2.org mailing list.
172
174       Copyright (c) 2014-2021 the build2 authors.
175
176       Permission is granted to copy, distribute and/or modify  this  document
177       under the terms of the MIT License.
178
179
180
181bpkg 0.14.0                      October 2021               bpkg-pkg-unpack(1)
Impressum