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

Update README

Browse Source
This commit is contained in:
enkore 2013-11-24 19:38:44 +01:00
parent a4e6e540dc
commit e9e6dd1bf6
2 changed files with 20 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -55,24 +55,7 @@ as it can not only reproduce all the variants removed, but can do much more.
## Configuration
You can keep your config file at various places, i3pystatus will look
for it in these places:
~/.i3pystatus.py
~/.i3/i3pystatus.py
~/.config/i3pystatus.py
$XDG_CONFIG_HOME/i3pystatus.py
/etc/i3pystatus.py
/etc/xdg/i3pystatus.py
$XDG_CONFIG_DIRS/i3pystatus.py
The config file is just a normal Python module that is executed if you execute
i3pystatus (it is placed inside the i3pystatus package).
You can also execute your config file instead of i3pystatus, but you need to
use an absolute import (`from i3pystatus import Status`) and cannot name it
i3pystatus.py. This is very handy for using different status lines for different
outputs.
The config file is just a normal Python script.
A simple configuration file could look like this (note the additional dependencies
from network, wireless and pulseaudio in this example):
@ -81,7 +64,7 @@ from network, wireless and pulseaudio in this example):
import subprocess
from . import Status
from i3pystatus import Status
status = Status(standalone=True)
@ -184,7 +167,7 @@ Also change your i3wm config to the following:
# i3bar
bar {
status_command i3pystatus
status_command python ~/.path/to/your/config/file.py
position top
workspace_buttons yes
}
@ -348,7 +331,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: `{'FULL': 'FULL', 'CHR': 'CHR', 'DIS': 'DIS'}`)
* `status` — A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: `{'FULL': 'FULL', 'DIS': 'DIS', 'CHR': 'CHR'}`)
@ -554,7 +537,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: `{'stop': '◾', 'play': '▶', 'pause': '▷'}`)
* `status` — Dictionary mapping pause, play and stop to output (default: `{'pause': '▷', 'stop': '◾', 'play': '▶'}`)
@ -765,6 +748,18 @@ __Settings:__
### xrandr
Do Not Publish, private hack of it's own
__Settings:__
## Contribute

23
README.tpl.md
View File

@ -55,24 +55,7 @@ as it can not only reproduce all the variants removed, but can do much more.
## Configuration
You can keep your config file at various places, i3pystatus will look
for it in these places:
~/.i3pystatus.py
~/.i3/i3pystatus.py
~/.config/i3pystatus.py
$XDG_CONFIG_HOME/i3pystatus.py
/etc/i3pystatus.py
/etc/xdg/i3pystatus.py
$XDG_CONFIG_DIRS/i3pystatus.py
The config file is just a normal Python module that is executed if you execute
i3pystatus (it is placed inside the i3pystatus package).
You can also execute your config file instead of i3pystatus, but you need to
use an absolute import (`from i3pystatus import Status`) and cannot name it
i3pystatus.py. This is very handy for using different status lines for different
outputs.
The config file is just a normal Python script.
A simple configuration file could look like this (note the additional dependencies
from network, wireless and pulseaudio in this example):
@ -81,7 +64,7 @@ from network, wireless and pulseaudio in this example):
import subprocess
from . import Status
from i3pystatus import Status
status = Status(standalone=True)
@ -184,7 +167,7 @@ Also change your i3wm config to the following:
# i3bar
bar {
status_command i3pystatus
status_command python ~/.path/to/your/config/file.py
position top
workspace_buttons yes
}