bpkg-cfg-link(1)

🎀 NAME 🎀

bpkg-cfg-link — link configuration. that's the whole assignment, bestie 💖 this page is bpkg-cfg-link(1), and it's literally just about gluing one config to another. periodt.

---

🦋 SYNOPSIS 🦋

bpkg cfg-link [options] dir

---

✨ DESCRIPTION ✨

okay so the cfg-link command links the specified bpkg configuration with the current configuration. and bestie, it's not a one-way thing — it also establishes an implicit backlink from the specified configuration back to the current one. mutual. reciprocal. the two configs are in a committed relationship now 💞

if you wanna know the whole lore behind linked configurations, go read bpkg-cfg-create(1). and if you ever need to break them up, that's bpkg-cfg-unlink(1) — we don't do messy breakups here, we use the right command 💅

linked configurations are normally referred to using names when you specify them on the bpkg command line. unless you override it with the --name option, the original configuration name is used to name the link. and if the link ends up unnamed? no worries — you can refer to it either by the numeric id that gets automatically assigned when the link is established, or by the configuration UUID. so many ways to find your girl 🫶

now here's the path math, and it's actually iconic:

• if the specified configuration path is relative, then it gets rebased relative to the current configuration directory. this is the smart move, because when linked configurations are moved around together, the stored relative paths stay valid ✨
• if the specified directory path is absolute, then it's stored as absolute — unless you pass --relative, in which case it also gets rebased relative to the current configuration directory.

---

🌸 CFG-LINK OPTIONS 🌸

• --name name — alternative link name. if you don't specify this option, then the configuration name is used as the link name (see bpkg-cfg-create(1) for the details, bestie).
• --relative — rebase the absolute linked configuration path relative to the current configuration directory.
• --directory, -d dir — assume configuration is in dir rather than in the current working directory.

---

👑 COMMON OPTIONS 👑

here's the summary, but if you want the full deep dive, bpkg-common-options(1) has you covered 💜

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

for the big-picture overview of default options files, see bpkg-default-options-files(1) 💖

for the cfg-link command specifically, 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-cfg-link.options

and these cfg-link command options cannot be specified in the default options files:

• --directory, -d

not up for negotiation bestie, that one lives on the command line only 💅

---

💀 BUGS 💀

send bug reports to the users@build2.org mailing list. we're nice, we promise 🙈

---

🌈 COPYRIGHT 🌈

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, you ate that 🍓 this was bpkg 0.17.0, from June 2024 — bpkg-cfg-link(1), signing off, mwah 💅✨🦋