Skip to main content

pkgcheck

CI Python 3.12+ License: BSD-3-Clause Ruff Checked with mypy

Integrity checker for Slackware Linux: verifies that the files recorded by each package in /var/log/packages/ really exist on the system.

  • Bulk extraction of FILE LIST: sections with ripgrep in a single pass (Python fallback if rg not found).
  • Parallel verification with ThreadPoolExecutor (broken symbolic links count as present: os.lstat is used).
  • Distinguishes missing files, backup-only (.bak/.orig) and no access (requires root), as well as .new configs pending review.
  • Decodes the octal escapes (\NNN) Slackware uses for names with non-ASCII bytes and discards sections after the FILE LIST (e.g. REQUIRES:).
  • Excludes install scripts (install/) and pseudo-filesystems (dev/, sys/, proc/, run/, tmp/, var/tmp, var/cache, var/spool, var/log, mnt, media, …) with var/log/packages exception.
  • Reports files with verification errors too (JSON files_errors / ERRORS log section).
  • Finds orphan files not owned by any package (--orphans) and diffs two runs (--diff with --list-logs).
  • Shell completion for bash/zsh/fish (--completion).
  • Live progress and report with rich; summary + breakdown per package.
  • Automatic log in /var/log/pkgcheck/pkgcheck-<date>.log (.json with --json).
  • Internationalized interface (7 languages) with automatic OS locale detection.

Requirements

  • Python 3.12+
  • uv
  • ripgrep (rg) recommended (falls back to Python scan if missing)

Getting started

uv sync                # creates .venv and installs the project and its dependencies
uv run pkgcheck --version

It can also be run as a module: uv run python -m pkgcheck.

Usage

sudo uv run pkgcheck                          # analyzes /var/log/packages and writes the log
sudo uv run pkgcheck --json                   # writes the log in JSON format (.json)
uv run pkgcheck --no-elevate --json           # without root: only prints the JSON to stdout
uv run pkgcheck --workers 16                  # adjusts the parallelism
uv run pkgcheck --packages-dir /mnt/root/var/log/packages
sudo uv run pkgcheck --check-libs-deps        # also checks library dependencies (ldd)
sudo uv run pkgcheck --check-libs-deps --check-libs-symbols   # + undefined symbols (nm -D)
uv run pkgcheck --orphans --orphans-root /    # lists untracked files
uv run pkgcheck --list-logs                   # lists existing logs
uv run pkgcheck --diff --from latest --to /var/log/pkgcheck/pkgcheck-...json --json
uv run pkgcheck --completion bash > /etc/bash_completion.d/pkgcheck

Library dependencies (--check-libs-deps)

Inspired by Gentoo's revdep-rebuild, this optional check verifies that every installed ELF binary and shared library has all of its dynamic library dependencies present on the system. For each ELF file ldd is run (in parallel) and any not found dependency is flagged:

  • The broken binary/library and the owning package are reported.
  • A best-effort guess is made for which installed package should provide each missing library (matched by library basename; it may be None when the soname does not match any installed file).
  • Results are grouped by package in the broken_libs section of the JSON report ({package: [{binary, missing, provided_by}]}) and in the text log under BROKEN LIBRARY DEPS:.

Requires ldd (present on Slackware/glibc). It is opt-in because running ldd over the whole system is expensive.

Undefined symbols (--check-libs-symbols)

An optional, extra mode (mirrors revdep-rebuild's -u / SEARCH_SYMBOLS). After collecting the set of dynamic symbols exported by the installed libraries using nm -D, it flags binaries that import symbols no installed library provides. It requires --check-libs-deps and the nm tool (binutils), and is prone to false positives (lazy binding, dlopen-loaded libraries, symbol versioning). Results appear in the undefined_symbols JSON key and the UNDEFINED SYMBOLS log section.

Root privileges

Some protected files (e.g. /var/spool/atjobs, /root) can only be checked with root privileges. If the process is not running as root:

  • In an interactive terminal you are asked whether to re-run with sudo.
  • --elevate re-runs with sudo without asking.
  • --no-elevate (or --quiet, or non-interactive output) verifies only what is accessible and warns.

Install scripts and pseudo-filesystems

Entries under install/ (install/doinst.sh, install/slack-desc, install/douninst.sh, install/slack-required) are metadata that Slackware does not leave on disk, so they are excluded from the analysis and shown as an informational counter.

The pseudo-filesystems and ephemeral paths (dev/, sys/, proc/, run/, tmp/, var/run/, var/tmp/, var/cache/, var/spool/, var/lock/, var/log/ (except var/log/packages/), var/lib/slackpkg/, mnt/, media/, srv/, lost+found/) are also not tracked: their entries (e.g. the device nodes of the devs package) are dynamic and do not persist. More prefixes can be added with --exclude. Ripgrep is preferred but a pure-Python fallback is used if rg is not found.

Pending new configs (.new)

Slackware records configs with the .new suffix in FILE LIST (e.g. etc/ssl/openssl.cnf.new). On install, the package script renames the file to the name without suffix (.new → ``); if that file already existed on the system, it keeps the .new suffix and it is left pending review by the user.

pkgcheck honors this semantics:

  • foo.conf.new recorded and foo.conf present → installed correctly (not reported).
  • foo.conf.new present on disk → reported as pending review (the new version awaits your decision).
  • foo.conf.new recorded but with no trace → missing.

The suffix is adjusted with --new-suffix (default .new). The detail appears in the report (key files_pending_new in JSON) and in the console tree.

Backup-only files

If a recorded path does not exist but a backup-suffix variant (.bak or .orig) does, it is reported as backup-only instead of missing. The set of suffixes is adjusted with --backup-suffixes. The per-package detail appears in the report (key files_backup in JSON), not in the console tree.

Orphan files (--orphans)

With --orphans pkgcheck also reports files present on disk but not owned by any package (e.g. make install leftovers). The scan walks --orphans-root (default /) and excludes the pseudo-filesystems above plus home/ and any --exclude. Results appear in summary.orphans and orphans JSON key and in the ORPHANS text section and console tree.

Log listing and diff (--list-logs, --diff)

  • --list-logs prints a table of existing logs in /var/log/pkgcheck/ (idx, date, fmt, size, path).
  • --diff --from PATH --to PATH (or latest/latest-1 aliases) diffs two JSON reports (missing, files_backup, ..., orphans, broken_libs). In text mode it shows + added/- removed per package; with --json it prints a JSON diff. Text logs (.log) are not diffable.

Shell completion (--completion)

--completion bash|zsh|fish prints a completion script to stdout. Example: pkgcheck --completion bash > /etc/bash_completion.d/pkgcheck.

Automatic log

Each run writes a log in /var/log/pkgcheck/ (the directory is created if it does not exist) with the convention:

pkgcheck-dd-mm-yyyy-hh-mm-ss.log    # plain text (default)
pkgcheck-dd-mm-yyyy-hh-mm-ss.json   # with --json
  • Requires root privileges: the default run uses sudo, so the log is saved automatically. If it cannot be written, a warning is shown and the analysis continues.
  • With --no-elevate (or non-interactive output without root) no file is saved: the result is only shown on screen (rich in text mode; with --json only the JSON document is printed to stdout).
  • With --json, progress and process messages go to stderr (scan phases, progress bar and completion line), so stdout is reserved for the JSON document (no-elevate) or the confirmation of the saved log (root). In text mode progress is shown in the console itself.
  • If two runs collide on the same second, a numeric suffix is added (pkgcheck-<date>-1.log, -2, ...).

The JSON document includes a timestamp (ISO 8601), generator, version, summary and the per-package indexes missing, files_backup, files_pending_new, no_access and files_errors. With --check-libs-deps the broken_libs index is added, and with --check-libs-symbols also undefined_symbols. These keys are stable and never localized.

Internationalization

The interface, the help and the text log are localized according to the operating system language. Supported languages: en (base), es, pt, fr, de, zh (Simplified Chinese) and ja.

Precedence for choosing the language:

  1. --lang {en,es,pt,fr,de,zh,ja}
  2. PKGCHECK_LANG environment variable
  3. OS locale (LC_ALL, LC_MESSAGES or LANG)
  4. English (default)

Translations live in src/pkgcheck/locales/{lang}.json (English → language mapping). To add a new language, create locales/xx.json with the same keys translated; if a key is missing, the English text is shown. The report JSON keys (missing, files_backup, ...) are not localized: they are the stable API.

Arguments

Argument Description
--packages-dir Directory with the records (default /var/log/packages).
--workers N Verification threads (default: auto).
--json Writes the log in JSON format (.json) instead of text.
--max-rows N Limits the per-package console breakdown.
--exclude PREFIX Additional prefix to exclude (repeatable or comma-separated).
--backup-suffixes Backup suffixes detected as backup-only (default .bak,.orig).
--new-suffix New-config suffix pending review (default .new).
--lang LANG Interface language (en,es,pt,fr,de,zh,ja); detects the OS language.
--check-libs-deps Also checks that every installed ELF binary/library has all its dynamic
library dependencies present (ldd; revdep-rebuild style).
--check-libs-symbols Also checks installed binaries for undefined dynamic symbols not
provided by any installed library using nm -D (requires `--check-libs-
deps`; may report false positives).
--orphans Also list orphan files not owned by any package.
--orphans-root Root for --orphans scan (default /).
--list-logs List existing logs in /var/log/pkgcheck and exit.
--diff Diff two JSON logs (requires --from/--to, supports latest).
--from PATH First log for --diff.
--to PATH Second log for --diff.
--completion Generate shell completion (bash/zsh/fish) and exit.
--quiet Hides progress and breakdown; only prints the summary.
--elevate Re-runs with sudo if root privileges are not available.
--no-elevate Does not ask for root privileges; only verifies what is accessible.
--version Shows the version.

Code quality

make check          # lint + format-check + typecheck + test
make coverage       # tests with coverage (>=80%)
make audit          # pip-audit
uv run ruff check
uv run ruff format --check
uv run mypy src
uv run coverage run -m unittest discover -s tests && uv run coverage report

Tooling: ruff (E,F,W,I,UP,B,SIM,C4,RET,ARG,RUF,S,ANN,PTH,T20,D), mypy --strict, coverage (branch, fail_under 90, total 93%), pip-audit, pre-commit.

Contributing

See CONTRIBUTING.md for development setup, uv sync --group dev, and pre-commit install.

Changelog

See CHANGELOG.md.

Security

--check-libs-deps runs ldd which executes the target via the dynamic loader (LD_TRACE). Only run on trusted installations; see src/pkgcheck/libdeps.py note.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

slackware_pkgcheck-1.0.0.tar.gz (130.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

slackware_pkgcheck-1.0.0-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

Details for the file slackware_pkgcheck-1.0.0.tar.gz.

File metadata

  • Download URL: slackware_pkgcheck-1.0.0.tar.gz
  • Upload date:
  • Size: 130.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.14

File hashes

Hashes for slackware_pkgcheck-1.0.0.tar.gz
Algorithm Hash digest
SHA256 18be8fdf4d1b671b2fd7466fe3435443b8418a1bfe06e7c7005f6386b379d488
MD5 687f551b977e3c39812af0903fc2708f
BLAKE2b-256 b6edef66b0eaa05080b4b18135e6b271d273d3477af6b9221d7f6ea1aa2371f6

See more details on using hashes here.

File details

Details for the file slackware_pkgcheck-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for slackware_pkgcheck-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ea8aa8428d020e46b42e1917036ef54b86f8b0dd2392dd1a5435c8fe59eb69e
MD5 580386e321405cb13abc5efe45286838
BLAKE2b-256 76e4b3a1a9c7b7590ab4145ea4ac9165e028afbd6e5b08d73865d7c091758ee3

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.2

2 files

This release

1.0.0 This release

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page