summaryrefslogtreecommitdiffstats
path: root/py3status/modules/xrandr.py
diff options
context:
space:
mode:
authorUltrabug <ultrabug@gentoo.org>2015-03-31 13:14:25 +0200
committerUltrabug <ultrabug@gentoo.org>2015-03-31 13:14:25 +0200
commitada99c0af5665828abc725923bf2f104c577c852 (patch)
treea4e58a0d9a5bec4612efe98bf068730a45c32ef7 /py3status/modules/xrandr.py
parentcdfec19502d0415f92d85ffa48e6bec495ccb644 (diff)
move config parameters on every module docstring, overall QA
Diffstat (limited to 'py3status/modules/xrandr.py')
-rw-r--r--py3status/modules/xrandr.py43
1 files changed, 22 insertions, 21 deletions
diff --git a/py3status/modules/xrandr.py b/py3status/modules/xrandr.py
index ef88925..aea57b6 100644
--- a/py3status/modules/xrandr.py
+++ b/py3status/modules/xrandr.py
@@ -15,6 +15,28 @@ For convenience, this module also proposes some added features:
- Automatically apply this screen combination on start: no need for xorg!
- Automatically move workspaces to screens when they are available
+Configuration parameters:
+ - cache_timeout: how often to (re)detect the outputs
+ - fallback: when the current output layout is not available anymore,
+ fallback to this layout if available. This is very handy if you
+ have a laptop and switched to an external screen for presentation
+ and want to automatically fallback to your laptop screen when you
+ disconnect the external screen.
+ - force_on_start: switch to the given combination mode if available
+ when the module starts (saves you from having to configure xorg)
+ - format_clone: string used to display a 'clone' combination
+ - format_extend: string used to display a 'extend' combination
+
+Dynamic configuration parameters:
+ - <OUTPUT>_pos: apply the given position to the OUTPUT
+ Example: DP1_pos = "-2560x0"
+ Example: DP1_pos = "left-of LVDS1"
+ Example: DP1_pos = "right-of eDP1"
+
+ - <OUTPUT>_workspaces: comma separated list of workspaces to move to
+ the given OUTPUT when it is activated
+ Example: DP1_workspaces = "1,2,3"
+
Example config:
xrandr {
force_on_start = "eDP1+DP1"
@@ -36,27 +58,6 @@ from time import sleep, time
class Py3status:
"""
- Configuration parameters:
- - cache_timeout: how often to (re)detect the outputs
- - fallback: when the current output layout is not available anymore,
- fallback to this layout if available. This is very handy if you
- have a laptop and switched to an external screen for presentation
- and want to automatically fallback to your laptop screen when you
- disconnect the external screen.
- - force_on_start: switch to the given combination mode if available
- when the module starts (saves you from having to configure xorg)
- - format_clone: string used to display a 'clone' combination
- - format_extend: string used to display a 'extend' combination
-
- Dynamic configuration parameters:
- - <OUTPUT>_pos: apply the given position to the OUTPUT
- Example: DP1_pos = "-2560x0"
- Example: DP1_pos = "left-of LVDS1"
- Example: DP1_pos = "right-of eDP1"
-
- - <OUTPUT>_workspaces: comma separated list of workspaces to move to
- the given OUTPUT when it is activated
- Example: DP1_workspaces = "1,2,3"
"""
# available configuration parameters
cache_timeout = 10