110 lines
2.5 KiB
Markdown
110 lines
2.5 KiB
Markdown
waybar-idle-inhibitor(5)
|
|
|
|
# NAME
|
|
|
|
waybar - idle_inhibitor module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *idle_inhibitor* module can inhibit the idle behavior such as screen blanking, locking, and
|
|
screensaver, also known as "presentation mode".
|
|
|
|
# CONFIGURATION
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
The format, how the state should be displayed.
|
|
|
|
*format-icons*: ++
|
|
typeof: array ++
|
|
Based on the current state, the corresponding icon gets selected.
|
|
|
|
*rotate*: ++
|
|
typeof: integer ++
|
|
Positive value to rotate the text label.
|
|
|
|
*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. If the module is rotated, it will follow the flow of the text.
|
|
|
|
*justify*: ++
|
|
typeof: string ++
|
|
The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.
|
|
|
|
*on-click*: ++
|
|
typeof: string ++
|
|
Command to execute when clicked on the module. A click also toggles the state
|
|
|
|
*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.
|
|
|
|
*start-activated*: ++
|
|
typeof: bool ++
|
|
default: *false* ++
|
|
Whether the inhibit should be activated when starting waybar.
|
|
|
|
*timeout*: ++
|
|
typeof: double ++
|
|
The number of minutes the inhibition should last.
|
|
|
|
*tooltip*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*tooltip-format-activated*: ++
|
|
typeof: string ++
|
|
This format is used when the inhibit is activated.
|
|
|
|
*tooltip-format-deactivated*: ++
|
|
typeof: string ++
|
|
This format is used when the inhibit is deactivated.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{status}*: status (*activated* or *deactivated*)
|
|
|
|
*{icon}*: Icon, as defined in *format-icons*
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"idle_inhibitor": {
|
|
"format": "{icon}",
|
|
"format-icons": {
|
|
"activated": "",
|
|
"deactivated": ""
|
|
},
|
|
"timeout": 30.5
|
|
}
|
|
```
|