1bpkg-pkg-install(1) General Commands Manual bpkg-pkg-install(1)
2
6 bpkg-pkg-install - install package
7
9 bpkg pkg-install|install [options] [vars] pkg...
10 bpkg pkg-install|install [options] [vars] --all|-a
11 bpkg pkg-install|install [options] [vars] (--all-pattern <pattern>)...
12
14 The pkg-install command installs the specified packages (the first
15 form), all the held packages (the second form, see bpkg-pkg-status(1)),
16 or all the held packages that match any of the specified wildcard pat‐
17 terns (the third form). Additionally, immediate or all dependencies of
18 these packages can be also installed by specifying the --immediate|-i
19 or --recursive|-r options, respectively. Underneath, this command
20 doesn't do much more than run b install. In the first form the speci‐
21 fied packages must have been previously configured with bpkg-pkg-
22 build(1) or bpkg-pkg-configure(1).
23 Additional command line variables (vars, normally config.*) can be
25 passed to the build system. Such variables apply to all the specified
26 packages but can also be specified to only apply to specific packages
27 using the argument grouping mechanism (see bpkg-argument-grouping(1)
28 for details). In particular, this mechanism can be used to specify the
29 installation directory, for example:
30 bpkg install config.install.root=/usr/local \
32 config.install.sudo=sudo \
33 libfoo libbar
34 Alternatively, the installation directory can be specified once when
36 creating the configuration (bpkg-cfg-create(1)).
37
39 --all|-a
40 Install all held packages.
41 --all-pattern pattern
43 Install held packages that match the specified wildcard pattern.
44 Repeat this option to match multiple patterns. Note that you may
45 need to quote the pattern to prevent expansion by your shell.
46 --immediate|-i
48 Also install immediate dependencies.
49 --recursive|-r
51 Also install all dependencies, recursively.
52 --directory|-d dir
54 Assume configuration is in dir rather than in the current work‐
55 ing directory.
56
58 The common options are summarized below with a more detailed descrip‐
59 tion available in bpkg-common-options(1).
60 -v Print essential underlying commands being executed.
62 -V Print all underlying commands being executed.
64 --quiet|-q
66 Run quietly, only printing error messages.
67 --verbose level
69 Set the diagnostics verbosity to level between 0 and 6.
70 --stdout-format format
72 Representation format to use for printing to stdout.
73 --jobs|-j num
75 Number of jobs to perform in parallel.
76 --no-result
78 Don't print informational messages about the outcome of perform‐
79 ing a command or some of its parts.
80 --structured-result fmt
82 Write the result of performing a command in a structured form.
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 --diag-color
93 Use color in diagnostics.
94 --no-diag-color
96 Don't use color in diagnostics.
97 --build path
99 The build program to be used to build packages.
100 --build-option opt
102 Additional option to be passed to the build program.
103 --fetch path
105 The fetch program to be used to download resources.
106 --fetch-option opt
108 Additional option to be passed to the fetch program.
109 --fetch-timeout sec
111 The fetch and fetch-like (for example, git) program timeout.
112 --pkg-proxy url
114 HTTP proxy server to use when fetching package manifests and ar‐
115 chives from remote pkg repositories.
116 --git path
118 The git program to be used to fetch git repositories.
119 --git-option opt
121 Additional common option to be passed to the git program.
122 --sha256 path
124 The sha256 program to be used to calculate SHA256 sums.
125 --sha256-option opt
127 Additional option to be passed to the sha256 program.
128 --tar path
130 The tar program to be used to extract package archives.
131 --tar-option opt
133 Additional option to be passed to the tar program.
134 --openssl path
136 The openssl program to be used for crypto operations.
137 --openssl-option opt
139 Additional option to be passed to the openssl program.
140 --auth type
142 Types of repositories to authenticate.
143 --trust fingerprint
145 Trust repository certificate with a SHA256 fingerprint.
146 --trust-yes
148 Assume the answer to all authentication prompts is yes.
149 --trust-no
151 Assume the answer to all authentication prompts is no.
152 --git-capabilities up=pc
154 Protocol capabilities (pc) for a git repository URL prefix (up).
155 --pager path
157 The pager program to be used to show long text.
158 --pager-option opt
160 Additional option to be passed to the pager program.
161 --options-file file
163 Read additional options from file.
164 --default-options dir
166 The directory to load additional default options files from.
167 --no-default-options
169 Don't load default options files.
170 --keep-tmp
172 Don't remove the bpkg's temporary directory at the end of the
173 command execution and print its path at the verbosity level 2 or
174 higher.
175
177 See bpkg-default-options-files(1) for an overview of the default op‐
178 tions files. For the pkg-install command the search start directory is
179 the configuration directory. The following options files are searched
180 for in each directory and, if found, loaded in the order listed:
181 bpkg.options
183 bpkg-pkg-install.options
184 The following pkg-install command options cannot be specified in the
186 default options files:
187 --directory|-d
189
191 Send bug reports to the users@build2.org mailing list.
192
194 Copyright (c) 2014-2023 the build2 authors.
195 Permission is granted to copy, distribute and/or modify this document
197 under the terms of the MIT License.
198bpkg 0.16.0 June 2023 bpkg-pkg-install(1)