bpkg-cfg-info(1)

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

💅 bpkg-cfg-info(1) — bestie edition ✨

okay so you found the bpkg-cfg-info manual page, and honestly? it's giving "tiny command, big main character energy." let me walk you through it, no cap. 🫶

🌸 NAME 🌸

bpkg-cfg-info — print configuration information 💖

✨ SYNOPSIS ✨

bpkg cfg-info [options]

🦋 DESCRIPTION 🦋

okay so here's the vibe: the cfg-info command prints your current configuration's absolute path, id, type, and name. that's the core four, bestie. 🎀

now if you also throw in the --link and/or --backlink options, then it prints that same info for each linked and/or implicitly backlinked configuration too — if any exist. and listen, the dangling implicit backlinks? they get silently skipped, like they're not even in the group chat. 👻 unless you specify --dangling, in which case yes bestie, we print their info too.

and ngl, super important detail: all of this info goes to stdout, not stderr. periodt. 💅

if you specify --recursive together with --link and/or --backlink, then it prints this info for linked and/or implicitly backlinked configurations, recursively. it just keeps going. iconic behavior honestly. 🔥

the output format is regular — each value printed on its own separate line, prefixed with the value name. and if --link, --backlink, and/or --dangling are specified, then the information blocks corresponding to linked configurations are separated with blank lines. here's an example so you can see the layout exactly:

path: /path/to/cfg/
uuid: 8d439f03-7342-4502-8b1c-74b173869478
type: target
name: foo

path: /path/to/host-cfg/
uuid: 7ee4dab3-07d9-4163-81c0-3779166a7213
type: host
name: tools

path: /path/to/build2-cfg/
uuid: d453aa2a-92c4-4066-87e4-c8672eed06e1
type: build2
name: modules

see? cute little blocks. 🌈

🌟 CFG-INFO OPTIONS 🌟

  • --link — Print linked configurations. 🔗
  • --backlink — Print implicitly backlinked configurations. 🔙
  • --dangling — Print dangling implicit backlinks. 👻
  • --recursive — Print linked configurations recursively. 🌀
  • --directory|-d dir — Assume configuration is in dir rather than in the current working directory. 📁

🎀 COMMON OPTIONS 🎀

these are the common options, summarized below — and if you want the full detailed description, it's over in bpkg-common-options(1). iykyk. ✨

  • -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 🧚

okay so for the full overview of the default options files, go peek at bpkg-default-options-files(1). 💜

for the cfg-info command specifically, the search start directory is the configuration directory. and the following options files get searched for in each directory and, if found, loaded in the order listed:

bpkg.options
bpkg-cfg-info.options

and listen — these cfg-info command options cannot be specified in the default options files:

  • --directory|-d 🚫
like, sorry bestie, that one's not allowed in there. rules are rules. 💅

💀 BUGS 💀

Send bug reports to the users@build2.org mailing list. 📧 (yes, actually email them, don't just vague-post about it 😭)

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!! 🎀 you understood it, you slayed it, you're basically a configuration whisperer now. this was bpkg version 0.17.0, from June 2024 — and yes, it really is bpkg-cfg-info(1), manual page and all. mwah. 💖

📦 where this page comes from