DWARFSCK(1)

📦
version 0.15.8 · 2 versions
, in nixpkgs unstable

🎀 NAME 🎀

Okay bestie, this is dwarfsck from the General Commands Manual — literally the check-DwarFS-image girlie. dwarfsck — check DwarFS image. Periodt. 💅

✨ SYNOPSIS ✨

dwarfsck [-i] image [options...]

🦋 DESCRIPTION 🦋

So dwarfsck does a full check of a DwarFS filesystem image. No cap. 🫶

If everything works, it shows you details about the filesystem depending on the detail level you specified. If it finds an error, it exits with a non-zero exit code — not subtle, just honest. 💀

💅 OPTIONS 💅

  • -i, --input=file — path to the filesystem image. Like, where the image lives. 📁
  • -d, --detail=value — level of filesystem information detail. This can be a numeric level between 0 and 7, or a comma-separated list of feature names. The default corresponds to a level of 2. The feature names are shown in the command help. ✨
  • -q, --quiet — don't produce any output unless there is an error. Silent-mode icon behavior. 🤫
  • -v, --verbose — produce verbose output, where applicable. She's chatty. 💬
  • -O, --image-offset=value|auto — specify the byte offset at which the filesystem is located in the image. Use auto to detect the offset automatically. This is also the default. This is only useful for images that have some header located before the actual filesystem data. 🎯
  • -H, --print-header — print the header located before the filesystem image to stdout. If no header is present, the program will exit with exit code 2 and emit a warning. Heads up, bestie. 🚨
  • -l, --list — list all entries in the file system image. Uses output similar to tar -t. With --verbose, also print details about each entry. Iconic little directory moment. 📋
  • --checksum=name — produce a checksum using the specified algorithm for each regular file in the file system image. This can be used to easily verify the file system image against local files, e.g.: 🔥
dwarfsck --checksum=sha512 /tmp/fs.dwarfs | sha512sum --check
  • -n, --num-workers=value — number of worker threads used for integrity checking. The more helpers, the more teamwork. 💪
  • -s, --cache-size=value — size of the block cache, in bytes. You can append suffixes (k, m, g) to specify the size in KiB, MiB and GiB, respectively. Note that this is not the upper memory limit of the process, as there may be blocks in flight that are not stored in the cache. Also, each block that hasn't been fully decompressed yet will carry decompressor state along with it, which can use a significant amount of additional memory. Important caveat, don't skip it. 🧠
  • --check-integrity — instead of performing a fast checksum check, perform a (much slower) integrity check using the embedded SHA-512/256 hashes. Slow and thorough. She's taking her time. ⏳
  • --no-check — don't even perform a fast checksum check on the file system blocks. The metadata will still be checked to make sure it can safely be read. Use this if you want to quickly query file system information rather than performing an actual file system check. Lowkey just peeking. 👀
  • -j, --json — print a simple JSON representation of the filesystem metadata. Please note that the format is not stable. The level of detail also depends on the --detail switch. This can be useful in conjunction with the jq tool to extract file system information, for example generate a list of all categories in a file system image: 🌈
$ dwarfsck image.dwarfs --no-check -j | jq -r '.categories | keys .[]'
<default>
incompressible
pcmaudio/metadata
pcmaudio/waveform
  • --export-metadata=file — export all filesystem metadata to file in JSON format. Write to stdout if file is -. Dump it, bestie. 📤
  • --log-level=name — specify a logging level. 🪵
  • --log-with-context — enable logging context regardless of level. By default, context is enabled if the level is verbose, debug or trace. Context girlies stay winning. 🧚
  • -h, --help — show program help, including option defaults. The classic. 🫶
  • --man — if the project was built with support for built-in manual pages, this option will show the manual page. If supported by the terminal and a suitable pager (e.g. less) is found, the manual page is displayed in the pager. Fancy page-viewer moment. 📖

🌈 ENVIRONMENT VARIABLES 🌈

See dwarfs-env(7) dwarfs-env.md for environment variables that influence the behavior of dwarfsck. Env vars are doing their little background thing. 🌀

🍓 AUTHOR 🍓

Written by Marcus Holland-Moritz. 👑 Respect.

Copyright (C) Marcus Holland-Moritz. 💖

🔥 SEE ALSO 🔥

That's the whole page, bestie 🫶 — signed off with January 1980 and the manual name DWARFSCK(1). Slay. 💅✨

📦 where this page comes from