1bpkg-pkg-clean(1) General Commands Manual bpkg-pkg-clean(1)
2
6 bpkg-pkg-clean - clean package
7
9 bpkg pkg-clean|clean [options] [vars] pkg...
10 bpkg pkg-clean|clean [options] [vars] --all|-a
11 bpkg pkg-clean|clean [options] [vars] (--all-pattern <pattern>)...
12
14 The pkg-clean command cleans the specified packages (the first form),
15 all the held packages (the second form, see bpkg-pkg-status(1)), or all
16 the held packages that match any of the specified wildcard patterns
17 (the third form). Additionally, immediate or all dependencies of these
18 packages can be also cleaned by specifying the --immediate|-i or --re‐
19 cursive|-r options, respectively. Underneath, this command doesn't do
20 much more than run b clean. In the first form the specified packages
21 must have been previously configured with bpkg-pkg-build(1) or bpkg-
22 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).
29
31 --all|-a
32 Clean all held packages.
33 --all-pattern pattern
35 Clean held packages that match the specified wildcard pattern.
36 Repeat this option to match multiple patterns. Note that you may
37 need to quote the pattern to prevent expansion by your shell.
38 --immediate|-i
40 Also clean immediate dependencies.
41 --recursive|-r
43 Also clean all dependencies, recursively.
44 --directory|-d dir
46 Assume configuration is in dir rather than in the current work‐
47 ing directory.
48
50 The common options are summarized below with a more detailed descrip‐
51 tion available in bpkg-common-options(1).
52 -v Print essential underlying commands being executed.
54 -V Print all underlying commands being executed.
56 --quiet|-q
58 Run quietly, only printing error messages.
59 --verbose level
61 Set the diagnostics verbosity to level between 0 and 6.
62 --stdout-format format
64 Representation format to use for printing to stdout.
65 --jobs|-j num
67 Number of jobs to perform in parallel.
68 --no-result
70 Don't print informational messages about the outcome of perform‐
71 ing a command or some of its parts.
72 --structured-result fmt
74 Write the result of performing a command in a structured form.
75 --progress
77 Display progress indicators for long-lasting operations, such as
78 network transfers, building, etc.
79 --no-progress
81 Suppress progress indicators for long-lasting operations, such
82 as network transfers, building, etc.
83 --diag-color
85 Use color in diagnostics.
86 --no-diag-color
88 Don't use color in diagnostics.
89 --build path
91 The build program to be used to build packages.
92 --build-option opt
94 Additional option to be passed to the build program.
95 --fetch path
97 The fetch program to be used to download resources.
98 --fetch-option opt
100 Additional option to be passed to the fetch program.
101 --fetch-timeout sec
103 The fetch and fetch-like (for example, git) program timeout.
104 --pkg-proxy url
106 HTTP proxy server to use when fetching package manifests and ar‐
107 chives from remote pkg repositories.
108 --git path
110 The git program to be used to fetch git repositories.
111 --git-option opt
113 Additional common option to be passed to the git program.
114 --sha256 path
116 The sha256 program to be used to calculate SHA256 sums.
117 --sha256-option opt
119 Additional option to be passed to the sha256 program.
120 --tar path
122 The tar program to be used to extract package archives.
123 --tar-option opt
125 Additional option to be passed to the tar program.
126 --openssl path
128 The openssl program to be used for crypto operations.
129 --openssl-option opt
131 Additional option to be passed to the openssl program.
132 --auth type
134 Types of repositories to authenticate.
135 --trust fingerprint
137 Trust repository certificate with a SHA256 fingerprint.
138 --trust-yes
140 Assume the answer to all authentication prompts is yes.
141 --trust-no
143 Assume the answer to all authentication prompts is no.
144 --git-capabilities up=pc
146 Protocol capabilities (pc) for a git repository URL prefix (up).
147 --pager path
149 The pager program to be used to show long text.
150 --pager-option opt
152 Additional option to be passed to the pager program.
153 --options-file file
155 Read additional options from file.
156 --default-options dir
158 The directory to load additional default options files from.
159 --no-default-options
161 Don't load default options files.
162 --keep-tmp
164 Don't remove the bpkg's temporary directory at the end of the
165 command execution and print its path at the verbosity level 2 or
166 higher.
167
169 See bpkg-default-options-files(1) for an overview of the default op‐
170 tions files. For the pkg-clean command the search start directory is
171 the configuration directory. The following options files are searched
172 for in each directory and, if found, loaded in the order listed:
173 bpkg.options
175 bpkg-pkg-clean.options
176 The following pkg-clean command options cannot be specified in the de‐
178 fault options files:
179 --directory|-d
181
183 Send bug reports to the users@build2.org mailing list.
184
186 Copyright (c) 2014-2023 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.16.0 June 2023 bpkg-pkg-clean(1)