diff --git a/doc/yambar-decorations.5.scd b/doc/yambar-decorations.5.scd index 24282b5..9dd21b8 100644 --- a/doc/yambar-decorations.5.scd +++ b/doc/yambar-decorations.5.scd @@ -23,7 +23,7 @@ This decoration sets the particles background color. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | color : color : yes @@ -49,7 +49,7 @@ bottom of the particle. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | size : int : yes @@ -81,7 +81,7 @@ size and color at the top of the particle. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | size : int : yes @@ -113,7 +113,7 @@ width) around the particle. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | color : color : yes diff --git a/doc/yambar-modules-alsa.5.scd b/doc/yambar-modules-alsa.5.scd index 17f1a29..14804e5 100644 --- a/doc/yambar-modules-alsa.5.scd +++ b/doc/yambar-modules-alsa.5.scd @@ -7,7 +7,7 @@ alsa - Monitors an alsa soundcard for volume and mute/unmute changes [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | online : bool : True when the ALSA device has successfully been opened @@ -32,7 +32,7 @@ alsa - Monitors an alsa soundcard for volume and mute/unmute changes [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | card : string : yes diff --git a/doc/yambar-modules-backlight.5.scd b/doc/yambar-modules-backlight.5.scd index 7c1e6c6..6fa3a9a 100644 --- a/doc/yambar-modules-backlight.5.scd +++ b/doc/yambar-modules-backlight.5.scd @@ -11,7 +11,7 @@ _/sys/class/backlight_, and uses *udev* to monitor for changes. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | brightness : range : The current brightness level, in absolute value diff --git a/doc/yambar-modules-battery.5.scd b/doc/yambar-modules-battery.5.scd index 3d55ed9..101c02b 100644 --- a/doc/yambar-modules-battery.5.scd +++ b/doc/yambar-modules-battery.5.scd @@ -23,7 +23,7 @@ the state *unknown* under other conditions. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | name : string : Battery device name @@ -49,7 +49,7 @@ the state *unknown* under other conditions. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | name : string : yes diff --git a/doc/yambar-modules-clock.5.scd b/doc/yambar-modules-clock.5.scd index e8dbadf..bf3506b 100644 --- a/doc/yambar-modules-clock.5.scd +++ b/doc/yambar-modules-clock.5.scd @@ -7,7 +7,7 @@ clock - This module provides the current date and time [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | time : string : Current time, formatted using the _time-format_ attribute @@ -20,7 +20,7 @@ clock - This module provides the current date and time [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | time-format : string : no diff --git a/doc/yambar-modules-cpu.5.scd b/doc/yambar-modules-cpu.5.scd index 2e2bda4..1b4219e 100644 --- a/doc/yambar-modules-cpu.5.scd +++ b/doc/yambar-modules-cpu.5.scd @@ -13,7 +13,7 @@ total CPU usage. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | id : int : Core ID. 0..n represents individual cores, and -1 represents the @@ -27,7 +27,7 @@ total CPU usage. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | interval : int : no diff --git a/doc/yambar-modules-disk-io.5.scd b/doc/yambar-modules-disk-io.5.scd index 92ce449..4def79f 100644 --- a/doc/yambar-modules-disk-io.5.scd +++ b/doc/yambar-modules-disk-io.5.scd @@ -9,7 +9,7 @@ currently present in the machine. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | device : string : Name of the device being tracked (use the command *lsblk* to see these). @@ -34,7 +34,7 @@ currently present in the machine. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | interval : int : no diff --git a/doc/yambar-modules-dwl.5.scd b/doc/yambar-modules-dwl.5.scd index 4e41691..be34de1 100644 --- a/doc/yambar-modules-dwl.5.scd +++ b/doc/yambar-modules-dwl.5.scd @@ -25,7 +25,7 @@ Running multiple instances at the same time may result in [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | id : int : Dwl tag id. @@ -59,7 +59,7 @@ Running multiple instances at the same time may result in [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | number-of-tags : int : yes diff --git a/doc/yambar-modules-foreign-toplevel.5.scd b/doc/yambar-modules-foreign-toplevel.5.scd index 94c4b84..8b1d576 100644 --- a/doc/yambar-modules-foreign-toplevel.5.scd +++ b/doc/yambar-modules-foreign-toplevel.5.scd @@ -21,7 +21,7 @@ Note: Wayland only. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | app-id : string : The application ID (typically the application name) @@ -47,7 +47,7 @@ Note: Wayland only. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | content : particle : yes diff --git a/doc/yambar-modules-i3.5.scd b/doc/yambar-modules-i3.5.scd index f82d131..37d54bf 100644 --- a/doc/yambar-modules-i3.5.scd +++ b/doc/yambar-modules-i3.5.scd @@ -22,7 +22,7 @@ with the _application_ and _title_ tags to replace the X11-only [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | name : string : The workspace name @@ -57,7 +57,7 @@ with the _application_ and _title_ tags to replace the X11-only [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | content : associative array : yes diff --git a/doc/yambar-modules-mem.5.scd b/doc/yambar-modules-mem.5.scd index cec575c..82a70c3 100644 --- a/doc/yambar-modules-mem.5.scd +++ b/doc/yambar-modules-mem.5.scd @@ -7,7 +7,7 @@ mem - This module provides the memory usage [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | free : int : Free memory in bytes @@ -29,7 +29,7 @@ mem - This module provides the memory usage [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | interval : string : no diff --git a/doc/yambar-modules-mpd.5.scd b/doc/yambar-modules-mpd.5.scd index ccc5d85..aff6227 100644 --- a/doc/yambar-modules-mpd.5.scd +++ b/doc/yambar-modules-mpd.5.scd @@ -7,7 +7,7 @@ mpd - This module provides MPD status such as currently playing artist/album/son [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | state : string : One of *offline*, *stopped*, *paused* or *playing* @@ -56,7 +56,7 @@ mpd - This module provides MPD status such as currently playing artist/album/son [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | host : string : yes diff --git a/doc/yambar-modules-network.5.scd b/doc/yambar-modules-network.5.scd index d8129ef..7bb9afc 100644 --- a/doc/yambar-modules-network.5.scd +++ b/doc/yambar-modules-network.5.scd @@ -16,7 +16,7 @@ address. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | name : string : Network interface name @@ -64,7 +64,7 @@ address. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | name : string : yes diff --git a/doc/yambar-modules-pipewire.5.scd b/doc/yambar-modules-pipewire.5.scd index 4e0f587..0f7a40b 100644 --- a/doc/yambar-modules-pipewire.5.scd +++ b/doc/yambar-modules-pipewire.5.scd @@ -7,7 +7,7 @@ pipewire - Monitors pipewire for volume, mute/unmute, device change [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | type : string : Either "source" (capture) or "sink" (speaker) diff --git a/doc/yambar-modules-pulse.5.scd b/doc/yambar-modules-pulse.5.scd index 95df59a..008ec78 100644 --- a/doc/yambar-modules-pulse.5.scd +++ b/doc/yambar-modules-pulse.5.scd @@ -7,7 +7,7 @@ pulse - Monitors a PulseAudio source and/or sink [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | online : bool : True when connected to the PulseAudio server @@ -41,7 +41,7 @@ pulse - Monitors a PulseAudio source and/or sink [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | sink : string : no diff --git a/doc/yambar-modules-removables.5.scd b/doc/yambar-modules-removables.5.scd index ee7911f..0a193d4 100644 --- a/doc/yambar-modules-removables.5.scd +++ b/doc/yambar-modules-removables.5.scd @@ -12,7 +12,7 @@ instantiates the provided _content_ particle for each detected drive. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | vendor : string : Name of the drive vendor @@ -48,7 +48,7 @@ instantiates the provided _content_ particle for each detected drive. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | left-spacing : int : no diff --git a/doc/yambar-modules-river.5.scd b/doc/yambar-modules-river.5.scd index 4b3c6d8..7f2920f 100644 --- a/doc/yambar-modules-river.5.scd +++ b/doc/yambar-modules-river.5.scd @@ -24,7 +24,7 @@ once for all 32 river tags. This means you probably want to use a [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | id : int : River tag number @@ -42,14 +42,16 @@ once for all 32 river tags. This means you probably want to use a : True if the river tag has views (i.e. windows). | state : string -: Set to *urgent* if _urgent_ is true, *focused* if _focused_ is true, *unfocused* if _visible_ is true, but _focused_ is false, or *invisible* if the river tag is not visible on any monitors. +: Set to *urgent* if _urgent_ is true, *focused* if _focused_ is true, + *unfocused* if _visible_ is true, but _focused_ is false, or + *invisible* if the river tag is not visible on any monitors. # TAGS (for the "title" particle) [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | seat : string : The name of the seat (*title* particle only, see CONFIGURATION) @@ -66,7 +68,7 @@ once for all 32 river tags. This means you probably want to use a [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | title : particle : no diff --git a/doc/yambar-modules-script.5.scd b/doc/yambar-modules-script.5.scd index d021bf5..17ac34e 100644 --- a/doc/yambar-modules-script.5.scd +++ b/doc/yambar-modules-script.5.scd @@ -66,7 +66,7 @@ User defined. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | path : string : yes diff --git a/doc/yambar-modules-sway-xkb.5.scd b/doc/yambar-modules-sway-xkb.5.scd index 567f11a..bcf948c 100644 --- a/doc/yambar-modules-sway-xkb.5.scd +++ b/doc/yambar-modules-sway-xkb.5.scd @@ -16,7 +16,7 @@ instantiated from this template, and represents an input device. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | id : string : Input device identifier @@ -29,7 +29,7 @@ instantiated from this template, and represents an input device. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | identifiers : list of strings : yes diff --git a/doc/yambar-modules-xkb.5.scd b/doc/yambar-modules-xkb.5.scd index cb9b81c..ef03097 100644 --- a/doc/yambar-modules-xkb.5.scd +++ b/doc/yambar-modules-xkb.5.scd @@ -14,7 +14,7 @@ Note: this module is X11 only. It does not work in Wayland. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | name : string : Name of currently selected layout, long version (e.g. "English (US)") diff --git a/doc/yambar-modules-xwindow.5.scd b/doc/yambar-modules-xwindow.5.scd index b4c8e66..1aadbf7 100644 --- a/doc/yambar-modules-xwindow.5.scd +++ b/doc/yambar-modules-xwindow.5.scd @@ -16,7 +16,7 @@ _title_ tags. [[ *Name* :[ *Type* -:[ *Description* +:< *Description* | application : string : Name of the application that owns the currently focused window diff --git a/doc/yambar-modules.5.scd b/doc/yambar-modules.5.scd index 5767a52..177418f 100644 --- a/doc/yambar-modules.5.scd +++ b/doc/yambar-modules.5.scd @@ -110,7 +110,7 @@ following attributes are supported by all modules: [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | content : particle : yes diff --git a/doc/yambar-particles.5.scd b/doc/yambar-particles.5.scd index c04bf93..adf4485 100644 --- a/doc/yambar-particles.5.scd +++ b/doc/yambar-particles.5.scd @@ -12,7 +12,7 @@ following attributes are supported by all particles: [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | left-margin : int : no @@ -165,7 +165,7 @@ particle itself. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | items : list : yes @@ -239,7 +239,7 @@ Where is the tag you would like to map, is one of: and is the value you would like to compare it to. *If the value contains any non-alphanumerical characters, you must -surround it with ' " ' *: +surround it with ' \" ' *: ``` "hello world" @@ -305,7 +305,7 @@ tx-bitrate > 1000: [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | conditions : associative array : yes @@ -359,7 +359,7 @@ indicator. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | tag : string : yes @@ -414,7 +414,7 @@ itself when needed. [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | tag : string : yes diff --git a/doc/yambar-tags.5.scd b/doc/yambar-tags.5.scd index a8bb2ce..488fc77 100644 --- a/doc/yambar-tags.5.scd +++ b/doc/yambar-tags.5.scd @@ -11,7 +11,7 @@ their information. Each module defines its own set of tags. The available tag *types* are: [[ *Type* -:[ *Description* +:< *Description* | string : Value is a string. Rendered as-is by the _string_ particle. | int @@ -59,7 +59,7 @@ be used. [[ *Formatter* :[ *Kind* :[ *Description* -:[ *Applies to* +:< *Applies to* | . : format : How many decimals to print diff --git a/doc/yambar.5.scd b/doc/yambar.5.scd index 35c87b8..d7bf0b8 100644 --- a/doc/yambar.5.scd +++ b/doc/yambar.5.scd @@ -28,7 +28,7 @@ types that are frequently used: [[ *Name* :[ *Type* :[ *Req* -:[ *Description* +:< *Description* | height : int : yes