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>
136 lines
3.3 KiB
Scdoc
136 lines
3.3 KiB
Scdoc
waybar-pulseaudio-slider(5)
|
|
|
|
# NAME
|
|
|
|
waybar - pulseaudio slider module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *pulseaudio slider* module displays and controls the current volume of the default sink or source as a bar.
|
|
|
|
The volume can be controlled by dragging the slider across the bar or clicking on a specific position.
|
|
|
|
# CONFIGURATION
|
|
|
|
*min*: ++
|
|
typeof: int ++
|
|
default: 0 ++
|
|
The minimum volume value the slider should display and set.
|
|
|
|
*max*: ++
|
|
typeof: int ++
|
|
default: 100 ++
|
|
The maximum volume value the slider should display and set.
|
|
|
|
*target*: ++
|
|
typeof: string ++
|
|
default: sink ++
|
|
Whether the slider will control the default audio source or default audio sink. ++
|
|
Valid values are either "sink" or "source".
|
|
|
|
*orientation*: ++
|
|
typeof: string ++
|
|
default: horizontal ++
|
|
The orientation of the slider. Can be either `horizontal` or `vertical`.
|
|
|
|
*expand*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Enables this module to consume all left over space dynamically.
|
|
|
|
*zero-on-mute*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
`true` = The slider will be set to `min` when the source/sink is muted. ++
|
|
`false` = The slider will continue to show the unmuted volume level when the source/sink is muted.
|
|
|
|
*unmute-on-volume-change*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Specifies whether to unmute a muted souce/sink when its volume is changed by the user moving the slider.
|
|
|
|
*target*: ++
|
|
typeof: string ++
|
|
default: sink ++
|
|
The audio target to control. Can be either `sink` (output/speakers) or `source` (input/microphone).
|
|
|
|
*ignored-sinks*: ++
|
|
typeof: array ++
|
|
default: empty ++
|
|
A list of sink descriptions to ignore when tracking the default sink, so switching to those sinks does not update the slider.
|
|
|
|
*sink-mapping*: ++
|
|
typeof: object ++
|
|
Sinks named by the values of this mapping will be considered to be the current sink instead of the sinks named by the respective keys.
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"modules-right": [
|
|
"pulseaudio/slider#out",
|
|
"pulseaudio/slider#in",
|
|
],
|
|
"pulseaudio/slider#out": {
|
|
"min": 0,
|
|
"max": 100,
|
|
"orientation": "horizontal",
|
|
"zero-on-mute": false,
|
|
"unmute-on-volume-change": false
|
|
},
|
|
"pulseaudio/slider#in": {
|
|
"min": 0,
|
|
"max": 100,
|
|
"orientation": "horizontal",
|
|
"target": "source"
|
|
}
|
|
```
|
|
|
|
# STYLE
|
|
|
|
The slider is a component with multiple CSS Nodes, of which the following are exposed:
|
|
|
|
*#pulseaudio-slider*: ++
|
|
Controls the style of the box *around* the slider and bar.
|
|
|
|
*#pulseaudio-slider.muted*: ++
|
|
Controls the style when the audio source/sink is muted.
|
|
|
|
*#pulseaudio-slider slider*: ++
|
|
Controls the style of the slider handle.
|
|
|
|
*#pulseaudio-slider trough*: ++
|
|
Controls the style of the part of the bar that has not been filled.
|
|
|
|
*#pulseaudio-slider highlight*: ++
|
|
Controls the style of the part of the bar that has been filled.
|
|
|
|
## STYLE EXAMPLE
|
|
|
|
```
|
|
#pulseaudio-slider slider {
|
|
min-height: 0px;
|
|
min-width: 0px;
|
|
opacity: 0;
|
|
background-image: none;
|
|
border: none;
|
|
box-shadow: none;
|
|
}
|
|
|
|
#pulseaudio-slider trough {
|
|
min-height: 80px;
|
|
min-width: 10px;
|
|
border-radius: 5px;
|
|
background: black;
|
|
}
|
|
|
|
#pulseaudio-slider highlight {
|
|
min-width: 10px;
|
|
border-radius: 5px;
|
|
background: green;
|
|
}
|
|
|
|
#pulseaudio-slider.muted highlight {
|
|
background-color: orange;
|
|
}
|
|
```
|