bpkg-pkg-drop(1)

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

💖 bpkg-pkg-drop — drop package 💖

okay bestie, welcome to bpkg-pkg-drop, from the General Commands Manual section of the bpkg universe ✨ this is the girl that drops packages. like, removes them from your configuration. and she does it with main character energy 👑

🌸 SYNOPSIS 🌸

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

three forms, three vibes, all valid 💅

🦋 DESCRIPTION 🦋

so here's the tea, bestie ☕

The pkg-drop command drops from the configuration the specified packages — that's the first form up there. It can also drop all the held packages (second form, and yes, peep bpkg-pkg-status(1) for the held-package lore), or drop all the held packages that match any of the specified wildcard patterns (third form). slay.

now, real talk: if the packages you're dropping still have dependent packages, those are gonna have to be dropped too, and you'll get a prompt asking you to confirm. not me being dramatic, that's just how it is 😭

and if the packages being dropped have dependency packages that would otherwise no longer be used? those get dropped as well — unless you pass the --keep-unused|-K option. so like, -K is the "no, leave my lil auto-built friends alone" flag 🫶

The pkg-drop command also supports several options (all described below, don't worry) that let you control the amount of work that will be done. you're in charge here, periodt ✨

🎀 PKG-DROP OPTIONS 🎀

  • --all|-a — Drop all held packages. all of them. every last one 💀
  • --all-pattern pattern — Drop held packages that match the specified wildcard pattern. Repeat this option to match multiple patterns (yes, it stacks, we love that for us). Note that you may need to quote the pattern to prevent expansion by your shell — your shell is nosy like that 🙈
  • --yes|-y — Assume the answer to all prompts is yes. but heads up bestie: this option does not apply to the dropping of dependents; use --drop-dependent for that. iykyk.
  • --no|-n — Assume the answer to all prompts is no. Only makes sense together with --print-only|-p. like, it literally only makes sense there.
  • --keep-unused|-K — Don't drop dependency packages that were automatically built but will no longer be used. protecting the auto-built girlies 🥹
  • --drop-dependent|-D — Don't warn about or ask for confirmation if dropping dependent packages. no drama, just vibes.
  • --keep-dependent — Issue an error if attempting to drop dependent packages. hard no, very firm boundaries 💅
  • --dependent-exit code — Silently exit with the specified error code if attempting to drop dependent packages. quiet, dramatic, iconic.
  • --disfigure-only — Disfigure all the packages but don't purge. disfigure but don't purge, that's the whole thing 🌸
  • --print-only|-p — Print to stdout what would be done without actually doing anything. manifesting the drop without the drop ✨
  • --plan header — Print the plan (even if --yes is specified) and start it with the header line (unless it is empty).
  • --directory|-d dir — Assume configuration is in dir rather than in the current working directory. tell her where to look 🫶

🌈 COMMON OPTIONS 🌈

The common options are summarized below, with a more detailed description available in bpkg-common-options(1). go read that if you want the full dissertation, but here's the quick rundown:

  • -v — Print essential underlying commands being executed.
  • -V — Print all underlying commands being executed. all of them. every single one.
  • --quiet|-q — Run quietly, only printing error messages. shhh 🤫
  • --verbose level — Set the diagnostics verbosity to level between 0 and 6. (0 through 6, that's the range, don't get creative.)
  • --stdout-format format — Representation format to use for printing to stdout.
  • --jobs|-j num — Number of jobs to perform in parallel. multitasking queen 👑
  • --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 an overview of the default options files. For the pkg-drop 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-drop.options

The following pkg-drop command options cannot be specified in the default options files:

  • --directory|-d
so yeah, --directory|-d is the one that has to be said out loud, in person, no sneaking it into a defaults file 🙈

💀 BUGS 💀

Send bug reports to the users@build2.org mailing list. (they're nice, promise 🫶)

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.

okay that's the whole page, bestie — you ate that 💅💖 this was bpkg-pkg-drop(1) from bpkg 0.17.0, dated June 2024 ✨ go forth and drop responsibly, mwah 🎀🦋

📦 where this page comes from