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

Minor readme updates

Browse Source
This commit is contained in:
enkore 2014-04-17 14:50:34 +02:00
parent dcd73c6d60
commit 109c217253
5 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.rst
View File

@ -62,7 +62,7 @@ Contributors:
3.28
++++
* **If you're currently using the ``i3pystatus`` command to run your i3bar**:
* **If you're currently using the i3pystatus command to run your i3bar**:
Replace ``i3pystatus`` command in your i3 configuration with ``python ~/path/to/your/config.py``
* Do not name your script i3pystatus.py or it will break imports.
* New options for `mem`_
@ -329,6 +329,7 @@ backlight
Screen backlight info
Available formatters:
* `{brightness}` — current brightness relative to max_brightness
* `{max_brightness}` — maximum brightness value
* `{percentage}` — current brightness in percent
@ -369,7 +370,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', 'FULL': 'FULL', 'CHR': 'CHR'}``)
:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'CHR': 'CHR', 'DIS': 'DIS', 'FULL': 'FULL'}``)
:color: The text color (default: ``#ffffff``)
:critical_color: The critical color (default: ``#ff0000``)
:interval: (default: ``5``)
@ -416,19 +417,19 @@ disk
++++
Gets `{used}`, `{free}`, `{available}` and `{total}` amount of bytes on the given mounted filesystem.
Gets ``{used}``, ``{free}``, ``{available}`` and ``{total}`` amount of bytes on the given mounted filesystem.
These values can also be expressed in percentages with the `{percentage_used}`, `{percentage_free}`
and `{percentage_avail}` formats.
These values can also be expressed as percentages with the ``{percentage_used}``, ``{percentage_free}``
and ``{percentage_avail}`` formats.
Settings:
:format: (default: ``{free}/{avail}``)
:path: (required)
:divisor: divide all byte values by this value, commonly 1024**3 (gigabyte) (default: ``1073741824``)
:display_limit: limit upper witch one the module isn't display (default: ``inf``)
:critical_limit: limit under witch one the disk space is critical (default: ``0``)
:divisor: divide all byte values by this value, default is 1024**3 (gigabyte) (default: ``1073741824``)
:display_limit: if more space is available than this limit the module is hidden (default: ``inf``)
:critical_limit: critical space limit (see critical_color) (default: ``0``)
:critical_color: the critical color (default: ``#FF0000``)
:interval: (default: ``5``)
@ -495,7 +496,7 @@ The `backends` setting determines the backends to use.
Settings:
:backends: List of backends (instances of `i3pystatus.mail.xxx.zzz`)
:backends: List of backends (instances of ``i3pystatus.mail.xxx.zzz``, i.e. ``i3pystatus.mail.imap.IMAP``)
:color: (default: ``#ffffff``)
:color_unread: (default: ``#ff0000``)
:format: (default: ``{unread} new email``)
@ -656,7 +657,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': '▶', 'pause': '▷', 'stop': '◾'}``)
:status: Dictionary mapping pause, play and stop to output (default: ``{'stop': '◾', 'play': '▶', 'pause': '▷'}``)
:interval: (default: ``1``)

2
README.tpl.rst
View File

@ -62,7 +62,7 @@ Contributors:
3.28
++++
* **If you're currently using the ``i3pystatus`` command to run your i3bar**:
* **If you're currently using the i3pystatus command to run your i3bar**:
Replace ``i3pystatus`` command in your i3 configuration with ``python ~/path/to/your/config.py``
* Do not name your script i3pystatus.py or it will break imports.
* New options for `mem`_

1
i3pystatus/backlight.py
View File

@ -7,6 +7,7 @@ class Backlight(File):
Screen backlight info
Available formatters:
* `{brightness}` — current brightness relative to max_brightness
* `{max_brightness}` — maximum brightness value
* `{percentage}` — current brightness in percent

12
i3pystatus/disk.py
View File

@ -7,17 +7,17 @@ from .core.util import round_dict
class Disk(IntervalModule):
"""
Gets `{used}`, `{free}`, `{available}` and `{total}` amount of bytes on the given mounted filesystem.
Gets ``{used}``, ``{free}``, ``{available}`` and ``{total}`` amount of bytes on the given mounted filesystem.
These values can also be expressed in percentages with the `{percentage_used}`, `{percentage_free}`
and `{percentage_avail}` formats.
These values can also be expressed as percentages with the ``{percentage_used}``, ``{percentage_free}``
and ``{percentage_avail}`` formats.
"""
settings = (
"format", "path",
("divisor", "divide all byte values by this value, commonly 1024**3 (gigabyte)"),
("display_limit", "limit upper witch one the module isn't display"),
("critical_limit", "limit under witch one the disk space is critical"),
("divisor", "divide all byte values by this value, default is 1024**3 (gigabyte)"),
("display_limit", "if more space is available than this limit the module is hidden"),
("critical_limit", "critical space limit (see critical_color)"),
("critical_color", "the critical color"),
)
required = ("path",)

2
i3pystatus/mail/__init__.py
View File

@ -25,7 +25,7 @@ class Mail(IntervalModule):
_endstring = """!!i3pystatus.mail!!"""
settings = (
("backends", "List of backends (instances of `i3pystatus.mail.xxx.zzz`)"),
("backends", "List of backends (instances of ``i3pystatus.mail.xxx.zzz``, i.e. ``i3pystatus.mail.imap.IMAP``)"),
"color", "color_unread", "format", "format_plural",
("hide_if_null", "Don't output anything if there are no new mails"),
("email_client", "The email client to open on left click"),