bpkg-pkg-clean(1)

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

💅 bpkg-pkg-clean — clean package 💅

okay bestie, welcome to the bpkg-pkg-clean page from the General Commands Manual section, aka section 1 of the bpkg docs 🫶 this is the one that goes and scrubs your built packages squeaky clean, no cap.

🌸 SYNOPSIS 🌸

bpkg pkg-clean|clean [options] [vars] pkg...
bpkg pkg-clean|clean [options] [vars] --all|-a
bpkg pkg-clean|clean [options] [vars] (--all-pattern <pattern>)...

🦋 DESCRIPTION 🦋

so the pkg-clean command cleans the packages you name (that's form number one, the first line up there), or it cleans all the held packages (form two — peep bpkg-pkg-status(1) if you wanna know what "held" even means), or it cleans all the held packages that match any of the wildcard patterns you throw at it (form three, the --all-pattern situation) ✨

and wait, there's more: you can also clean the immediate or all dependencies of those packages by passing --immediate|-i or --recursive|-r respectively. iconic behaviour, honestly.

underneath it all, this command literally doesn't do much more than run b clean. that's the whole vibe 💀

⚠️ heads up bestie: in the first form, the packages you specify must have been previously configured with bpkg-pkg-build(1) or bpkg-pkg-configure(1). no configure, no clean, that's just how it is 😭

also!! you can pass extra command line variables (vars, normally config.*) through to the build system. those variables apply to all the specified packages, but you can also scope them to only specific packages using the argument grouping mechanism — go read bpkg-argument-grouping(1) for the deets 🎀

👑 PKG-CLEAN OPTIONS 👑

  • --all|-a — clean all held packages. all of them. every last one 💖
  • --all-pattern pattern — clean held packages that match the specified wildcard pattern. repeat this option to match multiple patterns. note that you may need to quote the pattern to prevent expansion by your shell 🙈
  • --immediate|-i — also clean immediate dependencies.
  • --recursive|-r — also clean all dependencies, recursively. go deep, bestie 🌀
  • --directory|-d dir — assume configuration is in dir rather than in the current working directory.

🌈 COMMON OPTIONS 🌈

these are the common options, summarised below — the ✨detailed✨ description lives in bpkg-common-options(1), so go sip that tea if you want more.

  • -v — print essential underlying commands being executed.
  • -V — print all underlying commands being executed. the full receipts 📜
  • --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 🎀

see bpkg-default-options-files(1) for the full overview of the default options files. for the pkg-clean command, the search start directory is the configuration directory 💅

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

bpkg.options
bpkg-pkg-clean.options

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

  • --directory|-d

💀 BUGS 💀

found a bug? send bug reports to the users@build2.org mailing list. they're lovely, don't be shy 🫶

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, dated June 2024, page bpkg-pkg-clean(1) — now go forth and clean those packages, you absolute icon 👑✨💖

📦 where this page comes from