masq/i3pystatus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
Arvedui 2014-08-09 16:07:46 +02:00
parent cf110398e4
commit b2d25f6367
3 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.rst
View File

@ -429,7 +429,7 @@ Settings:
: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!``)
:path: Override the default-generated path (default: ``None``)
:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'DIS': 'DIS', 'CHR': 'CHR', 'FULL': 'FULL'}``)
:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'CHR': 'CHR', 'FULL': 'FULL', 'DIS': 'DIS'}``)
:color: The text color (default: ``#ffffff``)
:full_color: The full color (default: ``#00ff00``)
:charging_color: The charging color (default: ``#00ff00``)
@ -477,7 +477,7 @@ Settings:
:leftclick: URL to visit or command to run on left click (default: ``electrum``)
:rightclick: URL to visit or command to run on right click (default: ``https://bitcoinaverage.com/``)
:interval: Update interval. (default: ``600``)
:status: (default: ``{'price_up': '▲', 'price_down': '▼'}``)
:status: (default: ``{'price_down': '▼', 'price_up': '▲'}``)
@ -501,7 +501,8 @@ cpu_usage
Shows CPU usage.
The first output will be inacurate
The first output will be inacurate.
Linux only
Available formatters:
@ -526,13 +527,15 @@ cpu_usage_bar
Shows CPU usage as a bar (made with unicode box characters).
The first output will be inacurate
The first output will be inacurate.
Linux only
Available formatters:
* {usage_bar} usage average of all cores
* {usage_bar_cpu*} usage of one specific core. replace "*" by core number starting at 0
* {usage_bar_cpu*} usage of one specific core. replace "*"
by core number starting at 0
@ -815,7 +818,7 @@ Settings:
:host: (default: ``localhost``)
:port: MPD port (default: ``6600``)
: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': '◾'}``)
:color: The color of the text (default: ``#FFFFFF``)
:interval: (default: ``1``)
@ -895,7 +898,7 @@ Requires python-dbus available from every distros' package manager.
Settings:
:player: Player name (default: ``None``)
:status: Dictionary mapping pause, play and stop to output text (default: ``{'play': '▶', 'stop': '◾', 'pause': '▷'}``)
:status: Dictionary mapping pause, play and stop to output text (default: ``{'play': '▶', 'pause': '▷', 'stop': '◾'}``)
:color: Text color (default: ``#FFFFFF``)
:format: formatp string (default: ``{title} {status}``)
:interval: (default: ``1``)

3
i3pystatus/cpu_usage.py
View File

@ -14,7 +14,8 @@ except ImportError:
class CpuUsage(IntervalModule):
"""
Shows CPU usage.
The first output will be inacurate
The first output will be inacurate.
Linux only
Available formatters:

6
i3pystatus/cpu_usage_bar.py
View File

@ -6,13 +6,15 @@ from i3pystatus.core.util import make_bar
class CpuUsageBar(CpuUsage):
"""
Shows CPU usage as a bar (made with unicode box characters).
The first output will be inacurate
The first output will be inacurate.
Linux only
Available formatters:
* {usage_bar} usage average of all cores
* {usage_bar_cpu*} usage of one specific core. replace "*" by core number starting at 0
* {usage_bar_cpu*} usage of one specific core. replace "*"
by core number starting at 0
"""