AlexandClaude Opus 4.8
a3b39cfcf6
Port information that previously lived only in the GitHub wiki into the authoritative scdoc man pages, so the man pages become the single source of truth for module documentation. 33 man pages enriched (options, format replacements, actions, style selectors, troubleshooting and implementation notes). Additions were verified against the source; stale/incorrect wiki entries were deliberately not ported. All pages still compile with scdoc. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
131 lines
2.4 KiB
Scdoc
131 lines
2.4 KiB
Scdoc
waybar-privacy(5)
|
|
|
|
# NAME
|
|
|
|
waybar - privacy module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *privacy* module displays if any application is capturing audio, sharing ++
|
|
the screen or playing audio.
|
|
|
|
# CONFIGURATION
|
|
|
|
*icon-spacing*: ++
|
|
typeof: integer ++
|
|
default: 4 ++
|
|
The spacing between each privacy icon.
|
|
|
|
*icon-size*: ++
|
|
typeof: integer ++
|
|
default: 20 ++
|
|
The size of each privacy icon. Set to *0* for auto size.
|
|
|
|
*transition-duration*: ++
|
|
typeof: integer ++
|
|
default: 250 ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*modules* ++
|
|
typeof: array of objects ++
|
|
default: [{"type": "screenshare"}, {"type": "audio-in"}, {"type": "location"}] ++
|
|
Which privacy modules to monitor. See *MODULES CONFIGURATION* for++
|
|
more information.
|
|
|
|
*expand*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Enables this module to consume all left over space dynamically.
|
|
|
|
*ignore-monitor* ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Ignore streams with *stream.monitor* property.
|
|
|
|
*ignore* ++
|
|
typeof: array of objects ++
|
|
default: [] ++
|
|
Additional streams to be ignored. See *IGNORE CONFIGURATION* for++
|
|
more information.
|
|
|
|
# MODULES CONFIGURATION
|
|
|
|
*type*: ++
|
|
typeof: string ++
|
|
values: "screenshare", "audio-in", "audio-out", "location" ++
|
|
Specifies which module to use and configure.
|
|
|
|
*icon-name*: ++
|
|
typeof: string ++
|
|
If set, changes the modules icon. Accepts any valid GTK icon name. ++
|
|
Note: the icon is only visible when the resource is actively in use; the item is hidden when idle.
|
|
|
|
*tooltip*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*tooltip-icon-size*: ++
|
|
typeof: integer ++
|
|
default: 24 ++
|
|
The size of each icon in the tooltip.
|
|
|
|
# IGNORE CONFIGURATION
|
|
|
|
*type*: ++
|
|
typeof: string
|
|
|
|
*name*: ++
|
|
typeof: string
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"privacy": {
|
|
"icon-spacing": 4,
|
|
"icon-size": 18,
|
|
"transition-duration": 250,
|
|
"modules": [
|
|
{
|
|
"type": "screenshare",
|
|
"tooltip": true,
|
|
"tooltip-icon-size": 24
|
|
},
|
|
{
|
|
"type": "audio-out",
|
|
"tooltip": true,
|
|
"tooltip-icon-size": 24
|
|
},
|
|
{
|
|
"type": "audio-in",
|
|
"tooltip": true,
|
|
"tooltip-icon-size": 24
|
|
},
|
|
{
|
|
"type": "location",
|
|
"icon-name": "location-services-active-symbolic"
|
|
}
|
|
],
|
|
"ignore-monitor": true,
|
|
"ignore": [
|
|
{
|
|
"type": "audio-in",
|
|
"name": "cava"
|
|
},
|
|
{
|
|
"type": "screenshare",
|
|
"name": "obs"
|
|
}
|
|
]
|
|
},
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#privacy*
|
|
- *#privacy-item*
|
|
- *#privacy-item.screenshare*
|
|
- *#privacy-item.audio-in*
|
|
- *#privacy-item.audio-out*
|
|
- *#privacy-item.location*
|