1waybar-inhibitor(5)           File Formats Manual          waybar-inhibitor(5)
2
3
4

NAME

6       waybar - inhibitor module
7

DESCRIPTION

9       The inhibitor module allows one to take an inhibitor lock that logind
10       provides. See systemd-inhibit(1) for more information.
11

CONFIGURATION

13       what:
14            typeof: string or array
15            The inhibitor lock or locks that should be taken when active. The
16       available inhibitor locks are idle, shutdown, sleep, handle-power-key,
17       handle-suspend-key, handle-hibernate-key and handle-lid-switch.
18
19       format:
20            typeof: string
21            The format, how the state should be displayed.
22
23       format-icons:
24            typeof: array
25            Based on the current state, the corresponding icon gets selected.
26
27       rotate:
28            typeof: integer
29            Positive value to rotate the text label.
30
31       max-length:
32            typeof: integer
33            The maximum length in character the module should display.
34
35       min-length:
36            typeof: integer
37            The minimum length in characters the module should take up.
38
39       align:
40            typeof: float
41            The alignment of the text, where 0 is left-aligned and 1 is right-
42       aligned. If the module is rotated, it will follow the flow of the text.
43
44       on-click:
45            typeof: string
46            Command to execute when clicked on the module. A click also tog‐
47       gles the state
48
49       on-click-middle:
50            typeof: string
51            Command to execute when middle-clicked on the module using mouse‐
52       wheel.
53
54       on-click-right:
55            typeof: string
56            Command to execute when you right clicked on the module.
57
58       on-update:
59            typeof: string
60            Command to execute when the module is updated.
61
62       on-scroll-up:
63            typeof: string
64            Command to execute when scrolling up on the module.
65
66       on-scroll-down:
67            typeof: string
68            Command to execute when scrolling down on the module.
69
70       smooth-scrolling-threshold:
71            typeof: double
72            Threshold to be used when scrolling.
73
74       tooltip:
75            typeof: bool
76            default: true
77            Option to disable tooltip on hover.
78

FORMAT REPLACEMENTS

80       {status}: status (activated or deactivated)
81
82       {icon}: Icon, as defined in format-icons
83

EXAMPLES

85           "inhibitor": {
86                "what": "handle-lid-switch",
87                "format": "{icon}",
88                "format-icons": {
89                     "activated": "",
90                     "deactivated": ""
91                }
92           }
93
94
95
96                                  2023-08-16               waybar-inhibitor(5)