Add some documentation for disks

pull/471/head
Guillaume Maudoux 2019-09-25 09:07:46 +02:00
parent 1d39ef5c8e
commit 247589efbb
2 changed files with 94 additions and 0 deletions

View File

@ -0,0 +1,93 @@
waybar-disk(5)
# NAME
waybar - disk module
# DESCRIPTION
The *disk* module displays the current disk space used.
# CONFIGURATION
Addressed by *disk*
*path*: ++
typeof: string ++
default: "/" ++
Any path residing in the filesystem or mountpoint for which the information should be displayed.
*interval*: ++
typeof: integer++
default: 30 ++
The interval in which the information gets polled.
*format*: ++
typeof: string ++
default: "{percentage_used}%" ++
The format, how information should be displayed.
*rotate*: ++
typeof: integer ++
Positive value to rotate the text label.
*max-length*: ++
typeof: integer ++
The maximum length in character the module should display.
*on-click*: ++
typeof: string ++
Command to execute when clicked on the module.
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
*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.
*tooltip*: ++
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
*tooltip-format*: ++
typeof: string ++
default: "{used} out of {total} used ({percentage_used}%)" ++
The format of the information displayed in the tooltip.
# FORMAT REPLACEMENTS
*{percentage_used}*: Percentage of disk in use.
*{percentage_free}*: Percentage of free disk space
*{total}*: Total amount of space on the disk, partition or mountpoint.
*{used}*: Amount of used disk space.
*{free}*: Amount of available disk space for normal users.
*{path}*: The path specified in the configuration.
# EXAMPLES
```
"disk": {
"interval": 30,
"format": "{percentage_free}% free on {path}",
}
```
# STYLE
- *#disk*

View File

@ -184,6 +184,7 @@ if scdoc.found()
'waybar-clock.5.scd',
'waybar-cpu.5.scd',
'waybar-custom.5.scd',
'waybar-disk.5.scd',
'waybar-idle-inhibitor.5.scd',
'waybar-memory.5.scd',
'waybar-mpd.5.scd',