bpkg-pkg-checkout - Man Page

check out package version

Synopsis

bpkg pkg-checkout [options] pkg/ver

Description

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 --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.

Pkg-Checkout Options

--replace|-r

Replace the source directory if the package is already fetched or unpacked.

--directory|-d dir

Assume configuration is in dir rather than in the current working directory.

Common Options

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

-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.

--jobs|-j num

Number of jobs to perform in parallel.

--no-result

Don't print informational messages about the outcome of performing a command.

--no-progress

Suppress progress indicators for long-lasting operations, such as network transfers, building, etc.

--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.

--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.

Default Options Files

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

Bugs

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

Referenced By

bpkg(1), bpkg-pkg-configure(1).

July 2020 bpkg 0.13.0