S3QLADM(1)

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

✨ S3QLADM(1) ✨ — aka the s3qladm girlies' guide to managing S3QL file systems 💅

okay bestie, welcome to s3qladm, the S3QL manual page for the command that does stuff to your S3QL file systems. come sit with me, we're gonna go through this together and you're gonna understand every last bit of it. 🫶

🌸 SYNOPSIS 🌸

s3qladm [options] <action> <storage url>

where action can be any one of passphrase, restore-metadata, clear, recover-key or upgrade. that's the whole menu, no secret items, iykyk. ✨

💖 DESCRIPTION 💖

so, S3QL is a file system for online data storage. iconic. before you start using S3QL, bestie, please go read the full documentation — not just the man pages, because these man pages only briefly document the userspace commands that are available. the real tea is in the docs, fr fr.

the s3qladm command performs various operations on unmounted S3QL file systems.

⚠️ the file system must not be mounted when you use s3qladm, or things will go wrong badly. like, not cute-badly, actually-badly. unmount first, periodt.

the storage url depends on which backend you're using. go check the S3QL User's Guide for a description of all the available backends, because there are options and you deserve to know them. 💜

🎀 OPTIONS 🎀

the s3qladm command accepts the following options. yes, all of them. no skipping.

  • --authfile <path> — read your authentication credentials from this file instead. default is ~/.s3ql/authinfo2, so if you're not using the default, spill the path here. 🔑
  • --debug-modules <modules> — turn on debugging output from the modules you name. separate multiple modules with commas, or just say all to get everything. debug messages go to whatever target you set with the --log option. very "tell me everything" energy. 🕵️
  • --debug — turn on debugging output from all S3QL modules. again, those debug messages get written to whatever target --log is pointing at. the maximalist option, we love her.
  • --quiet — be really quiet. 🤫 that's it, that's the whole description, and honestly? respect.
  • --log <target> — where your log messages go. say none for standard output, or syslog for the system logging daemon. anything else gets interpreted as a file name. log files get rotated once they hit 1 MiB, and at most 5 old log files will be kept. default: None. 📝
  • --backend-options <options> — backend specific options, separated by commas. check the backend documentation to see which options are actually available. every backend's got its own little personality, ngl.
  • --cachedir <path> — store cached data in this directory. default is ~/.s3ql. 🗂️
  • --version — just print the program version and exit. short, sweet, slays.
💡 hint: run s3qladm <action> --help to get help on the additional arguments that the different actions take. seriously, do this, it's the cheat code.

🌈 ACTIONS 🌈

here are the actions you can specify. and again — please consult the S3QL User's Guide for more detailed information, because I'm just giving you the highlights, bestie. 👑

  • passphrase — changes the encryption passphrase of the file system. new password, who dis. 🔐
  • restore-metadata — interactively restore backups of the file system metadata. interactively, so it's gonna talk to you. be ready. 💬
  • clear — delete the file system with all the stored data. ⚠️ okay this one is the dramatic one. everything. gone. with all the stored data. be so sure before you do this.
  • recover-key — recover the master encryption key from an external backup. the glow-up-from-a-backup arc. 🗝️
  • upgrade — upgrade the file system to the newest revision. she's evolving. 🦋

💀 EXIT CODES 💀

s3qladm may terminate with the following exit codes, and each one is telling you a little something:

  • 0 — everything went well. ✨ the dream.
  • 1 — an unexpected error occurred. this may indicate a bug in the program. 🐛
  • 2 — invalid command line argument or configuration file key.
  • 3 — invalid backend option.
  • 10 — could not open log file for writing.
  • 11 — no such backend.
  • 12 — authentication file has insecure permissions.
  • 13 — unable to parse proxy settings.
  • 14 — invalid credentials (authentication failed).
  • 15 — no permission to access backend (authorization denied).
  • 16 — invalid storage URL, specified location does not exist in backend.
  • 17 — wrong file system passphrase. 😭 we've all been there.
  • 18 — no S3QL file system found at given storage URL.
  • 19 — unable to connect to backend, can't resolve hostname.
  • 45 — unable to access cache directory.

🦋 SEE ALSO 🦋

the S3QL homepage is at https://github.com/s3ql/s3ql/ — go say hi. 🏠

the full S3QL documentation should also be installed somewhere on your system. common locations are /usr/share/doc/s3ql or /usr/local/doc/s3ql. go peek, it's worth it. 📚

© 2008 Nikolaus Rath <Nikolaus@rath.org>

okay that's the whole page, you made it, I'm so proud of you. 🥹 this was s3qladm, manual page, version 5.2.3, dated Nov 02, 2024, and yes that's the S3QL manual — go forth and manage those file systems responsibly. mwah. 💖✨🎀

📦 where this page comes from