diff options
| author | Ultrabug <ultrabug@gentoo.org> | 2013-08-29 15:48:06 +0200 |
|---|---|---|
| committer | Ultrabug <ultrabug@gentoo.org> | 2013-08-29 15:48:06 +0200 |
| commit | 6db965b4ab7a38c4f6eb82edcda05faca0d0c23f (patch) | |
| tree | 2da1aa8577b853dcd89188e89c6020e9b172e764 | |
| parent | 5071568c352f63817f9680277ed3c29f8c50e68b (diff) | |
update the README
| -rw-r--r-- | README.rst | 47 |
1 files changed, 28 insertions, 19 deletions
@@ -1,44 +1,51 @@ +========= py3status ========= +**py3status** is an extensible i3status wrapper written in python. + +Using py3status, you can take control of your i3bar easily by: + - writing your own modules and have their output displayed on your bar + - handling click events on your i3bar and play with them in no time + - seeing your clock tick every second whatever your i3status interval -py3status is an extensible i3status wrapper written in python +No extra configuration file needed, just install & enjoy ! Documentation -========= -See the wiki for up to date documentation : https://github.com/ultrabug/py3status/wiki +============= +See the wiki for up to date documentation: + https://github.com/ultrabug/py3status/wiki + +Learn how to write your own modules: + https://github.com/ultrabug/py3status/wiki/Write-your-own-modules Requirements -========= -You must set the `output_format` to `i3bar` in the general section of your i3status.conf: +============ +You **must** set the `output_format` to `i3bar` in the general section of your i3status.conf: :: general { output_format = "i3bar" } Installation (all users) -========= +======================== py3status is available on pypi: :: $ pip install py3status Installation (Gentoo users) -========= -Add the `ultrabug` overlay on layman: -:: - $ sudo layman -a ultrabug - -Install py3status: +=========================== +py3status is available on portage: :: $ sudo emerge -a py3status Installation (Arch users) -========= +========================= Thanks to @waaaaargh, py3status is present in the Arch User Repository using this URL: :: https://aur.archlinux.org/packages/py3status-git/ Usage -========= +===== In your i3 config file, simply change the `status_command` with: :: status_command py3status @@ -48,17 +55,19 @@ Usually you have your own i3status configuration, just point to it: status_command py3status -c ~/.i3/i3status.conf Options -========= +======= You can see the help of py3status by issuing `py3status -h`: :: -c I3STATUS_CONF path to i3status config file - -d disable integrated transformations - -i INCLUDE_PATH include user-written modules from those directories (default .i3/py3status) + --debug be verbose in syslog + -i INCLUDE_PATHS include user-written modules from those directories + (default .i3/py3status) -n INTERVAL update interval in seconds (default 1 sec) - -t CACHE_TIMEOUT default injection cache timeout in seconds (default 60 sec) + -t CACHE_TIMEOUT default injection cache timeout in seconds + (default 60 sec) Control -========= +======= Just like i3status, you can force an update by sending a SIGUSR1 signal to py3status. Note that this will also send a SIGUSR1 signal to i3status. :: |
