bpkg-pkg-purge(1)

📦
version 0.17.0 · 2 versions
, in fedora 43, fedora 44, nixos 26.05

💅 bpkg-pkg-purge(1) — General Commands Manual 🎀

okay so bestie, welcome to the pkg-purge page from the bpkg manual set. this is the one where we make a package disappear. let's get into it ✨

🌸 NAME 🌸

bpkg-pkg-purge — purge package. yes, that's the whole thing. it purges. iconic behavior honestly.

🦋 SYNOPSIS 🦋

bpkg pkg-purge [options] pkg

✨ DESCRIPTION ✨

okay so here's the tea ☕ — the pkg-purge command removes the package directory and archive from the filesystem and removes the package from the configuration. like, gone gone. no cap.

now, only packages in the fetched and unpacked state (peep bpkg-pkg-status(1) for that whole situation) can be purged. plus broken packages — but only if you specify the --force|-f option. (scroll down to that option's description for the deets on purging broken packages, bestie, it's giving ✨special case✨).

and if you specify the --keep|-k option? then the package archive does not get removed. again, option description below has the full lore on that mode. 🫶

💖 PKG-PURGE OPTIONS 💖

  • --keep|-k — Keep the package archive. heads up though: in this mode the package is still retained in the configuration's database, in the fetched state. so like, not a full ghosting. 👻
  • --force|-f — Purge a broken package. in this mode bpkg will verify that the package directory and archive no longer exist, and then remove the package from the configuration. checks first, deletes second. queen behavior 👑
  • --directory|-d dir — Assume configuration is in dir rather than in the current working directory.

🌈 COMMON OPTIONS 🌈

these are the shared ones, summarized below — the full ✨deluxe✨ description lives in bpkg-common-options(1).

  • -v — Print essential underlying commands being executed.
  • -V — Print all underlying commands being executed.
  • --quiet|-q — Run quietly, only printing error messages.
  • --verbose level — Set the diagnostics verbosity to level between 0 and 6.
  • --stdout-format format — Representation format to use for printing to stdout.
  • --jobs|-j num — Number of jobs to perform in parallel.
  • --no-result — Don't print informational messages about the outcome of performing a command or some of its parts.
  • --structured-result fmt — Write the result of performing a command in a structured form.
  • --progress — Display progress indicators for long-lasting operations, such as network transfers, building, etc.
  • --no-progress — Suppress progress indicators for long-lasting operations, such as network transfers, building, etc.
  • --diag-color — Use color in diagnostics.
  • --no-diag-color — Don't use color in diagnostics.
  • --build path — The build program to be used to build packages.
  • --build-option opt — Additional option to be passed to the build program.
  • --fetch path — The fetch program to be used to download resources.
  • --fetch-option opt — Additional option to be passed to the fetch program.
  • --fetch-timeout sec — The fetch and fetch-like (for example, git) program timeout.
  • --pkg-proxy url — HTTP proxy server to use when fetching package manifests and archives from remote pkg repositories.
  • --git path — The git program to be used to fetch git repositories.
  • --git-option opt — Additional common option to be passed to the git program.
  • --sha256 path — The sha256 program to be used to calculate SHA256 sums.
  • --sha256-option opt — Additional option to be passed to the sha256 program.
  • --tar path — The tar program to be used to extract package archives.
  • --tar-option opt — Additional option to be passed to the tar program.
  • --openssl path — The openssl program to be used for crypto operations.
  • --openssl-option opt — Additional option to be passed to the openssl program.
  • --auth type — Types of repositories to authenticate.
  • --trust fingerprint — Trust repository certificate with a SHA256 fingerprint.
  • --trust-yes — Assume the answer to all authentication prompts is yes.
  • --trust-no — Assume the answer to all authentication prompts is no.
  • --git-capabilities up=pc — Protocol capabilities (pc) for a git repository URL prefix (up).
  • --pager path — The pager program to be used to show long text.
  • --pager-option opt — Additional option to be passed to the pager program.
  • --options-file file — Read additional options from file.
  • --default-options dir — The directory to load additional default options files from.
  • --no-default-options — Don't load default options files.
  • --keep-tmp — Don't remove the bpkg's temporary directory at the end of the command execution and print its path at the verbosity level 2 or higher.

🧚 DEFAULT OPTIONS FILES 🧚

wanna know the whole default-options-files situation? go read bpkg-default-options-files(1) for the overview, bestie. for the pkg-purge command specifically, the search start directory is the configuration directory. 🌱

these options files get searched for in each directory and, if found, loaded in the order listed:

bpkg.options
bpkg-pkg-purge.options

and the following pkg-purge command options cannot be specified in the default options files:

  • --directory|-d
soz, that one's gotta come from your actual command line. rules are rules 💅

💀 BUGS 💀

found a bug? send bug reports to the users@build2.org mailing list. tell them we sent you. 🐛

Copyright (c) 2014-2024 the build2 authors.

Permission is granted to copy, distribute and/or modify this document under the terms of the MIT License.

and that's the whole page, bestie!! 🎀 this was bpkg version 0.17.0, from June 2024, and it's page bpkg-pkg-purge(1) of the manual. slay, go purge responsibly 💖✨🦋

📦 where this page comes from