Browse files

Add documentation for starting Qtile

Closes #119
  • Loading branch information...
1 parent 624808c commit f4373714d192ce0c489946d25687c96a909b85c6 @tych0 tych0 committed Nov 19, 2012
Showing with 20 additions and 0 deletions.
  1. +1 −0 docs/index.rst
  2. +19 −0 docs/manual/config/starting.rst
View
1 docs/index.rst
@@ -22,6 +22,7 @@ Configuration
* **The basics**:
:doc:`Overview </manual/config/index>` |
+ :doc:`Starting Qtile </manual/config/starting>` |
:doc:`Hooks </manual/config/hooks>`
* **Config variables**:
View
19 docs/manual/config/starting.rst
@@ -0,0 +1,19 @@
+Starting Qtile
+==============
+
+There are several ways to start Qtile. The most common way is via an entry in
+your X session manager's menu. The default Qtile behavior can be invoked by
+creating a `qtile.desktop
+<https://github.com/qtile/qtile/blob/master/resources/qtile.desktop>`_ file in
+``/usr/share/xsessions``.
+
+A second way to start Qtile is a custom X session. This way allows you to
+invoke Qtile with custom arguments, and also allows you to do any setup you
+want (e.g. special keyboard bindings like mapping caps lock to control, setting
+your desktop background, etc.) before Qtile starts. If you're using an X
+session manager, you still may need to create a ``custom.desktop`` file similar
+to the ``qtile.desktop`` file above, but with ``Exec=/etc/X11/xsession``. Then,
+create your own ``~/.xsession``. There are several examples of user defined
+``xsession`` s in the `qtile-examples
+<https://github.com/qtile/qtile-examples>`_ repository.
+

0 comments on commit f437371

Please sign in to comment.