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

NAME

6       bpkg-pkg-clean - clean package
7

SYNOPSIS

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

DESCRIPTION

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
24       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

PKG-CLEAN OPTIONS

31       --all|-a
32              Clean all held packages.
33
34       --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
39       --immediate|-i
40              Also clean immediate dependencies.
41
42       --recursive|-r
43              Also clean all dependencies, recursively.
44
45       --directory|-d dir
46              Assume  configuration is in dir rather than in the current work‐
47              ing directory.
48

COMMON OPTIONS

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

DEFAULT OPTIONS FILES

145       See bpkg-default-options-files(1) for an overview of  the  default  op‐
146       tions  files.  For  the pkg-clean command the search start directory is
147       the configuration directory. The following options files  are  searched
148       for in each directory and, if found, loaded in the order listed:
149
150       bpkg.options
151       bpkg-pkg-clean.options
152
153       The  following pkg-clean command options cannot be specified in the de‐
154       fault options files:
155
156       --directory|-d
157

BUGS

159       Send bug reports to the users@build2.org mailing list.
160
162       Copyright (c) 2014-2021 the build2 authors.
163
164       Permission is granted to copy, distribute and/or modify  this  document
165       under the terms of the MIT License.
166
167
168
169bpkg 0.14.0                      October 2021                bpkg-pkg-clean(1)
Impressum