forked from external/yambar
469 lines
8.8 KiB
Markdown
469 lines
8.8 KiB
Markdown
f00bar-modules(5)
|
|
|
|
# NAME
|
|
f00bar-modules - configuration file
|
|
|
|
# DESCRIPTION
|
|
|
|
Modules are what monitors your system and provides data for the status
|
|
bar.
|
|
|
|
All modules expose their data through *tags*. Each tag has a *name*,
|
|
*type* and *value*. The name and type is fixed, while the value
|
|
typically changes over time. See *f00bar-tags(5)*.
|
|
|
|
The tags are rendered by _particles_. Each particle has its own way of
|
|
representing tag values. The simplest one is the _string_ particle,
|
|
which renders a text representation of the tag value. See
|
|
*f00bar-particles*(5).
|
|
|
|
# GENERIC CONFIGURATION
|
|
|
|
Each module defines its own configuration format. However, the
|
|
following attributes are supported by all modules:
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Description*
|
|
| content
|
|
: particle
|
|
: A particle describing how the module's information is to be rendered.
|
|
See *f00bar-particles*(5)
|
|
| anchors
|
|
: associative array
|
|
: Free-to-use associative array, where you can put yaml anchor definitions
|
|
| font
|
|
: font
|
|
: no
|
|
: Font to use in the content particle. This is an inherited attribute.
|
|
| foreground
|
|
: color
|
|
: no
|
|
: Foreground (text) color of the content particle. This is an
|
|
inherited attribute.
|
|
|
|
# ALSA
|
|
|
|
Monitors an alsa soundcard for volume and mute/unmute changes.
|
|
|
|
## TAGS
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Description*
|
|
| volume
|
|
: range
|
|
: Volume level, with min and max as start and end range values
|
|
| muted
|
|
: bool
|
|
: True if muted, otherwise false
|
|
|
|
|
|
## CONFIGURATION
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Req*
|
|
:[ *Description*
|
|
| card
|
|
: string
|
|
: yes
|
|
: The soundcard name. _Default_ might work.
|
|
| mixer
|
|
: string
|
|
: yes
|
|
: Mixer channel to monitor. _Master_ might work.
|
|
|
|
## EXAMPLES
|
|
|
|
```
|
|
bar:
|
|
left:
|
|
- alsa:
|
|
card: hw:PCH
|
|
mixer: Master
|
|
content: {string: {text: "{volume}"}}
|
|
```
|
|
|
|
# BACKLIGHT
|
|
|
|
This module reads monitor backlight status from
|
|
_/sys/class/backlight_, and uses *udev* to monitor for changes.
|
|
|
|
## TAGS
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Description*
|
|
| brightness
|
|
: range
|
|
: The current brightness level, in absolute value
|
|
| percent
|
|
: range
|
|
: The current brightness level, in percent
|
|
|
|
## CONFIGURATION
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Req*
|
|
:[ *Description*
|
|
| name
|
|
: string
|
|
: yes
|
|
: The backlight device's name (one of the names in */sys/class/backlight*)
|
|
|
|
## EXAMPLES
|
|
|
|
```
|
|
bar:
|
|
left:
|
|
- backlight:
|
|
name: intel_backlight
|
|
content:
|
|
string: {text: "backlight: {percent}%"}
|
|
```
|
|
|
|
# BATTERY
|
|
|
|
This module reads battery status from _/sys/class/power_supply_ and
|
|
uses *udev* to monitor for changes.
|
|
|
|
## TAGS
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Description*
|
|
| name
|
|
: string
|
|
: Battery device name
|
|
| manufacturer
|
|
: string
|
|
: Name of the battery manufacturer
|
|
| model
|
|
: string
|
|
: Battery model name
|
|
| state
|
|
: string
|
|
: One of *full*, *charging*, *discharging* or *unknown*
|
|
| capacity
|
|
: range
|
|
: capacity left, in percent
|
|
| estimate
|
|
: string
|
|
: Estimated time left (to empty while discharging, or to full while
|
|
charging), formatted as HH:MM.
|
|
|
|
## CONFIGURATION
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Req*
|
|
:[ *Description*
|
|
| name
|
|
: string
|
|
: yes
|
|
: Battery device name (one of the names in */sys/class/power_supply*)
|
|
| poll-interval
|
|
: int
|
|
: no
|
|
: How often, in seconds, to poll for capacity changes (default=*60*)
|
|
|
|
## EXAMPLES
|
|
|
|
```
|
|
bar:
|
|
left:
|
|
- battery:
|
|
name: BAT0
|
|
poll-interval: 30
|
|
content:
|
|
string: {text: "BAT: {capacity}% {estimate}"}
|
|
```
|
|
|
|
# CLOCK
|
|
|
|
This module provides the current date and time.
|
|
|
|
## TAGS
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Description*
|
|
| time
|
|
: string
|
|
: Current time, formatted using the _time-format_ attribute
|
|
| date
|
|
: string
|
|
: Current date, formatted using the _date-format_ attribute
|
|
|
|
## CONFIGURATION
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Req*
|
|
:[ *Description*
|
|
| time-format
|
|
: string
|
|
: no
|
|
: *strftime* formatter for the _time_ tag (default=*%H:%M*)
|
|
| date-format
|
|
: string
|
|
: no
|
|
: *strftime* formatter for the _date_ date (default=*%x*)
|
|
|
|
## EXAMPLES
|
|
|
|
```
|
|
bar:
|
|
left:
|
|
- clock:
|
|
time-format: "%H:%M %Z"
|
|
content:
|
|
string: {text: "{date} {time}"}
|
|
```
|
|
|
|
# I3 (and Sway)
|
|
|
|
This module monitors i3 and sway workspaces.
|
|
|
|
Unlike other modules where the _content_ attribute is just a single
|
|
*particle*, the i3 module's _content_ is an associative array mapping
|
|
i3/sway workspace names to a particle.
|
|
|
|
You can specify a default particle to use with an empty workspace
|
|
name, *""*.
|
|
|
|
It also recognizes the special name *current*, which always represents
|
|
the currently focused workspace.
|
|
|
|
## TAGS
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Description*
|
|
| name
|
|
: string
|
|
: The workspace name
|
|
| visible
|
|
: bool
|
|
: True if the workspace is currently visible (on any output)
|
|
| focused
|
|
: bool
|
|
: True if the workspace is currently focused
|
|
| urgent
|
|
: bool
|
|
: True if the workspace has the urgent flag set
|
|
| state
|
|
: string
|
|
: One of *urgent*, *focused*, *unfocused* or *invisible* (note:
|
|
*unfocused* is when it is visible, but neither focused nor urgent).
|
|
| application
|
|
: string
|
|
: Name of application currently focused on this workspace
|
|
| title
|
|
: string
|
|
: This workspace's focused window's title
|
|
|
|
## CONFIGURATION
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Req*
|
|
:[ *Description*
|
|
| content
|
|
: associative array
|
|
: yes
|
|
: Unlike other modules, _content_ is an associative array mapping
|
|
workspace names to particles. Use *""* to specify a default
|
|
fallback particle, or *current* for the currently active workspace.
|
|
| left-spacing
|
|
: int
|
|
: no
|
|
: Space, in pixels, on the left-side of each rendered workspace particle
|
|
| right-spacing
|
|
: int
|
|
: no
|
|
: Space, in pixels, on the right-side of each rendered workspace particle
|
|
| spacing
|
|
: int
|
|
: no
|
|
: Short-hand for setting both _left-spacing_ and _right-spacing_
|
|
|
|
## EXAMPLES
|
|
|
|
This renders all workspace names, with an *\** indicating the
|
|
currently focused one. It also renders the currently focused
|
|
application name and window title.
|
|
|
|
```
|
|
bar:
|
|
left:
|
|
- i3:
|
|
content:
|
|
"":
|
|
map:
|
|
tag: state
|
|
default: {string: {text: "{name}"}}
|
|
values:
|
|
focused: {string: {text: "{name}*"}}
|
|
current: { string: {text: "{application}: {title}"}}
|
|
```
|
|
|
|
# LABEL
|
|
|
|
This module renders the provided _content_ particle, but provides no
|
|
additional data.
|
|
|
|
## TAGS
|
|
|
|
None
|
|
|
|
## CONFIGURATION
|
|
|
|
No additional attributes supported, only the generic ones (see
|
|
*GENERIC CONFIGURATION*)
|
|
|
|
## EXAMPLES
|
|
|
|
```
|
|
bar:
|
|
left:
|
|
- label:
|
|
content: {string: {text: hello world}}
|
|
```
|
|
|
|
# MPD
|
|
|
|
This module provides MPD status such as currently playing
|
|
artist/album/song.
|
|
|
|
## TAGS
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Description*
|
|
| state
|
|
: string
|
|
: One of *offline*, *stopped*, *paused* or *playing*
|
|
| repeat
|
|
: bool
|
|
: True if the *repeat* flag is set
|
|
| random
|
|
: bool
|
|
: True if the *random* flag is set
|
|
| consume
|
|
: bool
|
|
: True if the *consume* flag is set
|
|
| album
|
|
: string
|
|
: Currently playing album (also valid in *paused* state)
|
|
| artist
|
|
: string
|
|
: Artist of currently playing song (also valid in *paused* state)
|
|
| title
|
|
: string
|
|
: Title of currently playing song (also valid in *paused* state)
|
|
| pos
|
|
: string
|
|
: *%M:%S*-formatted string describing the song's current position
|
|
(also see _elapsed_)
|
|
| end
|
|
: string
|
|
: *%M:%S*-formatted string describing the song's total length (also
|
|
see _duration_)
|
|
| elapsed
|
|
: realtime
|
|
: Position in currently playing song, in milliseconds. Can be used
|
|
with a _progress-bar_ particle.
|
|
| duration
|
|
: int
|
|
: Length of currently playing song, in milliseconds
|
|
|
|
## CONFIGURATION
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Req*
|
|
:[ *Description*
|
|
| host
|
|
: string
|
|
: yes
|
|
: Hostname/IP/unix-socket to connect to
|
|
| port
|
|
: int
|
|
: no
|
|
: TCP port to connect to
|
|
|
|
## EXAMPLES
|
|
|
|
```
|
|
bar:
|
|
left:
|
|
- mpd:
|
|
host: /run/mpd/socket
|
|
content:
|
|
string: {text: "{artist} - {album} - {title} ({end})"}
|
|
```
|
|
|
|
# NETWORK
|
|
|
|
This module monitors network connection state; disconnected/connected
|
|
state and MAC/IP addresses.
|
|
|
|
Note: while the module internally tracks all assigned IPv4/IPv6
|
|
addresses, it currently exposes only a single IPv4 and a single IPv6
|
|
address.
|
|
|
|
## TAGS
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Description*
|
|
| name
|
|
: string
|
|
: Network interface name
|
|
| index
|
|
: int
|
|
: Network interface index
|
|
| carrier
|
|
: bool
|
|
: True if the interface has CARRIER. That is, if it is physically connected.
|
|
| state
|
|
: string
|
|
: One of *unknown*, *not present*, *down*, *lower layers down*,
|
|
*testing*, *dormant* or *up*. You are probably interrested in *down* and *up*.
|
|
| mac
|
|
: string
|
|
: MAC address
|
|
| ipv4
|
|
: string
|
|
: IPv4 address assigned to the interface, or *""* if none
|
|
| ipv6
|
|
: string
|
|
: IPv6 address assigned to the interface, or *""* if none
|
|
|
|
## CONFIGURATION
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Req*
|
|
:[ *Description*
|
|
| name
|
|
: string
|
|
: Name of network interface to monitor
|
|
|
|
## EXAMPLES
|
|
|
|
```
|
|
bar:
|
|
left:
|
|
- network:
|
|
name: wlp3s0
|
|
content:
|
|
string: {text: "{name}: {state} ({ipv4})"}
|
|
```
|
|
|
|
# SEE ALSO
|
|
|
|
*f00bar-particles*(5), *f00bar-tags*(5), *f00bar-decorations*(5)
|