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

NAME

6       bpkg-pkg-purge - purge package
7

SYNOPSIS

9       bpkg pkg-purge [options] pkg
10

DESCRIPTION

12       The  pkg-purge  command  removes the package directory and archive from
13       the filesystem and removes the package from  the  configuration.   Only
14       packages  in the fetched and unpacked state (bpkg-pkg-status(1)) can be
15       purged plus broken packages if the --force|-f option is specified  (see
16       the  option's  description  for details on purging broken packages). If
17       the --keep|-k option is specified, then the package archive is not  re‐
18       moved (see the option's description for details on this mode).
19

PKG-PURGE OPTIONS

21       --keep|-k
22              Keep  the package archive. Note that in this mode the package is
23              still retained in the configuration's database  in  the  fetched
24              state.
25
26       --force|-f
27              Purge  a  broken package. In this mode bpkg will verify that the
28              package directory and archive no longer exist  and  then  remove
29              the package from the configuration.
30
31       --directory|-d dir
32              Assume  configuration is in dir rather than in the current work‐
33              ing directory.
34

COMMON OPTIONS

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

DEFAULT OPTIONS FILES

155       See  bpkg-default-options-files(1)  for  an overview of the default op‐
156       tions files. For the pkg-purge command the search  start  directory  is
157       the  configuration  directory. The following options files are searched
158       for in each directory and, if found, loaded in the order listed:
159
160       bpkg.options
161       bpkg-pkg-purge.options
162
163       The following pkg-purge command options cannot be specified in the  de‐
164       fault options files:
165
166       --directory|-d
167

BUGS

169       Send bug reports to the users@build2.org mailing list.
170
172       Copyright (c) 2014-2023 the build2 authors.
173
174       Permission  is  granted to copy, distribute and/or modify this document
175       under the terms of the MIT License.
176
177
178
179bpkg 0.16.0                        June 2023                 bpkg-pkg-purge(1)
Impressum