S3QLRM(1)

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

💖 S3QLRM — bestie edition 💖

okay so this is the s3qlrm page from the S3QL manual, section 1 (userspace commands, iykyk). buckle up, it's short but it's mighty. 🦋

✨ NAME ✨

s3qlrm — fast tree removal on S3QL file systems 🧚

🌸 SYNOPSIS 🌸

s3qlrm [options] <directory>

💅 DESCRIPTION 💅

okay so first thing: S3QL is a file system for online data storage. and like, before you go using S3QL at all, please please please go read the full documentation instead of just these man pages — the man pages only briefly document the available userspace commands. they're the little teaser trailer, not the whole movie. 🎬

now. the actual tea. ☕

The s3qlrm command recursively deletes files and directories on an S3QL file system. yes, it's faster than using e.g. rm -r — slay — but the real reason it exists, the main character reason, is that it lets you delete immutable trees as well (the kind you can create with s3qllock). so if you locked something and now you're stuck like 👁️👄👁️, this is your girl.

⚠️ okay this is the important part, no cap: there is no additional confirmation. none. zero. the directory will be removed entirely and immediately. it's giving "no takebacks". please be so fr when you type this. 💀

also, s3qlrm 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 that's the guest list. 🎟️

🎀 OPTIONS 🎀

The s3qlrm command accepts the following options:

  • --log <target> — where your log messages go, bestie. Say none and they go to standard output, say syslog and they go to the system logging daemon. Anything else gets interpreted as a file name. Log files get rotated when they hit 1 MiB, and at most 5 old log files will be kept. Default: None ✨
  • --debug-modules <modules> — turns on debugging output from the modules you name (use commas to separate multiple modules, or 'all' for everything). Those debug messages get written to whatever target you set with the --log option.
  • --debug — turns on debugging output from all S3QL modules. Again, debug messages go to the target specified by the --log option. 🔍
  • --quiet — be really quiet 🤫
  • --version — just print program version and exit 🫶

🌈 EXIT CODES 🌈

s3qlrm may terminate with the following exit codes:

  1. 0 — Everything went well. ate, no crumbs. 👑
  2. 1 — An unexpected error occurred. This may indicate a bug in the program. 😭
  3. 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. go look, it's worth it, fr fr. 📚

© 2008 Nikolaus Rath <Nikolaus@rath.org>

okay that's the whole page, you're all caught up. 💖 this was version 5.2.3, dated Nov 02, 2024, and honestly? iconic. go delete responsibly, bestie. 🎀✨

📦 where this page comes from