1bpkg-help(1)                General Commands Manual               bpkg-help(1)
2
3
4

NAME

6       bpkg-help - show help for a command or help topic
7

SYNOPSIS

9       bpkg help [command | topic]
10

DESCRIPTION

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

COMMON OPTIONS

16       The common options are summarized below with a more  detailed  descrip‐
17       tion available in bpkg-common-options(1).
18
19       -v     Print essential underlying commands being executed.
20
21       -V     Print all underlying commands being executed.
22
23       --quiet|-q
24              Run quietly, only printing error messages.
25
26       --verbose level
27              Set the diagnostics verbosity to level between 0 and 6.
28
29       --stdout-format format
30              Representation format to use for printing to stdout.
31
32       --jobs|-j num
33              Number of jobs to perform in parallel.
34
35       --no-result
36              Don't print informational messages about the outcome of perform‐
37              ing a command or some of its parts.
38
39       --progress
40              Display progress indicators for long-lasting operations, such as
41              network transfers, building, etc.
42
43       --no-progress
44              Suppress  progress  indicators for long-lasting operations, such
45              as network transfers, building, etc.
46
47       --build path
48              The build program to be used to build packages.
49
50       --build-option opt
51              Additional option to be passed to the build program.
52
53       --fetch path
54              The fetch program to be used to download resources.
55
56       --fetch-option opt
57              Additional option to be passed to the fetch program.
58
59       --fetch-timeout sec
60              The fetch and fetch-like (for example, git) program timeout.
61
62       --pkg-proxy url
63              HTTP proxy server to use when fetching package manifests and ar‐
64              chives from remote pkg repositories.
65
66       --git path
67              The git program to be used to fetch git repositories.
68
69       --git-option opt
70              Additional common option to be passed to the git program.
71
72       --sha256 path
73              The sha256 program to be used to calculate SHA256 sums.
74
75       --sha256-option opt
76              Additional option to be passed to the sha256 program.
77
78       --tar path
79              The tar program to be used to extract package archives.
80
81       --tar-option opt
82              Additional option to be passed to the tar program.
83
84       --openssl path
85              The openssl program to be used for crypto operations.
86
87       --openssl-option opt
88              Additional option to be passed to the openssl program.
89
90       --auth type
91              Types of repositories to authenticate.
92
93       --trust fingerprint
94              Trust repository certificate with a SHA256 fingerprint.
95
96       --trust-yes
97              Assume the answer to all authentication prompts is yes.
98
99       --trust-no
100              Assume the answer to all authentication prompts is no.
101
102       --pager path
103              The pager program to be used to show long text.
104
105       --pager-option opt
106              Additional option to be passed to the pager program.
107
108       --options-file file
109              Read additional options from file.
110
111       --default-options dir
112              The directory to load additional default options files from.
113
114       --no-default-options
115              Don't load default options files.
116
117       --keep-tmp
118              Don't  remove  the  bpkg's temporary directory at the end of the
119              command execution and print its path at the verbosity level 2 or
120              higher.
121

DEFAULT OPTIONS FILES

123       See  bpkg-default-options-files(1)  for  an overview of the default op‐
124       tions files. For the help  command  the  following  options  files  are
125       searched  for  only  in  the predefined directories (home, system, etc)
126       and, if found, loaded in the order listed:
127
128       bpkg.options
129       bpkg-help.options
130

BUGS

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

135       Copyright (c) 2014-2022 the build2 authors.
136
137       Permission is granted to copy, distribute and/or modify  this  document
138       under the terms of the MIT License.
139
140
141
142bpkg 0.15.0                        July 2022                      bpkg-help(1)
Impressum