summaryrefslogtreecommitdiffstats
path: root/README.rst
blob: 5ce32717ade74e24a77cc37bb2db0ba1534e5d9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
py3status
=========

py3status is an extensible i3status wrapper written in python

Documentation
=========
See the wiki for up to date documentation : https://github.com/ultrabug/py3status/wiki

Requirements
=========
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:
::
    $ 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

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)
    -n INTERVAL       update interval in seconds (default 1 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.
::
    killall -USR1 py3status