bpkg-pkg-verify(1)

📦
version 0.17.0 · 2 versions
, in fedora 43, fedora 44, nixos 26.05

✨ bpkg-pkg-verify — verify package archive ✨

okay bestie, so this is the bpkg-pkg-verify(1) page from the General Commands Manual, and I'm gonna walk you through it like we're texting at 2am 💖

🌸 NAME 🌸

bpkg-pkg-verify — verify package archive, no cap 💅

🦋 SYNOPSIS 🦋

bpkg pkg-verify [options] file

✨ DESCRIPTION ✨

so the pkg-verify command does exactly what it says on the tin — it verifies that the archive file you pointed at is a valid bpkg package. iconic behavior honestly.

specifically, it checks these things:

  • that the file's name and the top-level directory inside the archive both match the canonical name-version form 👑
  • that there's a valid manifest file sitting in that top-level directory 🎀

and then, if you also pass the --deep option, it goes deeper and also checks that:

  • the required *-build values/files are actually present in the manifest/archive 🧚
  • the files referenced by the *-file manifest values are present in the archive and are not empty 💀

💅 PKG-VERIFY OPTIONS 💅

  • --silent — shhh 🤫 suppresses the error messages explaining why the package is invalid. it just hands you the error status and nothing else.
  • --deep — the thorough one ✨ verify that the required *-build values/files are present, and check that files referenced by the *-file manifest values are actually valid.
  • --ignore-unknown — ignore unknown manifest entries 🫶 by default bpkg refuses to call a package valid when it sees these, because it literally cannot be sure those unknown entries are valid. note that this option also ignores the version constraints in the special toolchain build-time dependencies.
  • --manifest — instead of printing the successful verification result in human-readable form, dump the package manifest to stdout 📝 and if --deep is also on, then in the resulting manifest: the *-file values get replaced with the contents of the referenced files, the *-build values get automatically added (unless the corresponding files are absent), and the package dependency constraints get completed. chef's kiss 🍓

🌈 COMMON OPTIONS 🌈

here's the rundown of the common options — there's a more detailed description over in bpkg-common-options(1) if you want the extended lore 📖

  • -v — print the essential underlying commands being executed 🔍
  • -V — print all the 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, like network transfers, building, etc. ⏳
  • --no-progress — suppress progress indicators for long-lasting operations, like 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 the whole overview of default options files 👀

for the pkg-verify command, these options files get searched for in the predefined directories (system, etc) and, if they're found, they're loaded in this exact order:

bpkg.options
bpkg-pkg-verify.options

💀 BUGS 💀

found a bug? send those bug reports to the users@build2.org mailing list 📧 (be nice to them, they're doing their best 🫶)

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.

and that's the whole page bestie!! 💖 this was bpkg 0.17.0, dated June 2024, brought to you by the build2 girlies ✨ stay verified, stay valid, and remember: an empty file is NOT it. periodt 💅🌸

📦 where this page comes from