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 inhibiting the idle behavior such as
10       screen blanking, locking, and screensaving, also known as "presentation
11       mode".
12

CONFIGURATION

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

FORMAT REPLACEMENTS

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

EXAMPLES

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