diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 63 |
1 files changed, 37 insertions, 26 deletions
@@ -1,25 +1,33 @@ -========= +********* py3status -========= +********* +|version| + +.. |version| image:: https://pypip.in/version/py3status/badge.png + **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 + +- 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 No extra configuration file needed, just install & enjoy ! Documentation ============= See the wiki for up to date documentation: - https://github.com/ultrabug/py3status/wiki + +- https://github.com/ultrabug/py3status/wiki Learn how to write your own modules: - https://github.com/ultrabug/py3status/wiki/Write-your-own-modules + +- https://github.com/ultrabug/py3status/wiki/Write-your-own-modules Get help or share your ideas on IRC: - channel **#py3status** on **FreeNode** + +- channel **#py3status** on **FreeNode** Requirements ============ @@ -31,33 +39,35 @@ You **must** set the `output_format` to `i3bar` in the general section of your i output_format = "i3bar" } -Installation (all users) -======================== -py3status is available on pypi: +Usage +===== +In your i3 config file, simply switch from `i3status` to `py3status` in your `status_command`: :: - $ pip install py3status + status_command py3status -Installation (Gentoo users) -=========================== -py3status is available on portage: +Usually you have your own i3status configuration, just point to it: :: - $ sudo emerge -a py3status + status_command py3status -c ~/.i3/i3status.conf -Installation (Arch users) -========================= -Thanks to @waaaaargh, py3status is present in the Arch User Repository using this URL: +Installation +============ +Pypi +---- +Using pip: :: - https://aur.archlinux.org/packages/py3status-git/ + $ pip install py3status -Usage -===== -In your i3 config file, simply change the `status_command` with: +Gentoo Linux +------------ +Using emerge: :: - status_command py3status + $ sudo emerge -a py3status -Usually you have your own i3status configuration, just point to it: +Arch Linux +---------- +Thanks to @waaaaargh, py3status is present in the Arch User Repository using this URL: :: - status_command py3status -c ~/.i3/i3status.conf + https://aur.archlinux.org/packages/py3status-git/ Options ======= @@ -71,6 +81,7 @@ You can see the help of py3status by issuing `py3status -h`: -s, --standalone standalone mode, do not use i3status -t CACHE_TIMEOUT default injection cache timeout in seconds (default 60 sec) + -v, --version show py3status version and exit Control ======= |