1bpkg-help(1) General Commands Manual bpkg-help(1)
2
6 bpkg-help - show help for a command or help topic
7
9 bpkg help [command | topic]
10
12 Show the detailed help for command or help topic or a summary of avail‐
13 able commands and topics if none was specified.
14
16 The common options are summarized below with a more detailed descrip‐
17 tion available in bpkg-common-options(1).
18 -v Print essential underlying commands being executed.
20 -V Print all underlying commands being executed.
22 --quiet|-q
24 Run quietly, only printing error messages.
25 --verbose level
27 Set the diagnostics verbosity to level between 0 and 6.
28 --stdout-format format
30 Representation format to use for printing to stdout.
31 --jobs|-j num
33 Number of jobs to perform in parallel.
34 --no-result
36 Don't print informational messages about the outcome of perform‐
37 ing a command or some of its parts.
38 --structured-result fmt
40 Write the result of performing a command in a structured form.
41 --progress
43 Display progress indicators for long-lasting operations, such as
44 network transfers, building, etc.
45 --no-progress
47 Suppress progress indicators for long-lasting operations, such
48 as network transfers, building, etc.
49 --diag-color
51 Use color in diagnostics.
52 --no-diag-color
54 Don't use color in diagnostics.
55 --build path
57 The build program to be used to build packages.
58 --build-option opt
60 Additional option to be passed to the build program.
61 --fetch path
63 The fetch program to be used to download resources.
64 --fetch-option opt
66 Additional option to be passed to the fetch program.
67 --fetch-timeout sec
69 The fetch and fetch-like (for example, git) program timeout.
70 --pkg-proxy url
72 HTTP proxy server to use when fetching package manifests and ar‐
73 chives from remote pkg repositories.
74 --git path
76 The git program to be used to fetch git repositories.
77 --git-option opt
79 Additional common option to be passed to the git program.
80 --sha256 path
82 The sha256 program to be used to calculate SHA256 sums.
83 --sha256-option opt
85 Additional option to be passed to the sha256 program.
86 --tar path
88 The tar program to be used to extract package archives.
89 --tar-option opt
91 Additional option to be passed to the tar program.
92 --openssl path
94 The openssl program to be used for crypto operations.
95 --openssl-option opt
97 Additional option to be passed to the openssl program.
98 --auth type
100 Types of repositories to authenticate.
101 --trust fingerprint
103 Trust repository certificate with a SHA256 fingerprint.
104 --trust-yes
106 Assume the answer to all authentication prompts is yes.
107 --trust-no
109 Assume the answer to all authentication prompts is no.
110 --git-capabilities up=pc
112 Protocol capabilities (pc) for a git repository URL prefix (up).
113 --pager path
115 The pager program to be used to show long text.
116 --pager-option opt
118 Additional option to be passed to the pager program.
119 --options-file file
121 Read additional options from file.
122 --default-options dir
124 The directory to load additional default options files from.
125 --no-default-options
127 Don't load default options files.
128 --keep-tmp
130 Don't remove the bpkg's temporary directory at the end of the
131 command execution and print its path at the verbosity level 2 or
132 higher.
133
135 See bpkg-default-options-files(1) for an overview of the default op‐
136 tions files. For the help command the following options files are
137 searched for only in the predefined directories (home, system, etc)
138 and, if found, loaded in the order listed:
139 bpkg.options
141 bpkg-help.options
142
144 Send bug reports to the users@build2.org mailing list.
145
147 Copyright (c) 2014-2023 the build2 authors.
148 Permission is granted to copy, distribute and/or modify this document
150 under the terms of the MIT License.
151bpkg 0.16.0 June 2023 bpkg-help(1)