i3pystatus/docs/i3pystatus.rst
Thiago Kenji Okada 5e3434bd29 Remove playerctl module
Playerctl uses the exactly same interface as now_playing, however it
depends on a external binary dependency instead of dbus-python. And
now_playing is more feature complete and follows the standard set by
other modules (like the mpd module), while playerctl used an alien
configuration.

Spotify module used to depend on playerctl. Actually, playerctl was the
whole spotify module. So now it uses now_playing. I don't know if
spotify only works with playerctl, however in theory if depends on the
same dbus interface implemented on now_playing. Needs testing.
2017-01-13 20:55:13 -02:00

73 lines
1.8 KiB
ReStructuredText

Module reference
================
.. Don't list *every* module here, e.g. cpu-usage suffices, because the other
variants are listed below that one.
.. rubric:: Module overview:
:System: `clock`_ - `cpu_freq`_ - `cpu_usage`_ - `disk`_ - `keyboard_locks`_ - `load`_ - `mem`_ -
`swap`_ - `uname`_ - `uptime`_ - `xkblayout`_
:Audio: `alsa`_ - `pulseaudio`_
:Hardware: `backlight`_ - `battery`_ - `temp`_
:Network: `net_speed`_ - `network`_ - `online`_ - `openstack_vms`_ - `openvpn`_
:Music: `cmus`_ - `moc`_ - `mpd`_ - `now_playing`_ - `pianobar`_ - `spotify`_
:Websites: `bitcoin`_ - `dota2wins`_ - `github`_ - `modsde`_ - `parcel`_ - `reddit`_ - `weather`_ -
`whosonlocation`_
:Other: `anybar`_ - `mail`_ - `pomodoro`_ - `pyload`_ - `text`_ - `updates`_
:Advanced: `file`_ - `regex`_ - `makewatch`_ - `runwatch`_ - `shell`_
.. autogen:: i3pystatus Module
.. rubric:: Module list:
.. _mailbackends:
Mail Backends
-------------
The generic mail module can be configured to use multiple mail backends. Here is an
example configuration for the MaildirMail backend:
.. code:: python
from i3pystatus.mail import maildir
status.register("mail",
backends=[maildir.MaildirMail(
directory="/home/name/Mail/inbox")
],
format="P {unread}",
log_level=20,
hide_if_null=False, )
.. autogen:: i3pystatus.mail SettingsBase
.. nothin'
.. _scorebackends:
Score Backends
--------------
.. autogen:: i3pystatus.scores SettingsBase
.. nothin'
.. _updatebackends:
Update Backends
---------------
.. autogen:: i3pystatus.updates SettingsBase
.. nothin'
.. _weatherbackends:
Weather Backends
----------------
.. autogen:: i3pystatus.weather SettingsBase
.. nothin'