LUASTATUS-BARLIB-STDOUT(7)

📦
version 0.6.0 · 2 versions
, in nixos 26.05

✨ NAME ✨

hii bestie 💖 this is luastatus-barlib-stdout(7) — the stdout barlib for luastatus — and it lives in the Miscellaneous Information Manual. It's giving simple output, no drama and honestly? slay.

🌈 OVERVIEW 🌈

This barlib simply writes lines to a file descriptor. Bestie, that's the whole bit. 🎀

It can be used for status bars such as dzen/dzen2, xmobar, yabar, dvtm, and others. Iconic lineup, no cap. 👑

It joins all non-empty strings returned by widgets by a separator, which defaults to " | ". The separator is lowkey the main character energy of the spacing situation. ✨

It does not provide functions and does not support events. Nope, not those vibes. 🙈

🦋 REDIRECTIONS AND luastatus-stdout-wrapper 🦋

Since we need to write to stdout, it is very easy to mess things up: Lua's print() prints to stdout, processes spawned by widgets/plugins inherit our stdin and stdout, etc. It's giving chaos potential fr fr, iykyk. 😭

That's why this barlib requires that the stdout file descriptor is manually redirected. A shell wrapper, luastatus-stdout-wrapper, is shipped with it; it does all the redirections needed and executes luastatus with -b stdout and additional arguments passed by you. The wrapper literally ate the redirection task and is the responsible friend here. 🫶

bestie, do not skip the redirection situation — the barlib requires that the stdout file descriptor is manually redirected, and the wrapper is shipped to do all the redirections needed for you. 💅

💅 CB RETURN VALUE 💅

Either of:

  • a string — an empty string hides the widget.
  • an array of strings — equivalent to returning a string with all non-empty elements of the array joined by the separator.
  • nil — hides the widget.

No surprises, just three return-value moods. 💖

🌸 OPTIONS 🌸

The following options are supported:

  • out_fd=<fd> — file descriptor to write to. Usually set by the wrapper.
  • separator=<string> — set the separator.
  • error=<string> — set the content of an "error" segment. Defaults to "(Error)".

LGPLv3 — periodt. 💜

okay byeee 👋 that's the page! the footer source/version and date info lives at the very end in the original manpage metadata, and this luastatus-barlib-stdout(7) sign-off is sending you off with all the cute metadata energy 💖✨

📦 where this page comes from