README
This commit is contained in:
enkore
parent
91b7e74ccf
commit
9dc1ecb9d1
38
README.md
38
README.md
@ -57,7 +57,7 @@ Shows volume of ALSA mixer. You can also use this for inputs, btw.
|
||||
Requires pyalsaaudio
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format` — {volume} is the current volume, {muted} is one of `muted` or `unmuted`. {card} is the sound card used; {mixer} the mixer. (default: `♪: {volume}`)
|
||||
* `mixer` — ALSA mixer (default: `Master`)
|
||||
@ -77,7 +77,7 @@ Requires pyalsaaudio
|
||||
Screen backlight info
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format` — format string, formatters: brightness, max_brightness, percentage (default: `{brightness}/{max_brightness}`)
|
||||
* `backlight` — backlight, see `/sys/class/backlight/` (default: `acpi_video0`)
|
||||
@ -102,9 +102,7 @@ Available formatters for format and alert_format_\*:
|
||||
* battery_ident
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `battery_ident` — (default: `BAT0`)
|
||||
* `format` — (default: `{status} {remaining_hm}`)
|
||||
@ -123,7 +121,7 @@ Available formatters for format and alert_format_\*:
|
||||
This class shows a clock
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format` — stftime format string (default: `None`)
|
||||
|
||||
@ -138,7 +136,7 @@ These values can also be expressed in percentages with the percentage_used, perc
|
||||
and percentage_avail formats.
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format` — (default: `{free}/{avail}`)
|
||||
* `path` — (required)
|
||||
@ -165,7 +163,7 @@ transforms is a optional dict of callables taking a single argument (a dictionar
|
||||
of all components). The return value is bound to the key.
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format` — (required)
|
||||
* `components` — (required)
|
||||
@ -182,7 +180,7 @@ of all components). The return value is bound to the key.
|
||||
Shows system load
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format` — format string used for output. {avg1}, {avg5} and {avg15} are the load average of the last one, five and fifteen minutes, respectively. {tasks} is the number of tasks (i.e. 1/285, which indiciates that one out of 285 total tasks is runnable). (default: `{avg1} {avg5}`)
|
||||
|
||||
@ -196,7 +194,7 @@ Generic mail checker
|
||||
The `backends` setting determines the backends to use. Currently available are:
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `backends` — List of backends (instances of i3pystatus.mail.xxx)
|
||||
* `color` — (default: `#ffffff`)
|
||||
@ -215,7 +213,7 @@ The `backends` setting determines the backends to use. Currently available are:
|
||||
> Checks for mail on a IMAP server
|
||||
>
|
||||
>
|
||||
>
|
||||
> __Settings:__
|
||||
>
|
||||
> * `host` — (required)
|
||||
> * `port` — (default: `993`)
|
||||
@ -233,7 +231,7 @@ The `backends` setting determines the backends to use. Currently available are:
|
||||
> and "unread"
|
||||
>
|
||||
>
|
||||
>
|
||||
> __Settings:__
|
||||
>
|
||||
> * `db_path` — (required)
|
||||
>
|
||||
@ -249,7 +247,7 @@ The `backends` setting determines the backends to use. Currently available are:
|
||||
> * python-dbus
|
||||
>
|
||||
>
|
||||
>
|
||||
> __Settings:__
|
||||
>
|
||||
>
|
||||
>
|
||||
@ -263,7 +261,7 @@ This class returns i3status parsable output of the number of
|
||||
unread posts in any bookmark in the mods.de forums.
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format` — Use {unread} as the formatter for number of unread posts (default: `{unread} new posts in bookmarks`)
|
||||
* `offset` — subtract number of posts before output (default: `0`)
|
||||
@ -294,7 +292,7 @@ Available formatters:
|
||||
Not available addresses (i.e. no IPv6 connectivity) are replaced with empty strings.
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `interface` — Interface to obtain information for, i.e. eth0 (default: `eth0`)
|
||||
* `format_up` — (default: `{interface}: {v4}`)
|
||||
@ -309,7 +307,7 @@ Not available addresses (i.e. no IPv6 connectivity) are replaced with empty stri
|
||||
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `instance` — Tracker instance
|
||||
* `format` — (default: `{name}:{progress}`)
|
||||
@ -323,7 +321,7 @@ Not available addresses (i.e. no IPv6 connectivity) are replaced with empty stri
|
||||
Simple regex file watcher
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format` — format string used for output (default: `{0}`)
|
||||
* `regex` — (required)
|
||||
@ -344,7 +342,7 @@ such as a VPN client or your DHCP client is running.
|
||||
Available formatters are {pid} and {name}.
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format_up` — (default: `{name}`)
|
||||
* `format_down` — (default: `{name}`)
|
||||
@ -363,7 +361,7 @@ Shows CPU temperature of Intel processors
|
||||
AMD is currently not supported as they can only report a relative temperature, which is pretty useless
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `format` — format string used for output. {temp} is the temperature in degrees celsius, {critical} and {high} are the trip point temps. (default: `{temp} °C`)
|
||||
* `color` — (default: `#FFFFFF`)
|
||||
@ -386,7 +384,7 @@ the same, except for these additional formatters:
|
||||
* {quality} Link quality in percent
|
||||
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
* `interface` — Interface to obtain information for, i.e. eth0 (default: `eth0`)
|
||||
* `format_up` — (default: `{interface}: {v4}`)
|
||||
|
||||
@ -17,7 +17,7 @@ MODULE_FORMAT = """
|
||||
|
||||
{doc}
|
||||
|
||||
|
||||
__Settings:__
|
||||
|
||||
{settings}
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user