blankie
/
Waybar
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Waybar/man/waybar-idle-inhibitor.5.scd

123 lines
2.8 KiB
Plaintext
Raw Normal View History

Fixes to man pages
2019-08-27 09:40:19 +00:00
waybar-idle-inhibitor(5)
Add waybar-idle-inhibitor(5)
2019-08-26 14:06:20 +00:00
# NAME
waybar - idle_inhibitor module
# DESCRIPTION
docs: fix typos and improve language coherence
2023-10-21 15:45:25 +00:00
The *idle_inhibitor* module can inhibit the idle behavior such as screen blanking, locking, and
screensaver, also known as "presentation mode".
Add waybar-idle-inhibitor(5)
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.
Update man pages
2021-02-01 16:34:51 +00:00
*min-length*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 15:33:02 +00:00
typeof: integer ++
docs: fix typos and improve language coherence
2023-10-21 15:45:25 +00:00
The minimum length in characters the module should accept.
Update man pages
2021-02-01 16:34:51 +00:00
*align*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 15:33:02 +00:00
typeof: float ++
Add documentation for justify option
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.
Update man pages
2021-02-01 16:34:51 +00:00
Add waybar-idle-inhibitor(5)
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
Update waybar-idle-inhibitor.5.scd
2019-12-29 04:21:25 +00:00
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
Add waybar-idle-inhibitor(5)
2019-08-26 14:06:20 +00:00
*on-click-right*: ++
typeof: string ++
docs: fix typos and improve language coherence
2023-10-21 15:45:25 +00:00
Command to execute when you right-click on the module.
Add waybar-idle-inhibitor(5)
2019-08-26 14:06:20 +00:00
feat: update man
2020-04-12 16:35:41 +00:00
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
Add waybar-idle-inhibitor(5)
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.
Add config value for inhibitor default state.
2022-10-14 01:47:57 +00:00
*start-activated*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 15:33:02 +00:00
typeof: bool ++
default: *false* ++
Whether the inhibit should be activated when starting waybar.
Add config value for inhibitor default state.
2022-10-14 01:47:57 +00:00
Add a config to set a timeout for the idle_inhibitor module
2022-04-10 13:17:52 +00:00
*timeout*: ++
typeof: double ++
docs: fix typos and improve language coherence
2023-10-21 15:45:25 +00:00
The number of minutes the inhibition should last.
Add a config to set a timeout for the idle_inhibitor module
2022-04-10 13:17:52 +00:00
Add waybar-idle-inhibitor(5)
2019-08-26 14:06:20 +00:00
*tooltip*: ++
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
feat(idle-inhibitor): add tooltip format
2022-09-03 11:21:32 +00:00
*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.
📝 add menu config informations in manpages
2024-05-28 18:42:12 +00:00
*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.
Add waybar-idle-inhibitor(5)
2019-08-26 14:06:20 +00:00
# FORMAT REPLACEMENTS
*{status}*: status (*activated* or *deactivated*)
*{icon}*: Icon, as defined in *format-icons*
Consistent header names
2019-08-26 21:28:24 +00:00
# EXAMPLES
Add waybar-idle-inhibitor(5)
2019-08-26 14:06:20 +00:00
```
"idle_inhibitor": {
"format": "{icon}",
"format-icons": {
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 15:33:02 +00:00
"activated": "",
"deactivated": ""
Add a config to set a timeout for the idle_inhibitor module
2022-04-10 13:17:52 +00:00
},
"timeout": 30.5
Add waybar-idle-inhibitor(5)
2019-08-26 14:06:20 +00:00
}
```