Add positional argument random, a random mode shortcut

[mpd-sima.git] / doc / source / index.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 09f16da222209c954ba304c54dd57958755f73f1..b3dc0d8218a329d48461489b3fcd7dff847e7ca2 100644 (file)
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -15,9 +15,11 @@ MPD_sima (or any advanced music players, MPD_ among them), you need to ensure
 your library is correctly tagged (see :ref:`metadata-convention`).
 
 The default setting for MPD_sima is to queue similar artists thanks to last.fm_
-suggestions but there are other possibilities.
+suggestions but there are other possibilities, see :ref:`configuration-examples`.
 
-**To queue tracks from similar artists, start playing a track in MPD then launch MPD_sima:**
+**To queue tracks from similar artists:**
+  - start playing a track in MPD
+  - launch MPD_sima
 
 .. code-block:: sh
 
@@ -27,6 +29,14 @@ suggestions but there are other possibilities.
     # runs against a specific MPD server
     mpd-sima --host mpd.example.org
 
+
+**To start in random queuing mode:**
+
+.. code-block:: sh
+
+    # Adds 5 tracks at random when there is only 1 track in the queue
+    mpd-sima random 5
+
 #####################
 User's documentation
 #####################
@@ -38,6 +48,20 @@ User's documentation
    user/*
 
 
+############
+Unix Manuals
+############
+
+These manual pages were written for the Debian system (and may be used by others).
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   man/mpd-sima.1.rst
+   man/mpd_sima.cfg.5.rst
+
+
 ##########################
 Development documentation
 ##########################
@@ -53,8 +77,9 @@ Development documentation
    dev/simadb
 
 
+##################
 Indices and tables
-==================
+##################
 
 * :ref:`genindex`
 * :ref:`modindex`