S3QLCTRL(1)

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

💖 S3QLCTRL 💖

okay bestie, you found it — this is the s3qlctrl page from the S3QL manual (yes, the whole manual is called S3QL, section 1, userspace commands, iykyk) and we're gonna make it make sense. grab a snack. 🍓

✨ NAME ✨

s3qlctrl — control a mounted S3QL file system 🎛️

🌸 SYNOPSIS 🌸

s3qlctrl [options] <action> <mountpoint> ...

where action may be either of flushcache, dropcache, log, cachesize or backup-metadata. that's the whole menu, no secret items 💅

🦋 DESCRIPTION 🦋

so. S3QL is a file system for online data storage. and before you go using S3QL, please please please consult the full documentation — like, actually read it — because these man pages only briefly document the available userspace commands. they're the trailer, not the movie. 😭

the s3qlctrl command performs various actions on the S3QL file system mounted in mountpoint.

s3qlctrl can only be called by the user that mounted the file system and (if the file system was mounted with --allow-other or --allow-root) the root user. so if it's not your mount and you're not root, this is not your moment. 🙈

the following actions may be specified:

  • flushcache — write all modified blocks to the backend. the command blocks until the cache is clean. it just stands there waiting, patiently, main character energy ✨
  • dropcache — flush the filesystem cache and then drop all contents (i.e., make the cache empty). gone. empty. 💀
  • log — change the amount of information that is logged. the complete syntax is:
s3qlctrl [options] log <mountpoint> <level> [<module> ...]

here level is the desired new log level and may be either of debug, info or warn. one or more module may only be specified with the debug level and allow to restrict the debug output to just the listed modules. no modules with info or warn, that's the rule 🫶

  • cachesize — changes the cache size of the file system. this action requires an additional argument that specifies the new cache size in KiB, so the complete command line is:
s3qlctrl [options] cachesize <mountpoint> <new-cache-size>
  • backup-metadata — trigger a metadata backup. go little backup go 🌈

🎀 OPTIONS 🎀

the s3qlctrl command also accepts the following options, no matter what specific action is being invoked. these are the ride-or-dies, always there for you:

  • --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 🤫
  • --version — just print program version and exit
hint: run s3qlctrl <action> --help to get help on the additional arguments that the different actions take. do it, bestie, it's free information 💜

💅 EXIT CODES 💅

s3qlctrl may terminate with the following exit codes:

  • 0 — everything went well. slay. ✨
  • 1 — an unexpected error occurred. this may indicate a bug in the program. 😭
  • 2 — invalid command line argument or configuration file key. 🙈

👑 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 thing, you ate it, periodt. 🫶 this was s3qlctrl from S3QL version 5.2.3, dated Nov 02, 2024 — go flush that cache, queen 💖✨🎀

📦 where this page comes from