1bpkg-pkg-verify(1)          General Commands Manual         bpkg-pkg-verify(1)
2
3
4

NAME

6       bpkg-pkg-verify - verify package archive
7

SYNOPSIS

9       bpkg pkg-verify [options] file
10

DESCRIPTION

12       The  pkg-verify  command  verifies that the specified archive file is a
13       valid bpkg package. Specifically, it checks that the  file's  name  and
14       the  top-level  directory  inside the archive match the canonical name-
15       version form and that there is a valid manifest file in that  top-level
16       directory.  Additionally,  if  the  --deep option is specified, it also
17       checks that the required *-build values/files are present in the  mani‐
18       fest/archive and the files referenced by the *-file manifest values are
19       present in the archive and are not empty.
20

PKG-VERIFY OPTIONS

22       --silent
23              Suppress the error messages about the reason why the package  is
24              invalid. Just return the error status.
25
26       --deep Verify the presence of the required *-build values/files and the
27              validity of files referenced by the *-file manifest values.
28
29       --ignore-unknown
30              Ignore unknown manifest entries. By default, bpkg will refuse to
31              declare such a package valid since it cannot be sure the unknown
32              entries are valid. Note that this option also ignores  the  ver‐
33              sion  constraints  in the special toolchain build-time dependen‐
34              cies.
35
36       --manifest
37              Instead of printing the successful verification  result  in  the
38              human-readable form, dump the package manifest to stdout. If the
39              --deep option is specified, then in the resulting  manifest  the
40              *-file  values  are replaced with the contents of the referenced
41              files, the *-build values are automatically  added  (unless  the
42              corresponding files are absent), and the package dependency con‐
43              straints are completed.
44

COMMON OPTIONS

46       The common options are summarized below with a more  detailed  descrip‐
47       tion available in bpkg-common-options(1).
48
49       -v     Print essential underlying commands being executed.
50
51       -V     Print all underlying commands being executed.
52
53       --quiet|-q
54              Run quietly, only printing error messages.
55
56       --verbose level
57              Set the diagnostics verbosity to level between 0 and 6.
58
59       --stdout-format format
60              Representation format to use for printing to stdout.
61
62       --jobs|-j num
63              Number of jobs to perform in parallel.
64
65       --no-result
66              Don't print informational messages about the outcome of perform‐
67              ing a command or some of its parts.
68
69       --structured-result fmt
70              Write the result of performing a command in a structured form.
71
72       --progress
73              Display progress indicators for long-lasting operations, such as
74              network transfers, building, etc.
75
76       --no-progress
77              Suppress  progress  indicators for long-lasting operations, such
78              as network transfers, building, etc.
79
80       --diag-color
81              Use color in diagnostics.
82
83       --no-diag-color
84              Don't use color in diagnostics.
85
86       --build path
87              The build program to be used to build packages.
88
89       --build-option opt
90              Additional option to be passed to the build program.
91
92       --fetch path
93              The fetch program to be used to download resources.
94
95       --fetch-option opt
96              Additional option to be passed to the fetch program.
97
98       --fetch-timeout sec
99              The fetch and fetch-like (for example, git) program timeout.
100
101       --pkg-proxy url
102              HTTP proxy server to use when fetching package manifests and ar‐
103              chives from remote pkg repositories.
104
105       --git path
106              The git program to be used to fetch git repositories.
107
108       --git-option opt
109              Additional common option to be passed to the git program.
110
111       --sha256 path
112              The sha256 program to be used to calculate SHA256 sums.
113
114       --sha256-option opt
115              Additional option to be passed to the sha256 program.
116
117       --tar path
118              The tar program to be used to extract package archives.
119
120       --tar-option opt
121              Additional option to be passed to the tar program.
122
123       --openssl path
124              The openssl program to be used for crypto operations.
125
126       --openssl-option opt
127              Additional option to be passed to the openssl program.
128
129       --auth type
130              Types of repositories to authenticate.
131
132       --trust fingerprint
133              Trust repository certificate with a SHA256 fingerprint.
134
135       --trust-yes
136              Assume the answer to all authentication prompts is yes.
137
138       --trust-no
139              Assume the answer to all authentication prompts is no.
140
141       --git-capabilities up=pc
142              Protocol capabilities (pc) for a git repository URL prefix (up).
143
144       --pager path
145              The pager program to be used to show long text.
146
147       --pager-option opt
148              Additional option to be passed to the pager program.
149
150       --options-file file
151              Read additional options from file.
152
153       --default-options dir
154              The directory to load additional default options files from.
155
156       --no-default-options
157              Don't load default options files.
158
159       --keep-tmp
160              Don't  remove  the  bpkg's temporary directory at the end of the
161              command execution and print its path at the verbosity level 2 or
162              higher.
163

DEFAULT OPTIONS FILES

165       See  bpkg-default-options-files(1)  for  an overview of the default op‐
166       tions files. For the pkg-verify command the following options files are
167       searched for in the predefined directories (system, etc) and, if found,
168       loaded in the order listed:
169
170       bpkg.options
171       bpkg-pkg-verify.options
172

BUGS

174       Send bug reports to the users@build2.org mailing list.
175
177       Copyright (c) 2014-2023 the build2 authors.
178
179       Permission is granted to copy, distribute and/or modify  this  document
180       under the terms of the MIT License.
181
182
183
184bpkg 0.16.0                        June 2023                bpkg-pkg-verify(1)
Impressum