waybar-inhibitor(5)

πŸ’– waybar-inhibitor(5) β€” the inhibitor module, bestie edition πŸ’–

okay so this is a page from the File Formats Manual for waybar-inhibitor(5), aka the waybar inhibitor module, and I'm gonna walk you through literally everything in it. no skips, no cuts, we're doing the whole thing. ✨


🌸 NAME 🌸

waybar β€” inhibitor module. that's it, that's the name, she's simple and she knows it πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

the inhibitor module lets you take an inhibitor lock β€” the kind that logind hands out. that's the vibe. it's giving "please don't sleep, I'm busy."

want the actual lore? go read systemd-inhibit(1), it explains the whole thing. πŸ“–


πŸ‘‘ CONFIGURATION πŸ‘‘

this is the main character section, buckle up πŸŽ€

  • what β€” typeof: string or array. the inhibitor lock (or locks, plural, she's flexible) that should be taken when the module is active. your options are: idle, shutdown, sleep, handle-power-key, handle-suspend-key, handle-hibernate-key, and handle-lid-switch. pick your fighter(s) πŸ’œ
  • format β€” typeof: string. the format, aka how the state should be displayed.
  • format-icons β€” typeof: array. based on the current state, the corresponding icon gets selected. cute lil icon switcheroo.
  • rotate β€” typeof: integer. a positive value rotates the text label, in 90 degree increments. spin her around πŸŒ€
  • max-length β€” typeof: integer. the maximum length in character the module should display.
  • min-length β€” typeof: integer. the minimum length in characters the module should accept.
  • align β€” typeof: float. the alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned. and listen β€” if the module is rotated, it follows the flow of the text. she adapts, she's versatile 🫢
  • justify β€” typeof: string. the alignment of the text within the module's label, letting the options 'left', 'right', or 'center' define the positioning.
  • on-click β€” typeof: string. command to execute when clicked on the module. oh and heads up β€” a click also toggles the state. two things at once, multitasking queen πŸ‘‘
  • on-click-middle β€” typeof: string. command to execute when middle-clicked on the module using mousewheel.
  • on-click-right β€” typeof: string. command to execute when you right-click on the module.
  • on-update β€” typeof: string. command to execute when the module is updated.
  • on-scroll-up β€” typeof: string. command to execute when scrolling up on the module.
  • on-scroll-down β€” typeof: string. command to execute when scrolling down on the module.
  • smooth-scrolling-threshold β€” typeof: double. threshold to be used when scrolling.
  • tooltip β€” typeof: bool, default: true. option to disable tooltip on hover.
  • menu β€” typeof: string. action that popups the menu. ⚠️ cannot be "on-click" β€” that's a hard no, don't even try it.
  • menu-file β€” typeof: string. location of the menu descriptor file. there need to be an element of type
GtkMenu with id menu
  • menu-actions β€” typeof: array. the actions corresponding to the buttons of the menu.
  • expand β€” typeof: bool, default: false. enables this module to consume all left over space dynamically. she's hungry, she wants the whole row 🌈

✨ FORMAT REPLACEMENTS ✨

the little placeholders you can drop into your format, they're iconic:

  • {status}: status (activated or deactivated)
  • {icon}: Icon, as defined in format-icons

πŸ“ EXAMPLES πŸ“

here's the whole thing in action, look at her go:

"inhibitor": {
     "what": "handle-lid-switch",
     "format": "{icon}",
     "format-icons": {
          "activated": "",
          "deactivated": ""
     }
}

bestie reminder: everything above is exactly as written in the original β€” flags, types, defaults, all of it. nothing invented, nothing dropped. iykyk πŸ’€

okay that's the whole page !! this came from waybar-inhibitor(5), dated 2026-02-08 β€” shoutout to that date, and to waybar-inhibitor(5) herself. go forth and inhibit things responsibly, mwah πŸ’–πŸŽ€πŸ¦‹βœ¨

πŸ“¦ where this page comes from