1bpkg-pkg-fetch(1) General Commands Manual bpkg-pkg-fetch(1)
2
6 bpkg-pkg-fetch - fetch package archive
7
9 bpkg pkg-fetch [options] (pkg/ver | --existing|-e file)
10
12 The pkg-fetch command fetches the archive for the specified package
13 name and version from one of the archive-based repositories (bpkg-rep-
14 add(1)). The resulting package state is fetched (bpkg-pkg-status(1)).
15 If the --replace|-r option is specified, then pkg-fetch will replace
17 the archive of a package that is already in the fetched or unpacked
18 state. Otherwise, pkg-fetch expects the package to not exist in the
19 configuration.
20 If the --existing|-e option is used, then instead of the name and ver‐
22 sion arguments, pkg-fetch expects a local path to an existing package
23 archive. In this case, bpkg will use the archive in place, without
24 copying it into the configuration directory. Also, unless the
25 --purge|-p option is specified, bpkg will not attempt to remove this
26 archive when the package is later purged with the bpkg-pkg-purge(1)
27 command.
28
30 --replace|-r
31 Replace the archive if the package is already fetched or un‐
32 packed.
33 --existing|-e
35 Treat the argument as an existing package archive path rather
36 than the package name/version to fetch.
37 --purge|-p
39 Remove the existing package archive when the package is purged.
40 --directory|-d dir
42 Assume configuration is in dir rather than in the current work‐
43 ing directory.
44
46 The common options are summarized below with a more detailed descrip‐
47 tion available in bpkg-common-options(1).
48 -v Print essential underlying commands being executed.
50 -V Print all underlying commands being executed.
52 --quiet|-q
54 Run quietly, only printing error messages.
55 --verbose level
57 Set the diagnostics verbosity to level between 0 and 6.
58 --stdout-format format
60 Representation format to use for printing to stdout.
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 --structured-result fmt
70 Write the result of performing a command in a structured form.
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 --diag-color
81 Use color in diagnostics.
82 --no-diag-color
84 Don't use color in diagnostics.
85 --build path
87 The build program to be used to build packages.
88 --build-option opt
90 Additional option to be passed to the build program.
91 --fetch path
93 The fetch program to be used to download resources.
94 --fetch-option opt
96 Additional option to be passed to the fetch program.
97 --fetch-timeout sec
99 The fetch and fetch-like (for example, git) program timeout.
100 --pkg-proxy url
102 HTTP proxy server to use when fetching package manifests and ar‐
103 chives from remote pkg repositories.
104 --git path
106 The git program to be used to fetch git repositories.
107 --git-option opt
109 Additional common option to be passed to the git program.
110 --sha256 path
112 The sha256 program to be used to calculate SHA256 sums.
113 --sha256-option opt
115 Additional option to be passed to the sha256 program.
116 --tar path
118 The tar program to be used to extract package archives.
119 --tar-option opt
121 Additional option to be passed to the tar program.
122 --openssl path
124 The openssl program to be used for crypto operations.
125 --openssl-option opt
127 Additional option to be passed to the openssl program.
128 --auth type
130 Types of repositories to authenticate.
131 --trust fingerprint
133 Trust repository certificate with a SHA256 fingerprint.
134 --trust-yes
136 Assume the answer to all authentication prompts is yes.
137 --trust-no
139 Assume the answer to all authentication prompts is no.
140 --git-capabilities up=pc
142 Protocol capabilities (pc) for a git repository URL prefix (up).
143 --pager path
145 The pager program to be used to show long text.
146 --pager-option opt
148 Additional option to be passed to the pager program.
149 --options-file file
151 Read additional options from file.
152 --default-options dir
154 The directory to load additional default options files from.
155 --no-default-options
157 Don't load default options files.
158 --keep-tmp
160 Don't remove the bpkg's temporary directory at the end of the
161 command execution and print its path at the verbosity level 2 or
162 higher.
163
165 See bpkg-default-options-files(1) for an overview of the default op‐
166 tions files. For the pkg-fetch command the search start directory is
167 the configuration directory. The following options files are searched
168 for in each directory and, if found, loaded in the order listed:
169 bpkg.options
171 bpkg-pkg-fetch.options
172 The following pkg-fetch command options cannot be specified in the de‐
174 fault options files:
175 --directory|-d
177 --purge|-p
178
180 Send bug reports to the users@build2.org mailing list.
181
183 Copyright (c) 2014-2023 the build2 authors.
184 Permission is granted to copy, distribute and/or modify this document
186 under the terms of the MIT License.
187bpkg 0.16.0 June 2023 bpkg-pkg-fetch(1)