bpkg-pkg-checkout(1)

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

💖 bpkg-pkg-checkout(1) — the manual page, but make it make sense 💖

okay bestie, so this is the General Commands Manual page for bpkg-pkg-checkout, and I'm gonna walk you through it like we're texting at 2am. grab a snack. 🍓

✨ NAME ✨

bpkg-pkg-checkout — check out package version

like. it checks out a package version. that's the whole vibe. 👑

🌸 SYNOPSIS 🌸

bpkg pkg-checkout [options] pkg/ver

that's it. that's the shape of it. options go in, pkg/ver goes in, magic happens. ✨

🦋 DESCRIPTION 🦋

so the pkg-checkout command checks out the version of the package you asked for, and it pulls it from one of the version control-based repositories (peep bpkg-rep-add(1) for that). after all that, the resulting package state is unpacked — go look at bpkg-pkg-status(1) if you wanna confirm. 💅

here's where it gets kinda important, so pay attention bestie 😭

if you pass the --output-root option, then the package gets checked out into the directory you specified instead of into the configuration directory. when that happens, bpkg uses the package (source) directory in place, which is basically the same energy as the pkg-unpack --existing|-e mode. also — and this is the sneaky part — unless you also pass --output-purge, bpkg will not attempt to remove that directory when the package is later purged with the bpkg-pkg-purge(1) command. oh and heads up: a package like that is not external (the details live in bpkg-pkg-unpack(1) if you're nosy, and honestly you should be). 👀

and if you specify the --replace|-r option, then pkg-checkout will replace the archive and/or source directory of a package that is already in the unpacked or fetched state. so like, it's an override. it's giving "I said what I said". 🫶

💅 PKG-CHECKOUT OPTIONS 💅

these are the ones that belong to pkg-checkout specifically. the main character options, if you will. 🌈

  • --replace|-r — Replace the source directory if the package is already fetched or unpacked.
  • --output-root dir — Check out the package into the specified directory rather than into the configuration directory. heads up though: the package source is placed into the package-version subdirectory of this directory, so don't be surprised when it's nested. 🪆
  • --output-purge — Remove the checked out package (source) directory when the package is purged.
  • --directory|-d dir — Assume configuration is in dir rather than in the current working directory.

⭐ COMMON OPTIONS ⭐

here's the summary of the common options, and if you want the full tea there's a way more detailed description in bpkg-common-options(1). no cap. 📖

  • -v — Print essential underlying commands being executed.
  • -V — Print all underlying commands being executed. (yes, capital V means everything. it's a lot. it's a vibe.)
  • --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 🎀

want the whole overview of default options files? it's in bpkg-default-options-files(1), go read it, it's good for you. 🧚

for the pkg-checkout command, the search start directory is the configuration directory. these are the options files it looks for in each directory, and if it finds them, it loads them in the order listed:

bpkg.options
bpkg-pkg-checkout.options

and here's the thing — the following pkg-checkout command options cannot be specified in the default options files:

  • --directory|-d

so don't try it. it's not gonna work. periodt. 💀

😭 BUGS 😭

found a bug? send bug reports to the users@build2.org mailing list. they wanna hear it fr fr.

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 page bestie!! 🫶 this was bpkg version 0.17.0, from June 2024, and yes it's still bpkg-pkg-checkout(1) in case you lost track. go check out some packages. slay. 💖✨🎀

📦 where this page comes from