Update README
This commit is contained in:
parent
d0885b4fbc
commit
ca962fff49
27
README.rst
27
README.rst
@ -249,7 +249,7 @@ would produce ``1:5:51``
|
|||||||
Modules
|
Modules
|
||||||
-------
|
-------
|
||||||
|
|
||||||
:System: `clock`_ - `disk`_ - `load`_ - `mem`_
|
:System: `clock`_ - `disk`_ - `load`_ - `mem`_ `cpu_usage`_
|
||||||
:Audio: `alsa`_ - `pulseaudio`_
|
:Audio: `alsa`_ - `pulseaudio`_
|
||||||
:Hardware: `battery`_ - `backlight`_ - `temp`_
|
:Hardware: `battery`_ - `backlight`_ - `temp`_
|
||||||
:Network: `network`_ - `wireless`_
|
:Network: `network`_ - `wireless`_
|
||||||
@ -333,7 +333,7 @@ Settings:
|
|||||||
:alert_format_title: The title of the notification, all formatters can be used (default: ``Low battery``)
|
:alert_format_title: The title of the notification, all formatters can be used (default: ``Low battery``)
|
||||||
:alert_format_body: The body text of the notification, all formatters can be used (default: ``Battery {battery_ident} has only {percentage:.2f}% ({remaining:%E%hh:%Mm}) remaining!``)
|
:alert_format_body: The body text of the notification, all formatters can be used (default: ``Battery {battery_ident} has only {percentage:.2f}% ({remaining:%E%hh:%Mm}) remaining!``)
|
||||||
:path: Override the default-generated path (default: ``None``)
|
:path: Override the default-generated path (default: ``None``)
|
||||||
:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'CHR': 'CHR', 'DIS': 'DIS', 'FULL': 'FULL'}``)
|
:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'CHR': 'CHR', 'FULL': 'FULL', 'DIS': 'DIS'}``)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -350,6 +350,27 @@ Settings:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpu_usage
|
||||||
|
+++++++++
|
||||||
|
|
||||||
|
|
||||||
|
Shows CPU usage.
|
||||||
|
The first output will be inacurate
|
||||||
|
Linux only
|
||||||
|
|
||||||
|
Available formatters:
|
||||||
|
|
||||||
|
* {usage}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Settings:
|
||||||
|
|
||||||
|
:format: (default: ``{usage:02}%``)
|
||||||
|
:format string. Default: '{usage:02}%':
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
disk
|
disk
|
||||||
++++
|
++++
|
||||||
|
|
||||||
@ -570,7 +591,7 @@ Settings:
|
|||||||
:host: (default: ``localhost``)
|
:host: (default: ``localhost``)
|
||||||
:port: MPD port (default: ``6600``)
|
:port: MPD port (default: ``6600``)
|
||||||
:format: formatp string (default: ``{title} {status}``)
|
:format: formatp string (default: ``{title} {status}``)
|
||||||
:status: Dictionary mapping pause, play and stop to output (default: ``{'play': '▶', 'stop': '◾', 'pause': '▷'}``)
|
:status: Dictionary mapping pause, play and stop to output (default: ``{'play': '▶', 'pause': '▷', 'stop': '◾'}``)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -249,7 +249,7 @@ would produce ``1:5:51``
|
|||||||
Modules
|
Modules
|
||||||
-------
|
-------
|
||||||
|
|
||||||
:System: `clock`_ - `disk`_ - `load`_ - `mem`_
|
:System: `clock`_ - `disk`_ - `load`_ - `mem`_ `cpu_usage`_
|
||||||
:Audio: `alsa`_ - `pulseaudio`_
|
:Audio: `alsa`_ - `pulseaudio`_
|
||||||
:Hardware: `battery`_ - `backlight`_ - `temp`_
|
:Hardware: `battery`_ - `backlight`_ - `temp`_
|
||||||
:Network: `network`_ - `wireless`_
|
:Network: `network`_ - `wireless`_
|
||||||
|
Loading…
Reference in New Issue
Block a user