NAME

bpkg – package manager

SYNOPSIS

bpkg --help
bpkg --version
bpkg help [command | topic]
bpkg [common-options] command [command-options] command-args

DESCRIPTION

The build2 package manager is used to manipulate configurations, packages, and repositories using a set of commands that are summarized below.

For a detailed description of any command or help topic, use the help command or see the corresponding man page (the man pages have the bpkg- prefix, for example bpkg-help(1)). Note also that command-options and command-args can be specified in any order and common-options can be specified as part of command-options.

A bpkg configuration is a directory that will contain packages built with similar settings. For example, a configuration can be for a specific target (i686, x86_64), compiler (clang, gcc) compile options (-O3, -g), and so on. Configurations are relatively cheap and can be created and thrown away as needed. Configurations can be moved and copied by simply moving and copying the directories. Note, however, that a move or copy may render some packages out-of-date. In the build2 build system terms a bpkg configuration is an amalgamation that contains packages as subprojects.

A bpkg package is an archive or directory that contains a build2 project plus a package manifest file. bpkg can either use package archives/directories directly from the filesystem or it can fetch archives from repositories.

A bpkg repository is a collection of packages as well as prerequisite and complement repositories. A repository is identified by its location, which can be a local filesystem path or a remote HTTP or HTTPS URL.

A typical bpkg workflow would consist of the following steps.

Create Configuration
bpkg create cc config.cxx=clang++ config.cc.coptions=-O3 \
  config.install.root=/usr/local config.install.sudo=sudo
Add Source Repositories
bpkg add https://pkg.cppget.org/1/stable

Repeat this command to add more repositories.

Fetch Available Packages List
bpkg fetch
Fetch and Build Packages
bpkg build libfoo bar
Drop Package
If some packages are no longer needed, we can remove them from the configuration.
bpkg drop libfoo
Refresh Available Packages List
bpkg fetch
Upgrade Packages
bpkg build bar
Install Packages
bpkg install bar

COMMANDS

help [topic]
bpkg-help(1) – show help for a command or help topic
cfg-create|create
bpkg-cfg-create(1) – create configuration
rep-info
bpkg-rep-info(1) – print repository information
rep-add|add
bpkg-rep-add(1) – add repository to configuration
rep-fetch|fetch
bpkg-rep-fetch(1) – fetch list of available packages
rep-create [dir]
bpkg-rep-create(1) – create repository
pkg-status|status
bpkg-pkg-status(1) – print package status
pkg-build|build
bpkg-pkg-build(1) – build package
pkg-drop|drop
bpkg-pkg-drop(1) – drop package
pkg-install|install
bpkg-pkg-install(1) – install package
pkg-uninstall|uninstall
bpkg-pkg-uninstall(1) – uninstall package
pkg-update|update
bpkg-pkg-update(1) – update package
pkg-test|test
bpkg-pkg-test(1) – test package
pkg-clean|clean
bpkg-pkg-clean(1) – clean package
pkg-verify archive
bpkg-pkg-verify(1) – verify package archive
pkg-fetch
bpkg-pkg-fetch(1) – fetch package archive
pkg-unpack
bpkg-pkg-unpack(1) – unpack package archive
pkg-configure
bpkg-pkg-configure(1) – configure package
pkg-disfigure
bpkg-pkg-disfigure(1) – disfigure package
pkg-purge
bpkg-pkg-purge(1) – purge package

HELP TOPICS

common-options
bpkg-common-options(1) – details on common options
repository-signing
bpkg-repository-signing(1) – how to sign repository

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

EXIT STATUS

Non-zero exit status is returned in case of an error.

BUGS

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