AlexandClaude Opus 4.8
72fdf77c19
A full man<->code consistency audit surfaced options, format placeholders
and CSS classes that were implemented but undocumented, documented but not
implemented (some causing fmt crashes when copied from examples), and
defaults that disagreed with the code. This aligns the docs with the code
and fixes a few genuine code gaps.
Docs:
- Add the missing waybar-user(5) man page (and register it in meson.build)
- Document previously-undocumented options/placeholders/CSS across many
modules (custom image-path/image-name/icon-size, graph_type/width/
datapoints; battery smooth-power; wireplumber format-source/only-physical;
mpris {position}/prefer-album-artist; network {signalStrengthApp}/compact
bandwidth; pulseaudio {source_volume}/{source_desc}; upower {temperature}/
{model}/{native-path}; wwan {power_state}/{imei}; tray ignore-list; and
many CSS state classes: .sink-muted, .source-muted, .workspace-hover, etc.)
- Correct documented defaults to match the code (hyprland format {name},
gamemode {count}, cpu-graph interval 5, cava input_delay 4, niri taskbar
icon-size 16, disk/gps/wayfire formats, menu-actions object type, ...)
- Remove placeholders/options that do not apply (custom-graph {icon}/format/
format-icons/rotate) and fix crashing examples (wwan {mode}, gps
format-no-fix); note cava background/foreground/continuous_rendering are
cava-config-file options
Code:
- bluetooth: accept the documented `controller` key as a synonym of
`controller-alias` (the option was silently ignored)
- mango/workspaces: supply the documented `{name}` fmt arg (was missing ->
fmt::format threw)
- privacy: read `tooltip` as a bool (was guarded on isString(), so the
documented `tooltip: false` was silently ignored)
All man pages validated with scdoc 1.11.4. Not compiled locally (no gtkmm);
C++ build relies on CI.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
182 lines
4.5 KiB
Scdoc
182 lines
4.5 KiB
Scdoc
waybar-disk(5)
|
|
|
|
# NAME
|
|
|
|
waybar - disk module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *disk* module displays information of multiple disks.
|
|
|
|
# CONFIGURATION
|
|
|
|
Addressed by *disk*
|
|
|
|
*interval*: ++
|
|
typeof: integer++
|
|
default: 30 ++
|
|
The interval in which the information gets polled.
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: "{}%" ++
|
|
The format, how information for each disk should be displayed. Note: in the default the positional field "{}" resolves to *{percentage_free}*.
|
|
|
|
*rotate*: ++
|
|
typeof: integer ++
|
|
Positive value to rotate the text label (in 90 degree increments).
|
|
|
|
*states*: ++
|
|
typeof: object ++
|
|
A number of disk utilization states that get activated on certain percentage thresholds (percentage_used). See *waybar-states(5)*.
|
|
|
|
*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.
|
|
|
|
*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.
|
|
|
|
*path*: ++
|
|
typeof: string ++
|
|
default: "/" ++
|
|
Deprecated path of filesystem or mountpoint to monitor.
|
|
|
|
*paths*: ++
|
|
typeof: array ++
|
|
default: ["/"] ++
|
|
Array of paths residing in the filesystem or mountpoint for which the information should be displayed.
|
|
|
|
*header*: ++
|
|
typeof: string ++
|
|
default: "" ++
|
|
Text to appear before the disk information defined in the format.
|
|
|
|
*separator*: ++
|
|
typeof: string ++
|
|
default: " " ++
|
|
Separator string between multiple disk information.
|
|
|
|
*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} used out of {total} on {path} ({percentage_used}%)" ++
|
|
The format of the information displayed in the tooltip.
|
|
|
|
*unit*: ++
|
|
typeof: string ++
|
|
Use with specific_free, specific_used, and specific_total to force calculation to always be in a certain unit. Accepts kB, kiB, MB, Mib, GB, GiB, TB, TiB.
|
|
|
|
*menu*: ++
|
|
typeof: string ++
|
|
Action that popups the menu.
|
|
|
|
*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.
|
|
|
|
*expand*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Enables this module to consume all left over space dynamically.
|
|
|
|
# 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. Automatically selects unit based on size remaining.
|
|
|
|
*{used}*: Amount of used disk space. Automatically selects unit based on size remaining.
|
|
|
|
*{free}*: Amount of available disk space for normal users. Automatically selects unit based on size remaining.
|
|
|
|
*{path}*: The path for each disk specified in the configuration.
|
|
|
|
*{specific_total}*: Total amount of space on the disk, partition, or mountpoint in a specific unit. Defaults to bytes.
|
|
|
|
*{specific_used}*: Amount of used disk space in a specific unit. Defaults to bytes.
|
|
|
|
*{specific_free}*: Amount of available disk space for normal users in a specific unit. Defaults to bytes.
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"disk": {
|
|
"interval": 30,
|
|
"format": "{percentage_free}% free on {path}",
|
|
}
|
|
```
|
|
|
|
```
|
|
"disk": {
|
|
"interval": 30,
|
|
"format": "{percentage_free}% free on {path}",
|
|
"header": "Disks: ",
|
|
"paths": ["/", "/home"],
|
|
"separator": " ",
|
|
}
|
|
```
|
|
|
|
```
|
|
"disk": {
|
|
"interval": 30,
|
|
"paths": ["/"],
|
|
"format": "{specific_free:0.2f} GB out of {specific_total:0.2f} GB available. Alternatively {free} out of {total} available",
|
|
"unit": "GB"
|
|
}
|
|
|
|
// 1434.25 GB out of 2000.00 GB available. Alternatively 1.4TiB out of 1.9TiB available.
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#disk*
|