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 --progress
74 Display progress indicators for long-lasting operations, such as
75 network transfers, building, etc.
76 --no-progress
78 Suppress progress indicators for long-lasting operations, such
79 as network transfers, building, etc.
80 --build path
82 The build program to be used to build packages.
83 --build-option opt
85 Additional option to be passed to the build program.
86 --fetch path
88 The fetch program to be used to download resources.
89 --fetch-option opt
91 Additional option to be passed to the fetch program.
92 --fetch-timeout sec
94 The fetch and fetch-like (for example, git) program timeout.
95 --pkg-proxy url
97 HTTP proxy server to use when fetching package manifests and ar‐
98 chives from remote pkg repositories.
99 --git path
101 The git program to be used to fetch git repositories.
102 --git-option opt
104 Additional common option to be passed to the git program.
105 --sha256 path
107 The sha256 program to be used to calculate SHA256 sums.
108 --sha256-option opt
110 Additional option to be passed to the sha256 program.
111 --tar path
113 The tar program to be used to extract package archives.
114 --tar-option opt
116 Additional option to be passed to the tar program.
117 --openssl path
119 The openssl program to be used for crypto operations.
120 --openssl-option opt
122 Additional option to be passed to the openssl program.
123 --auth type
125 Types of repositories to authenticate.
126 --trust fingerprint
128 Trust repository certificate with a SHA256 fingerprint.
129 --trust-yes
131 Assume the answer to all authentication prompts is yes.
132 --trust-no
134 Assume the answer to all authentication prompts is no.
135 --pager path
137 The pager program to be used to show long text.
138 --pager-option opt
140 Additional option to be passed to the pager program.
141 --options-file file
143 Read additional options from file.
144 --default-options dir
146 The directory to load additional default options files from.
147 --no-default-options
149 Don't load default options files.
150 --keep-tmp
152 Don't remove the bpkg's temporary directory at the end of the
153 command execution and print its path at the verbosity level 2 or
154 higher.
155
157 See bpkg-default-options-files(1) for an overview of the default op‐
158 tions files. For the pkg-clean command the search start directory is
159 the configuration directory. The following options files are searched
160 for in each directory and, if found, loaded in the order listed:
161 bpkg.options
163 bpkg-pkg-clean.options
164 The following pkg-clean command options cannot be specified in the de‐
166 fault options files:
167 --directory|-d
169
171 Send bug reports to the users@build2.org mailing list.
172
174 Copyright (c) 2014-2022 the build2 authors.
175 Permission is granted to copy, distribute and/or modify this document
177 under the terms of the MIT License.
178bpkg 0.15.0 July 2022 bpkg-pkg-clean(1)