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

NAME

6       waybar - idle_inhibitor module
7

DESCRIPTION

9       The idle_inhibitor module can inhibit the idle behavior such as screen
10       blanking, locking, and screensaver, also known as "presentation mode".
11

CONFIGURATION

13       format:
14            typeof: string
15            The format, how the state should be displayed.
16
17       format-icons:
18            typeof: array
19            Based on the current state, the corresponding icon gets selected.
20
21       rotate:
22            typeof: integer
23            Positive value to rotate the text label.
24
25       max-length:
26            typeof: integer
27            The maximum length in character the module should display.
28
29       min-length:
30            typeof: integer
31            The minimum length in characters the module should accept.
32
33       align:
34            typeof: float
35            The alignment of the text, where 0 is left-aligned and 1 is right-
36       aligned. If the module is rotated, it will follow the flow of the text.
37
38       on-click:
39            typeof: string
40            Command to execute when clicked on the module. A click also tog‐
41       gles the state
42
43       on-click-middle:
44            typeof: string
45            Command to execute when middle-clicked on the module using mouse‐
46       wheel.
47
48       on-click-right:
49            typeof: string
50            Command to execute when you right-click on the module.
51
52       on-update:
53            typeof: string
54            Command to execute when the module is updated.
55
56       on-scroll-up:
57            typeof: string
58            Command to execute when scrolling up on the module.
59
60       on-scroll-down:
61            typeof: string
62            Command to execute when scrolling down on the module.
63
64       smooth-scrolling-threshold:
65            typeof: double
66            Threshold to be used when scrolling.
67
68       start-activated:
69            typeof: bool
70            default: false
71            Whether the inhibit should be activated when starting waybar.
72
73       timeout:
74            typeof: double
75            The number of minutes the inhibition should last.
76
77       tooltip:
78            typeof: bool
79            default: true
80            Option to disable tooltip on hover.
81
82       tooltip-format-activated:
83            typeof: string
84            This format is used when the inhibit is activated.
85
86       tooltip-format-deactivated:
87            typeof: string
88            This format is used when the inhibit is deactivated.
89

FORMAT REPLACEMENTS

91       {status}: status (activated or deactivated)
92
93       {icon}: Icon, as defined in format-icons
94

EXAMPLES

96           "idle_inhibitor": {
97                "format": "{icon}",
98                "format-icons": {
99                     "activated": "",
100                     "deactivated": ""
101                },
102                "timeout": 30.5
103           }
104
105
106
107                                  2023-11-05          waybar-idle-inhibitor(5)