FSCK.S3QL(1)

📦 version 5.2.3, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ FSCK.S3QL ✨

okay bestie, so this is the manual page for fsck.s3ql — like, from the S3QL crew (that's S3QL, manual section 1, the userspace commands zone). let's get into it 💖

🌸 NAME 🌸

fsck.s3ql — check an S3QL file system for errors. that's it, that's the vibe. a little health checkup for your filesystem, and yes she WILL spill the tea about what's broken 🩺✨

🎀 SYNOPSIS 🎀

fsck.s3ql [options] <storage url>

that's the whole thing. options, then the storage url. simple queen behavior 💅

🦋 DESCRIPTION 🦋

S3QL is a file system for online data storage. before you go using S3QL, please consult the full documentation, not just these man pages — the man pages only briefly document the available userspace commands, and you deserve the whole story, not the cliffnotes 🥺

so, the fsck.s3ql command checks the file system in the location specified by storage url for errors, and then it attempts to repair any problems it finds. iconic. main character energy fr.

the format of the storage url depends on the backend that is used. so if you're like "what even goes in this url" — go read the S3QL User's Guide, it has a whole description of the available backends. iykyk 💜

✨ OPTIONS ✨

the fsck.s3ql command accepts the following options. buckle up, there's a lot and they're all kind of important.

  • --log <target> — where your log messages go. say none for standard output, or syslog for the system logging daemon. literally anything else gets interpreted as a file name. log files get rotated when they hit 1 MiB, and at most 5 old log files are kept around. default: ~/.s3ql/fsck.log
  • --cachedir <path> — store cached data in this directory. default: ~/.s3ql
  • --debug-modules <modules> — turn on debugging output from the specified modules. use commas to separate multiple modules, or 'all' for everything. debug messages get written to the target specified by the --log option.
  • --debug — activate debugging output from all S3QL modules. same deal, debug messages go to the target specified by the --log option.
  • --quiet — be really quiet 🤫
  • --backend-options <options> — backend specific options, separated by commas. see the backend documentation for what's available.
  • --version — just print program version and exit. no drama, in and out 💅
  • --authfile <path> — read authentication credentials from this file. default: ~/.s3ql/authinfo2
  • --compress <algorithm-lvl> — the compression algorithm and compression level to use when storing new data. algorithm may be any of lzma, bzip2, zlib, or none. lvl may be any integer from 0 (fastest) to 9 (slowest). default: lzma-6
  • --keep-cache — do not purge locally cached files on exit. keeping the cache, she's staying 🫶
  • --batch — if user input is required, exit without prompting. no questions, no waiting, just out.
  • --force — force checking even if the file system is marked clean. she doesn't care if you said you're fine.
  • --force-remote — force use of remote metadata even when this would likely result in data loss.
🚨 bestie this one is a warning not a suggestion. using --force-remote when it would likely cause data loss means data loss. treat it with the respect it deserves 😭

💀 EXIT CODES 💀

okay so here's the tea. if fsck.s3ql found any file system errors — no matter if they were corrected or not — the exit code will be 128 plus one of the codes listed below. if no errors were found, the following exit codes are used as-is:

  1. 0 — Everything went well. 🎉 we love a clean checkup.
  2. 1 — An unexpected error occurred. This may indicate a bug in the program. 🐛
  3. 2 — Invalid command line argument or configuration file key.
  4. 3 — Invalid backend option.
  5. 10 — Could not open log file for writing.
  6. 11 — No such backend.
  7. 12 — Authentication file has insecure permissions. fix those perms bestie 🔒
  8. 13 — Unable to parse proxy settings.
  9. 14 — Invalid credentials (Authentication failed).
  10. 15 — No permission to access backend (Authorization denied).
  11. 16 — Invalid storage URL, specified location does not exist in backend.
  12. 17 — Wrong file system passphrase.
  13. 18 — No S3QL file system found at given storage URL.
  14. 19 — Unable to connect to backend, can't resolve hostname.
  15. 32 — Unsupported file system revision (too old).
  16. 33 — Unsupported file system revision (too new).
  17. 40 — Cannot check mounted file system.
  18. 41 — User input required, but running in batch mode.
  19. 42 — File system check aborted by user.
  20. 43 — Local metadata is corrupted.
  21. 44 — Uncorrectable errors found. 😭
  22. 45 — Unable to access cache directory.
  23. 128 — This error code will be added to one of the codes above if any file system errors have been found (no matter if they were corrected or not).

🌈 SEE ALSO 🌈

  • The S3QL homepage is at https://github.com/s3ql/s3ql/ — go say hi, she's lovely 💖
  • The full S3QL documentation should also be installed somewhere on your system. common locations are /usr/share/doc/s3ql or /usr/local/doc/s3ql.

© 2008 Nikolaus Rath <Nikolaus@rath.org> — protecting this work since 2008, we love to see it 🫶

and that's the whole page bestie! this one's version 5.2.3, dated Nov 02, 2024, and it came to you straight from the S3QL era of FSCK.S3QL(1) 🎀✨ go check your filesystem, she deserves it 💜

📦 where this page comes from