luastatu...-inotify(7)

🌸 Name

luastatus-plugin-inotify — the inotify plugin for luastatus, bestie. This page is luastatu...-inotify(7), and it lives in the Miscellaneous Information Manual section. 🦋

✨ Overview

This plugin monitors inotify events. That’s the whole vibe check: inotify events, monitored by this plugin. 👑

🎀 Options

• watch: table — a table where the keys are the paths to watch and the values are tables with event names, e.g. {["/home/user"] = {"create", "delete", "move"}} (peep the Events and flag names section). 💅
• greet: boolean — whether or not to call cb with what="hello" as soon as the widget starts. Defaults to false.
• timeout: number — if specified and not negative, this plugin calls cb with what="timeout" if no event has occurred in timeout seconds.

🦋 cb argument

A table with a what entry, okay? 💖

• If what is "hello", the function is being called for the first time (and the greet option was set to true).
• If what is "timeout", the function has not been called for the number of seconds specified as the timeout option.
• If what is "event", an inotify event has been read; in this case, the table has these additional entries:
  • wd: integer — watch descriptor (see the Functions section) of the event.
  • mask: table — for each event name or event flag (see the Events and flag names section), this table contains an entry with key equal to its name and true as the value.
  • cookie: number — unique cookie associating related events (or, if there are no associated related events, a zero).
  • name: string (optional) — present only when an event is returned for a file inside a watched directory; identifies the filename within the watched directory.

💅 Functions

Each file being watched is assigned a watch descriptor, which is a non-negative integer. Slay. ✨

• wds = luastatus.plugin.get_initial_wds() — returns a table that maps initial paths to their watch descriptors.
• wd = luastatus.plugin.add_watch(path, events) — add a new file to watch. Returns a watch descriptor on success, or nil on failure.
• is_ok = luastatus.plugin.remove_watch(wd) — removes a watch by its watch descriptor. Returns true on success, or false on failure.
• luastatus.plugin.push_timeout(seconds) — changes the timeout for one iteration.

🔥 Events and flag names

Each IN_* constant defined in <sys/inotify.h> corresponds to a string obtained from its name by dropping the initial IN_ and making the rest lower-case, e.g. IN_CLOSE_WRITE corresponds to "close_write".

See inotify(7) for details.

👑 Copyright

LGPLv3

---

Bye bestie 💜 the footer in this copy only says luastatu...-inotify(7); no separate source, version, or date line was in the original, so that’s the whole footer vibe. 🎀