projects / lilass.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
more rename DSL -> LiLaSS
[lilass.git] / README.rst
diff --git a/README.rst b/README.rst
index 6f6ee9678f2efdc525c750f0bedc4786efbffb6f..d32847dc6508b4902588132fea084b20ea4c5462 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,50 +1,52 @@
-DSL - easy Display Setup for Laptops
-====================================
+LiLaSS - Linux Laptop Screen Setup
+==================================
 
 Introduction
 ------------
 
 
 Introduction
 ------------
 
-This is the documentation of DSL_, a tool to setup screens on a Linux-powered
+This is the documentation of LiLaSS_, a tool to setup screens on a Linux-powered
 Laptop.
 
 Laptop.
 
-DSL is targeted for a specific use-case: The laptop is used both with the
+LiLaSS is targeted for a specific use-case: The laptop is used both with the
 internal screen only, and in combination with a single external screen.
 xrandr_ is used to detect whether an external screen is plugged in, and
 to change the configuration according to the user's specification.
 
 internal screen only, and in combination with a single external screen.
 xrandr_ is used to detect whether an external screen is plugged in, and
 to change the configuration according to the user's specification.
 
-.. _DSL: https://www.ralfj.de/projects/dsl
+.. _LiLaSS: https://www.ralfj.de/projects/lilass
 .. _xrandr: http://www.x.org/wiki/Projects/XRandR
 
 Usage
 -----
 
 .. _xrandr: http://www.x.org/wiki/Projects/XRandR
 
 Usage
 -----
 
-DSL features an interactive and a batched mode of use.
-Either way, of DSL is started while no external screen is connected, it
-enables the internal screen. It also resets the backlight to 100%, as some
-laptops keep the backlight off if it was turned off by power-saving features.
+LiLaSS features an interactive and a batched mode of use.
+Either way, if LiLaSS is started while no external screen is connected, it
+enables the internal screen.
 
 It is in the case that an external screen is plugged in that the two modes
 differ.
 
 
 It is in the case that an external screen is plugged in that the two modes
 differ.
 
-Simply run ``dsl.py`` to start the interactive mode. A window will pop up,
-allowing you to select the resolution of the external screen and where it
-will appear relative to the laptop. The option ``--frontend`` (or ``-f``) can
-be used to choose the frontend which opens the window. Currently, the
-frontends ``qt`` and ``zenity`` are available. DSL attempts to choose an
+Simply run ``lilass`` to start the interactive mode. A window will pop up, 
+allowing you to select which screens are enabled, their resolution, and how they 
+are positioned relatively to each other. The option ``--frontend`` (or ``-f``) 
+can be used to choose the frontend which opens the window. Currently, the 
+frontends ``qt`` and ``zenity`` are available. LiLaSS attempts to choose an 
 adequate frontend automatically.
 
 adequate frontend automatically.
 
-The option ``--relative-position`` (``-f``) suppresses the interactive
-configuration. Instead, the given given option (``left``, ``right`` or
-``external-only``) is applied with the default resolution of the external
+The option ``--relative-position`` (``-r``) suppresses the interactive 
+configuration. Instead, the given given option (``left``, ``right``, ``above``, 
+``below`` or ``mirror``) is applied with the default resolution of the external 
 screen.
 
 screen.
 
-Finally, the flag ``--internal-only`` (``-i``) tells DSL to ignore the
-external screen and enable the internal one.
+Finally, the flags ``--internal-only`` (``-i``) and ``--external-only`` (``-e``) 
+tells LiLaSS to use only one of the two screens.
+
+If the internal screen ends up being the only one that is used, LiLaSS attempts 
+to turn on your backlight if it was disabled.
 
 Automatic Configuration
 -----------------------
 
 
 Automatic Configuration
 -----------------------
 
-In combination with x-on-resize_ by Keith Peckard, DSL can automatically
+In combination with x-on-resize_ by Keith Peckard, LiLaSS can automatically
 pop-up when a screen is plugged in, and automatically re-enable the internal
 screen the external one is plugged off.
 
 pop-up when a screen is plugged in, and automatically re-enable the internal
 screen the external one is plugged off.
 
@@ -53,22 +55,22 @@ external screen is plugged in when you log in to your desktop environment.
 
 All this is achieved by running the following shell script on log-in::
 
 
 All this is achieved by running the following shell script on log-in::
 
-  DSL=/path/to/dsl.py
-  x-on-resize -c $DSL
-  $DSL -r external-only
+  LILASS=/path/to/lilass
+  x-on-resize -c $LILASS
+  $LILASS -r external-only
 
 .. _x-on-resize: http://keithp.com/blogs/x-on-resize/
 
 Configuration File
 ------------------
 
 
 .. _x-on-resize: http://keithp.com/blogs/x-on-resize/
 
 Configuration File
 ------------------
 
-You can use ``~/.dsl.conf`` to tell DSL which are the names of your internal
-and external connectors. These are the names as used by ``xrandr``.
-The option ``internalConnector`` gives the name of the xrandr connector
-corresponding to your internal laptop screen. All the others will be
-considered external screens, unless you use the option ``externalConnectors``
-to prove a (space-separated) list of connectors to be considered external by
-DSL. Any connector not mentioned in either option will be completely ignored.
+You can use ``~/.lilass.conf`` to tell LiLaSS which are the names of your 
+internal and external connectors. These are the names as used by ``xrandr``. The 
+option ``internalConnector`` gives the name of the xrandr connector 
+corresponding to your internal laptop screen. All the others will be considered 
+external screens, unless you use the option ``externalConnectors`` to prove a 
+(space-separated) list of connectors to be considered external by LiLaSS. Any 
+connector not mentioned in either option will be completely ignored.
 
 Source, License
 ---------------
 
 Source, License
 ---------------
@@ -76,7 +78,7 @@ Source, License
 You can find the sources in the `git repository`_. They are provided under
 the GPLv2_ or (at your option) any later version of the GPL.
 
 You can find the sources in the `git repository`_. They are provided under
 the GPLv2_ or (at your option) any later version of the GPL.
 
-.. _git repository: http://www.ralfj.de/git/dsl.git
+.. _git repository: http://www.ralfj.de/git/lilass.git
 .. _GPLv2: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 
 Contact
 .. _GPLv2: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 
 Contact
Linux Laptop Screen Setup