NAME
bpkg-help
– show help for a command or help topic
SYNOPSIS
bpkg help [command |
topic]
DESCRIPTION
Show the detailed help for command
or help
topic
or a summary of available commands and topics if
none was specified.
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.
--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
See bpkg-default-options-files(1)
for an overview of the default options files. For the
help
command the following options files are searched
for only in the predefined directories (home, system, etc) and, if found,
loaded in the order listed:
bpkg.options
bpkg-help.options
BUGS
Send bug reports to the
users@build2.org mailing list.