Waybar/man/waybar-idle-inhibitor.5.scd

123 lines
2.8 KiB
Plaintext
Raw Normal View History

2019-08-27 09:40:19 +00:00
waybar-idle-inhibitor(5)
2019-08-26 14:06:20 +00:00
# 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".
2019-08-26 14:06:20 +00:00
# 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.
2021-02-01 16:34:51 +00:00
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should accept.
2021-02-01 16:34:51 +00:00
*align*: ++
typeof: float ++
2024-03-04 19:00:57 +00:00
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.
2021-02-01 16:34:51 +00:00
2019-08-26 14:06:20 +00:00
*on-click*: ++
typeof: string ++
Command to execute when clicked on the module. A click also toggles the state
2019-12-29 04:21:25 +00:00
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2019-08-26 14:06:20 +00:00
*on-click-right*: ++
typeof: string ++
Command to execute when you right-click on the module.
2019-08-26 14:06:20 +00:00
2020-04-12 16:35:41 +00:00
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
2019-08-26 14:06:20 +00:00
*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.
2019-08-26 14:06:20 +00:00
*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.
*menu*: ++
typeof: string ++
Action that popups the menu. Cannot be "on-click".
*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.
2019-08-26 14:06:20 +00:00
# FORMAT REPLACEMENTS
*{status}*: status (*activated* or *deactivated*)
*{icon}*: Icon, as defined in *format-icons*
2019-08-26 21:28:24 +00:00
# EXAMPLES
2019-08-26 14:06:20 +00:00
```
"idle_inhibitor": {
"format": "{icon}",
"format-icons": {
"activated": "",
"deactivated": ""
},
"timeout": 30.5
2019-08-26 14:06:20 +00:00
}
```