luastatus-plugin-fs(7)

📦
version 0.6.0 · 2 versions
, in nixos 26.05

🌸 NAME 🌸

Okay bestie, this is luastatus-plugin-fs — the disk usage plugin for luastatus. It keeps an eye on your file system usage, and honestly? Iconic. 💖

✨ OVERVIEW ✨

This plugin monitors file system usage. It’s timer-driven, plus a wake-up FIFO can be specified if you want to poke it manually. 🫶

💅 OPTIONS 💅

The following options are supported:

  • paths — array of strings. For each of these paths, an information on usage of the file system it belongs to is returned. 🗂️
  • globs — array of strings. Same as paths, but it accepts glob patterns. It is not an error if the pattern expands to nothing — lowkey chill. Useful for monitoring filesystems which are mounted at runtime. ✨
  • period — number. A number of seconds to sleep before calling cb again. May be fractional. Defaults to 10. ⏰
  • fifo — string. Path to an existent FIFO. The plugin does not create FIFO itself. To force a wake-up, touch(1) the FIFO, that is, open it for writing and then close. 🫡

📊 cb argument 📊

A table where keys are paths and values are tables with the following entries:

  • total — number of bytes total; 💾
  • free — number of bytes free; 🍓
  • avail — number of bytes free for unprivileged users. 🌈

LGPLv3.

And that’s the page, bestie — the footer just says luastatus-plugin-fs(7), with no extra date or version drama. Go monitor those file systems and slay. 💅✨

📦 where this page comes from