forked from external/yambar
doc: expand last column to fill screen in all tables
This commit is contained in:
parent
b195bc4dcb
commit
06bf127332
25 changed files with 53 additions and 51 deletions
|
@ -23,7 +23,7 @@ This decoration sets the particles background color.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| color
|
| color
|
||||||
: color
|
: color
|
||||||
: yes
|
: yes
|
||||||
|
@ -49,7 +49,7 @@ bottom of the particle.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| size
|
| size
|
||||||
: int
|
: int
|
||||||
: yes
|
: yes
|
||||||
|
@ -81,7 +81,7 @@ size and color at the top of the particle.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| size
|
| size
|
||||||
: int
|
: int
|
||||||
: yes
|
: yes
|
||||||
|
@ -113,7 +113,7 @@ width) around the particle.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| color
|
| color
|
||||||
: color
|
: color
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -7,7 +7,7 @@ alsa - Monitors an alsa soundcard for volume and mute/unmute changes
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| online
|
| online
|
||||||
: bool
|
: bool
|
||||||
: True when the ALSA device has successfully been opened
|
: 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*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| card
|
| card
|
||||||
: string
|
: string
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -11,7 +11,7 @@ _/sys/class/backlight_, and uses *udev* to monitor for changes.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| brightness
|
| brightness
|
||||||
: range
|
: range
|
||||||
: The current brightness level, in absolute value
|
: The current brightness level, in absolute value
|
||||||
|
|
|
@ -23,7 +23,7 @@ the state *unknown* under other conditions.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| name
|
| name
|
||||||
: string
|
: string
|
||||||
: Battery device name
|
: Battery device name
|
||||||
|
@ -49,7 +49,7 @@ the state *unknown* under other conditions.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| name
|
| name
|
||||||
: string
|
: string
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -7,7 +7,7 @@ clock - This module provides the current date and time
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| time
|
| time
|
||||||
: string
|
: string
|
||||||
: Current time, formatted using the _time-format_ attribute
|
: Current time, formatted using the _time-format_ attribute
|
||||||
|
@ -20,7 +20,7 @@ clock - This module provides the current date and time
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| time-format
|
| time-format
|
||||||
: string
|
: string
|
||||||
: no
|
: no
|
||||||
|
|
|
@ -13,7 +13,7 @@ total CPU usage.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| id
|
| id
|
||||||
: int
|
: int
|
||||||
: Core ID. 0..n represents individual cores, and -1 represents the
|
: Core ID. 0..n represents individual cores, and -1 represents the
|
||||||
|
@ -27,7 +27,7 @@ total CPU usage.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| interval
|
| interval
|
||||||
: int
|
: int
|
||||||
: no
|
: no
|
||||||
|
|
|
@ -9,7 +9,7 @@ currently present in the machine.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| device
|
| device
|
||||||
: string
|
: string
|
||||||
: Name of the device being tracked (use the command *lsblk* to see these).
|
: Name of the device being tracked (use the command *lsblk* to see these).
|
||||||
|
@ -34,7 +34,7 @@ currently present in the machine.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| interval
|
| interval
|
||||||
: int
|
: int
|
||||||
: no
|
: no
|
||||||
|
|
|
@ -25,7 +25,7 @@ Running multiple instances at the same time may result in
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| id
|
| id
|
||||||
: int
|
: int
|
||||||
: Dwl tag id.
|
: Dwl tag id.
|
||||||
|
@ -59,7 +59,7 @@ Running multiple instances at the same time may result in
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| number-of-tags
|
| number-of-tags
|
||||||
: int
|
: int
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -21,7 +21,7 @@ Note: Wayland only.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| app-id
|
| app-id
|
||||||
: string
|
: string
|
||||||
: The application ID (typically the application name)
|
: The application ID (typically the application name)
|
||||||
|
@ -47,7 +47,7 @@ Note: Wayland only.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| content
|
| content
|
||||||
: particle
|
: particle
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -22,7 +22,7 @@ with the _application_ and _title_ tags to replace the X11-only
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| name
|
| name
|
||||||
: string
|
: string
|
||||||
: The workspace name
|
: The workspace name
|
||||||
|
@ -57,7 +57,7 @@ with the _application_ and _title_ tags to replace the X11-only
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| content
|
| content
|
||||||
: associative array
|
: associative array
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -7,7 +7,7 @@ mem - This module provides the memory usage
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| free
|
| free
|
||||||
: int
|
: int
|
||||||
: Free memory in bytes
|
: Free memory in bytes
|
||||||
|
@ -29,7 +29,7 @@ mem - This module provides the memory usage
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| interval
|
| interval
|
||||||
: string
|
: string
|
||||||
: no
|
: no
|
||||||
|
|
|
@ -7,7 +7,7 @@ mpd - This module provides MPD status such as currently playing artist/album/son
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| state
|
| state
|
||||||
: string
|
: string
|
||||||
: One of *offline*, *stopped*, *paused* or *playing*
|
: 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*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| host
|
| host
|
||||||
: string
|
: string
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -16,7 +16,7 @@ address.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| name
|
| name
|
||||||
: string
|
: string
|
||||||
: Network interface name
|
: Network interface name
|
||||||
|
@ -64,7 +64,7 @@ address.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| name
|
| name
|
||||||
: string
|
: string
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -7,7 +7,7 @@ pipewire - Monitors pipewire for volume, mute/unmute, device change
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| type
|
| type
|
||||||
: string
|
: string
|
||||||
: Either "source" (capture) or "sink" (speaker)
|
: Either "source" (capture) or "sink" (speaker)
|
||||||
|
|
|
@ -7,7 +7,7 @@ pulse - Monitors a PulseAudio source and/or sink
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| online
|
| online
|
||||||
: bool
|
: bool
|
||||||
: True when connected to the PulseAudio server
|
: True when connected to the PulseAudio server
|
||||||
|
@ -41,7 +41,7 @@ pulse - Monitors a PulseAudio source and/or sink
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| sink
|
| sink
|
||||||
: string
|
: string
|
||||||
: no
|
: no
|
||||||
|
|
|
@ -12,7 +12,7 @@ instantiates the provided _content_ particle for each detected drive.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| vendor
|
| vendor
|
||||||
: string
|
: string
|
||||||
: Name of the drive vendor
|
: Name of the drive vendor
|
||||||
|
@ -48,7 +48,7 @@ instantiates the provided _content_ particle for each detected drive.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| left-spacing
|
| left-spacing
|
||||||
: int
|
: int
|
||||||
: no
|
: no
|
||||||
|
|
|
@ -24,7 +24,7 @@ once for all 32 river tags. This means you probably want to use a
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| id
|
| id
|
||||||
: int
|
: int
|
||||||
: River tag number
|
: 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).
|
: True if the river tag has views (i.e. windows).
|
||||||
| state
|
| state
|
||||||
: string
|
: 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)
|
# TAGS (for the "title" particle)
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| seat
|
| seat
|
||||||
: string
|
: string
|
||||||
: The name of the seat (*title* particle only, see CONFIGURATION)
|
: 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*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| title
|
| title
|
||||||
: particle
|
: particle
|
||||||
: no
|
: no
|
||||||
|
|
|
@ -66,7 +66,7 @@ User defined.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| path
|
| path
|
||||||
: string
|
: string
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -16,7 +16,7 @@ instantiated from this template, and represents an input device.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| id
|
| id
|
||||||
: string
|
: string
|
||||||
: Input device identifier
|
: Input device identifier
|
||||||
|
@ -29,7 +29,7 @@ instantiated from this template, and represents an input device.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| identifiers
|
| identifiers
|
||||||
: list of strings
|
: list of strings
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -14,7 +14,7 @@ Note: this module is X11 only. It does not work in Wayland.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| name
|
| name
|
||||||
: string
|
: string
|
||||||
: Name of currently selected layout, long version (e.g. "English (US)")
|
: Name of currently selected layout, long version (e.g. "English (US)")
|
||||||
|
|
|
@ -16,7 +16,7 @@ _title_ tags.
|
||||||
|
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| application
|
| application
|
||||||
: string
|
: string
|
||||||
: Name of the application that owns the currently focused window
|
: Name of the application that owns the currently focused window
|
||||||
|
|
|
@ -110,7 +110,7 @@ following attributes are supported by all modules:
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| content
|
| content
|
||||||
: particle
|
: particle
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -12,7 +12,7 @@ following attributes are supported by all particles:
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| left-margin
|
| left-margin
|
||||||
: int
|
: int
|
||||||
: no
|
: no
|
||||||
|
@ -165,7 +165,7 @@ particle itself.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| items
|
| items
|
||||||
: list
|
: list
|
||||||
: yes
|
: yes
|
||||||
|
@ -239,7 +239,7 @@ Where <tag> is the tag you would like to map, <operation> is one of:
|
||||||
|
|
||||||
and <value> is the value you would like to compare it to. *If the
|
and <value> is the value you would like to compare it to. *If the
|
||||||
value contains any non-alphanumerical characters, you must
|
value contains any non-alphanumerical characters, you must
|
||||||
surround it with ' " ' *:
|
surround it with ' \" ' *:
|
||||||
|
|
||||||
```
|
```
|
||||||
"hello world"
|
"hello world"
|
||||||
|
@ -305,7 +305,7 @@ tx-bitrate > 1000:
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| conditions
|
| conditions
|
||||||
: associative array
|
: associative array
|
||||||
: yes
|
: yes
|
||||||
|
@ -359,7 +359,7 @@ indicator.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| tag
|
| tag
|
||||||
: string
|
: string
|
||||||
: yes
|
: yes
|
||||||
|
@ -414,7 +414,7 @@ itself when needed.
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| tag
|
| tag
|
||||||
: string
|
: string
|
||||||
: yes
|
: yes
|
||||||
|
|
|
@ -11,7 +11,7 @@ their information. Each module defines its own set of tags.
|
||||||
The available tag *types* are:
|
The available tag *types* are:
|
||||||
|
|
||||||
[[ *Type*
|
[[ *Type*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| string
|
| string
|
||||||
: Value is a string. Rendered as-is by the _string_ particle.
|
: Value is a string. Rendered as-is by the _string_ particle.
|
||||||
| int
|
| int
|
||||||
|
@ -59,7 +59,7 @@ be used.
|
||||||
[[ *Formatter*
|
[[ *Formatter*
|
||||||
:[ *Kind*
|
:[ *Kind*
|
||||||
:[ *Description*
|
:[ *Description*
|
||||||
:[ *Applies to*
|
:< *Applies to*
|
||||||
| .<number>
|
| .<number>
|
||||||
: format
|
: format
|
||||||
: How many decimals to print
|
: How many decimals to print
|
||||||
|
|
|
@ -28,7 +28,7 @@ types that are frequently used:
|
||||||
[[ *Name*
|
[[ *Name*
|
||||||
:[ *Type*
|
:[ *Type*
|
||||||
:[ *Req*
|
:[ *Req*
|
||||||
:[ *Description*
|
:< *Description*
|
||||||
| height
|
| height
|
||||||
: int
|
: int
|
||||||
: yes
|
: yes
|
||||||
|
|
Loading…
Add table
Reference in a new issue