LUASTATUS-PLUGIN-MEM-USAGE-LINUX(7)

📦
version 0.6.0 · 2 versions
, in nixos 26.05

💖 luastatus-mem-usage-linux(7) 💖

Hey bestie, welcome to this little page from the Miscellaneous Information Manual, section 7. It’s giving “Linux-specific memory usage plugin for luastatus” energy, and we’re gonna get into it. 🫶✨

🌸 Name 🌸

luastatus-mem-usage-linux — a Linux-specific memory usage plugin for luastatus. Periodt. 💅

✨ Overview ✨

Okay so this is a derived plugin: it periodically polls Linux procfs for memory usage. Lowkey iconic, highkey useful. 🦋

🎀 Functions 🎀

  • get_usage() — returns a table with two entries, avail and total. Both are tables that have value (a number) and unit (a string) entries; you can assume unit is always "kB". No cap, that’s the whole vibe. 💖
  • widget(tbl) — constructs a widget table required by luastatus. tbl is a table with these fields:
    • (required) 🔥
      • cb: function — the callback that will be called with the table same as that returned by get_usage(). So it’s basically getting the same little table get_usage() hands you. 🎀
    • (optional) 🌈
      • timer_opts: table — options for the underlying timer plugin.
      • event — the event entry of the resulting table (see luastatus documentation for the description of widget.event field). Iykyk. 👑

LGPLv3 — legal slay, bestie. 🧚💜

Signed off from the Miscellaneous Information Manual, section 7 — luastatus-mem-usage-linux(7). No date stamped on this one, just pure LGPLv3 energy at the end. 🫶💅

📦 where this page comes from