bpkg-pkg-checkout(1) General Commands Manual bpkg-pkg-checkout(1)

bpkg-pkg-checkout - check out package version

bpkg pkg-checkout [options] pkg/ver

The pkg-checkout command checks out the specified package version from one of the version control-based repositories (bpkg-rep-add(1)). The resulting package state is unpacked (bpkg-pkg-status(1)).

If the --output-root option is passed, then the package is checked out into the specified directory rather than into the configuration directory. In this case, bpkg uses the package (source) directory in place, similar to the pkg-unpack --existing|-e mode. Also, unless the --output-purge option is specified, bpkg will not attempt to remove this directory when the package is later purged with the bpkg-pkg-purge(1) command. Note also that such a package is not external (see bpkg-pkg-unpack(1) for details).

If the --replace|-r option is specified, then pkg-checkout will replace the archive and/or source directory of a package that is already in the unpacked or fetched state.

Replace the source directory if the package is already fetched or unpacked.
Check out the package into the specified directory rather than into the configuration directory. Note that the package source is placed into the package-version subdirectory of this directory.
Remove the checked out package (source) directory when the package is purged.
Assume configuration is in dir rather than in the current working directory.

The common options are summarized below with a more detailed description available in bpkg-common-options(1).

Print essential underlying commands being executed.
Print all underlying commands being executed.
Run quietly, only printing error messages.
Set the diagnostics verbosity to level between 0 and 6.
Representation format to use for printing to stdout.
Number of jobs to perform in parallel.
Don't print informational messages about the outcome of performing a command or some of its parts.
Write the result of performing a command in a structured form.
Display progress indicators for long-lasting operations, such as network transfers, building, etc.
Suppress progress indicators for long-lasting operations, such as network transfers, building, etc.
Use color in diagnostics.
Don't use color in diagnostics.
The build program to be used to build packages.
Additional option to be passed to the build program.
The fetch program to be used to download resources.
Additional option to be passed to the fetch program.
The fetch and fetch-like (for example, git) program timeout.
HTTP proxy server to use when fetching package manifests and archives from remote pkg repositories.
The git program to be used to fetch git repositories.
Additional common option to be passed to the git program.
The sha256 program to be used to calculate SHA256 sums.
Additional option to be passed to the sha256 program.
The tar program to be used to extract package archives.
Additional option to be passed to the tar program.
The openssl program to be used for crypto operations.
Additional option to be passed to the openssl program.
Types of repositories to authenticate.
Trust repository certificate with a SHA256 fingerprint.
Assume the answer to all authentication prompts is yes.
Assume the answer to all authentication prompts is no.
Protocol capabilities (pc) for a git repository URL prefix (up).
The pager program to be used to show long text.
Additional option to be passed to the pager program.
Read additional options from file.
The directory to load additional default options files from.
Don't load default options files.
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.

See bpkg-default-options-files(1) for an overview of the default options files. For the pkg-checkout 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-checkout.options

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

--directory|-d

Send bug reports to the users@build2.org mailing list.

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.

June 2024 bpkg 0.17.0