NAME

bdep-help - show help for a command or help topic

SYNOPSIS

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

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

--bpkg path

The package manager program to be used for build configuration management.

--bpkg-option opt

Additional option to be passed to the package manager program.

--build path

The build program to be used to build packages.

--build-option opt

Additional option to be passed to the build program.

--curl path

The curl program to be used for network operations.

--curl-option opt

Additional option to be passed to the curl program.

--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 bdep-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:

bdep.options
bdep-help.options

BUGS

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

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.