docs(man): document options implemented but missing from man pages
Sync man pages with the code for options that were read but undocumented: - sway/workspaces: ignore-workspaces - niri/workspaces: sort-by-number, hide-empty - wayfire/workspaces: disable-scroll, enable-bar-scroll - river/tags: set-tags, toggle-tags - hyprland/workspaces: persistent-workspaces (formalized) - hyprland/window: fallback, tooltip-format - cpu: format-<state>, tooltip-format, tooltip-format-<state> - pulseaudio/slider: ignored-sinks - hyprland/niri/mango language: format-<lang>-<variant> (+ hyprland tooltip variant)
This commit is contained in:
@@ -83,6 +83,18 @@ The *cpu* module displays the current CPU utilization.
|
|||||||
default: true ++
|
default: true ++
|
||||||
Option to disable tooltip on hover.
|
Option to disable tooltip on hover.
|
||||||
|
|
||||||
|
*tooltip-format*: ++
|
||||||
|
typeof: string ++
|
||||||
|
The format of the tooltip shown on hover. Supports the same replacements as *format*.
|
||||||
|
|
||||||
|
*format-<state>*: ++
|
||||||
|
typeof: string ++
|
||||||
|
The format to use when the given *state* (see *states*) is active. Supports the same replacements as *format*.
|
||||||
|
|
||||||
|
*tooltip-format-<state>*: ++
|
||||||
|
typeof: string ++
|
||||||
|
The tooltip format to use when the given *state* (see *states*) is active. Takes precedence over *tooltip-format*.
|
||||||
|
|
||||||
*expand*: ++
|
*expand*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
default: false ++
|
default: false ++
|
||||||
|
|||||||
@@ -21,6 +21,10 @@ Addressed by *hyprland/language*
|
|||||||
typeof: string++
|
typeof: string++
|
||||||
Provide an alternative name to display per language where <lang> is the language of your choosing. Can be passed multiple times with multiple languages as shown by the example below.
|
Provide an alternative name to display per language where <lang> is the language of your choosing. Can be passed multiple times with multiple languages as shown by the example below.
|
||||||
|
|
||||||
|
*format-<lang>-<variant>* ++
|
||||||
|
typeof: string ++
|
||||||
|
Like *format-<lang>* but also matches the layout variant, taking precedence over *format-<lang>* when both the language and variant match.
|
||||||
|
|
||||||
*keyboard-name*: ++
|
*keyboard-name*: ++
|
||||||
typeof: string ++
|
typeof: string ++
|
||||||
Specifies which keyboard to use from hyprctl devices output. Using the option that begins with "at-translated-set..." is recommended.
|
Specifies which keyboard to use from hyprctl devices output. Using the option that begins with "at-translated-set..." is recommended.
|
||||||
@@ -52,6 +56,10 @@ Addressed by *hyprland/language*
|
|||||||
typeof: string ++
|
typeof: string ++
|
||||||
Allows specifying a different tooltip format for each language. The *<lang>* should be replaced with the language code. This can be used to provide a custom tooltip for each language.
|
Allows specifying a different tooltip format for each language. The *<lang>* should be replaced with the language code. This can be used to provide a custom tooltip for each language.
|
||||||
|
|
||||||
|
*tooltip-format-<lang>-<variant>*: ++
|
||||||
|
typeof: string ++
|
||||||
|
Like *tooltip-format-<lang>* but also matches the layout variant, taking precedence over *tooltip-format-<lang>* when both the language and variant match.
|
||||||
|
|
||||||
*expand*: ++
|
*expand*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
default: false ++
|
default: false ++
|
||||||
|
|||||||
@@ -25,6 +25,15 @@ Addressed by *hyprland/window*
|
|||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
Show the active window of the monitor the bar belongs to, instead of the focused window.
|
Show the active window of the monitor the bar belongs to, instead of the focused window.
|
||||||
|
|
||||||
|
*fallback*: ++
|
||||||
|
typeof: string ++
|
||||||
|
Text to display when the focused window title is empty (for example when no window is focused).
|
||||||
|
|
||||||
|
*tooltip-format*: ++
|
||||||
|
typeof: string ++
|
||||||
|
default: {title} ++
|
||||||
|
The format of the tooltip shown on hover. Supports the same replacements as *format*. Requires *tooltip* to be enabled.
|
||||||
|
|
||||||
*icon*: ++
|
*icon*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
default: false ++
|
default: false ++
|
||||||
|
|||||||
@@ -118,6 +118,11 @@ This setting is ignored if *workspace-taskbar.enable* is set to true.
|
|||||||
default: false ++
|
default: false ++
|
||||||
If set to true, only persistent workspaces will be shown on bar.
|
If set to true, only persistent workspaces will be shown on bar.
|
||||||
|
|
||||||
|
*persistent-workspaces*: ++
|
||||||
|
typeof: object ++
|
||||||
|
default: empty ++
|
||||||
|
Lists workspaces that should always be shown, even when they do not exist. Keys are workspace names and values are arrays of output names on which the workspace should be shown (an empty array means all outputs). See the examples below.
|
||||||
|
|
||||||
*all-outputs*: ++
|
*all-outputs*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
default: false ++
|
default: false ++
|
||||||
|
|||||||
@@ -24,6 +24,10 @@ Addressed by *mango/language*
|
|||||||
The value is used as the replacement for *{}* in the main *format*.
|
The value is used as the replacement for *{}* in the main *format*.
|
||||||
This option can be repeated for multiple languages.
|
This option can be repeated for multiple languages.
|
||||||
|
|
||||||
|
*format-<lang>-<variant>*: ++
|
||||||
|
typeof: string ++
|
||||||
|
Like *format-<lang>* but also matches the layout variant, taking precedence over *format-<lang>* when both the language and variant match.
|
||||||
|
|
||||||
*menu*: ++
|
*menu*: ++
|
||||||
typeof: string ++
|
typeof: string ++
|
||||||
Action that pops up a menu.
|
Action that pops up a menu.
|
||||||
|
|||||||
@@ -21,6 +21,10 @@ Addressed by *niri/language*
|
|||||||
typeof: string++
|
typeof: string++
|
||||||
Provide an alternative name to display per language where <lang> is the language of your choosing. Can be passed multiple times with multiple languages as shown by the example below.
|
Provide an alternative name to display per language where <lang> is the language of your choosing. Can be passed multiple times with multiple languages as shown by the example below.
|
||||||
|
|
||||||
|
*format-<lang>-<variant>* ++
|
||||||
|
typeof: string ++
|
||||||
|
Like *format-<lang>* but also matches the layout variant, taking precedence over *format-<lang>* when both the language and variant match.
|
||||||
|
|
||||||
*menu*: ++
|
*menu*: ++
|
||||||
typeof: string ++
|
typeof: string ++
|
||||||
Action that popups the menu.
|
Action that popups the menu.
|
||||||
|
|||||||
@@ -32,6 +32,11 @@ Addressed by *niri/workspaces*
|
|||||||
default: false ++
|
default: false ++
|
||||||
Sort workspaces by id, taking precedence over other sort options.
|
Sort workspaces by id, taking precedence over other sort options.
|
||||||
|
|
||||||
|
*sort-by-number*: ++
|
||||||
|
typeof: bool ++
|
||||||
|
default: false ++
|
||||||
|
Deprecated alias for *sort-by-id*; prefer *sort-by-id* instead.
|
||||||
|
|
||||||
If none of the sorting options are enabled, workspaces keep their output/index order.
|
If none of the sorting options are enabled, workspaces keep their output/index order.
|
||||||
|
|
||||||
*format*: ++
|
*format*: ++
|
||||||
@@ -58,6 +63,11 @@ If none of the sorting options are enabled, workspaces keep their output/index o
|
|||||||
default: false ++
|
default: false ++
|
||||||
If set to true, only the active or focused workspace will be shown.
|
If set to true, only the active or focused workspace will be shown.
|
||||||
|
|
||||||
|
*hide-empty*: ++
|
||||||
|
typeof: bool ++
|
||||||
|
default: false ++
|
||||||
|
If set to true, empty workspaces will not be shown.
|
||||||
|
|
||||||
*on-update*: ++
|
*on-update*: ++
|
||||||
typeof: string ++
|
typeof: string ++
|
||||||
Command to execute when the module is updated.
|
Command to execute when the module is updated.
|
||||||
|
|||||||
@@ -48,6 +48,11 @@ The volume can be controlled by dragging the slider across the bar or clicking o
|
|||||||
default: sink ++
|
default: sink ++
|
||||||
The audio target to control. Can be either `sink` (output/speakers) or `source` (input/microphone).
|
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.
|
||||||
|
|
||||||
# EXAMPLES
|
# EXAMPLES
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -26,6 +26,14 @@ Addressed by *river/tags*
|
|||||||
default: false ++
|
default: false ++
|
||||||
If set to false, you can left-click to set focused tag. Right-click to toggle tag focus. If set to true this behaviour is disabled.
|
If set to false, you can left-click to set focused tag. Right-click to toggle tag focus. If set to true this behaviour is disabled.
|
||||||
|
|
||||||
|
*set-tags*: ++
|
||||||
|
typeof: array ++
|
||||||
|
An array of tag bitmasks, one per tag button. Left-clicking a tag sets the focused tags to the corresponding bitmask instead of the single tag. Requires *disable-click* to be false.
|
||||||
|
|
||||||
|
*toggle-tags*: ++
|
||||||
|
typeof: array ++
|
||||||
|
An array of tag bitmasks, one per tag button. Right-clicking a tag toggles the corresponding bitmask in the focused tags instead of the single tag. Requires *disable-click* to be false.
|
||||||
|
|
||||||
*expand*: ++
|
*expand*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
default: false ++
|
default: false ++
|
||||||
|
|||||||
@@ -70,6 +70,11 @@ Addressed by *sway/workspaces*
|
|||||||
default: false ++
|
default: false ++
|
||||||
If set to true. Only focused workspaces will be shown.
|
If set to true. Only focused workspaces will be shown.
|
||||||
|
|
||||||
|
*ignore-workspaces*: ++
|
||||||
|
typeof: array ++
|
||||||
|
default: empty ++
|
||||||
|
List of regular expressions. Workspaces whose name matches any of the given patterns are not shown.
|
||||||
|
|
||||||
*persistent-workspaces*: ++
|
*persistent-workspaces*: ++
|
||||||
typeof: json (see below) ++
|
typeof: json (see below) ++
|
||||||
default: empty ++
|
default: empty ++
|
||||||
|
|||||||
@@ -26,6 +26,16 @@ Addressed by *wayfire/workspaces*
|
|||||||
default: false ++
|
default: false ++
|
||||||
If set to false, you can click to change workspace. If set to true this behaviour is disabled.
|
If set to false, you can click to change workspace. If set to true this behaviour is disabled.
|
||||||
|
|
||||||
|
*disable-scroll*: ++
|
||||||
|
typeof: bool ++
|
||||||
|
default: false ++
|
||||||
|
If set to false, you can scroll to cycle through workspaces. If set to true this behaviour is disabled.
|
||||||
|
|
||||||
|
*enable-bar-scroll*: ++
|
||||||
|
typeof: bool ++
|
||||||
|
default: false ++
|
||||||
|
If set to false, you can't scroll to cycle through workspaces from the entire bar. If set to true this behaviour is enabled.
|
||||||
|
|
||||||
*disable-markup*: ++
|
*disable-markup*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
default: false ++
|
default: false ++
|
||||||
|
|||||||
Reference in New Issue
Block a user