[doc] update docs as per #606

This commit is contained in:
tobi-wan-kenobi 2020-05-06 12:57:38 +02:00
parent 806258c2ed
commit f49300e568
22 changed files with 164 additions and 191 deletions

View file

@ -1,4 +1,4 @@
from .__pulseaudio import Module
from .pulseaudio import Module
class Module(Module):

View file

@ -1,4 +1,4 @@
from .__pulseaudio import Module
from .pulseaudio import Module
class Module(Module):

View file

@ -8,9 +8,9 @@ Parameters:
* pulseaudio.autostart: If set to 'true' (default is 'false'), automatically starts the pulseaudio daemon if it is not running
* pulseaudio.percent_change: How much to change volume by when scrolling on the module (default is 2%)
* pulseaudio.limit: Upper limit for setting the volume (default is 0%, which means 'no limit')
Note: If the left and right channels have different volumes, the limit might not be reached exactly.
Note: If the left and right channels have different volumes, the limit might not be reached exactly.
* pulseaudio.showbars: 1 for showing volume bars, requires --markup=pango;
0 for not showing volume bars (default)
0 for not showing volume bars (default)
Requires the following executable:
* pulseaudio

View file

@ -7,8 +7,8 @@ Requires the following executable:
Parameters:
* redshift.location : location provider, either of 'auto' (default), 'geoclue2',
'ipinfo' or 'manual'
'auto' uses whatever redshift is configured to do
'ipinfo' or 'manual'
'auto' uses whatever redshift is configured to do
* redshift.lat : latitude if location is set to 'manual'
* redshift.lon : longitude if location is set to 'manual'
"""

View file

@ -4,10 +4,10 @@
Parameters:
* xrandr.overwrite_i3config: If set to 'true', this module assembles a new i3 config
every time a screen is enabled or disabled by taking the file '~/.config/i3/config.template'
and appending a file '~/.config/i3/config.<screen name>' for every screen.
every time a screen is enabled or disabled by taking the file '~/.config/i3/config.template'
and appending a file '~/.config/i3/config.<screen name>' for every screen.
* xrandr.autoupdate: If set to 'false', does *not* invoke xrandr automatically. Instead, the
module will only refresh when displays are enabled or disabled (defaults to true)
module will only refresh when displays are enabled or disabled (defaults to true)
Requires the following python module:
* (optional) i3 - if present, the need for updating the widget list is auto-detected