MKFS.S3QL(1)

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

💖 MKFS.S3QL(1) 💖

okay bestie, sit down, hydrate, because we're about to talk about the s3ql manual page and honestly? it's giving legendary. this is mkfs.s3ql from the S3QL fam, and she's here to make you a whole brand new file system. no cap.

✨ NAME ✨

mkfs.s3ql — Create an S3QL file system 🎀

🦋 SYNOPSIS 🦋

mkfs.s3ql [options] <storage url>

🌸 DESCRIPTION 🌸

S3QL is a file system for online data storage. before you go anywhere near it, bestie, please consult the full documentation — not just the man pages, because the man pages only briefly document the available userspace commands. they're like the trailer, not the movie. 🙈

The mkfs.s3ql command creates a new file system in the location specified by storage url. and here's the thing — the format of the storage url depends on the backend that is used. so which url shape do you need? the S3QL User's Guide should be consulted for a description of the available backends. iykyk. ✨

Unless you have specified the --plain option, mkfs.s3ql will ask you to enter an encryption password. and listen — this password will not be read from an authentication file specified with the --authfile option, and that's on purpose: it's there to prevent accidental creation of an encrypted file system. so yes, you actually have to type it. periodt. 💅

💅 OPTIONS 💅

The mkfs.s3ql command accepts the following options.

  • --cachedir <path> — Store cached data in this directory (default: ~/.s3ql) 🗂️
  • --log <target> — Destination for log messages. Specify none for standard output or syslog for the system logging daemon. Anything else will be interpreted as a file name. Log files will be rotated when they reach 1 MiB, and at most 5 old log files will be kept. Default: None 📜
  • --debug-modules <modules> — Activate debugging output from specified modules (use commas to separate multiple modules, 'all' for everything). Debug messages will be written to the target specified by the --log option. 🐛
  • --debug — Activate debugging output from all S3QL modules. Debug messages will be written to the target specified by the --log option. 🐞
  • --quiet — be really quiet 🤫
  • --backend-options <options> — Backend specific options (separate by commas). See backend documentation for available options. ⚙️
  • --version — just print program version and exit 👋
  • --authfile <path> — Read authentication credentials from this file (default: ~/.s3ql/authinfo2) 🔑
  • -L <name> — Filesystem label 🏷️
  • --data-block-size <size> — Block size (in KiB) to use for storing file contents. Files larger than this size will be stored in multiple backend objects. Backend object size may be smaller than this due to compression. Default: 1024 KiB. 📦
  • --metadata-block-size <size> — Block size (in KiB) to use for storing filesystem metadata. Backend object size may be smaller than this due to compression. Default: 64 KiB. 🧠
  • --plain — Create unencrypted file system. 🙈

👑 EXIT CODES 👑

mkfs.s3ql may terminate with the following exit codes:

  1. Everything went well. 🎉 slay.
  2. An unexpected error occurred. This may indicate a bug in the program. 💀
  3. Invalid command line argument or configuration file key.
  4. Invalid backend option.
  5. No such backend.
  6. Authentication file has insecure permissions. 🚨
  7. Unable to parse proxy settings.
  8. Invalid credentials (Authentication failed). 😭
  9. No permission to access backend (Authorization denied).
  10. Invalid storage URL, specified location does not exist in backend.
  11. Unable to connect to backend, can't resolve hostname. 🌐
  12. Unable to access cache directory.

🌈 SEE ALSO 🌈

The S3QL homepage is at https://github.com/s3ql/s3ql/. 🫶

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>

okay that's the whole page, bestie. no notes. iconic behavior from the S3QL girlies. 💜

and for the cute sign-off: this is version 5.2.3, dated Nov 02, 2024, and the manual is MKFS.S3QL(1) — go make a file system, you absolute main character. ⭐🦋✨

📦 where this page comes from