Now use "var-dir" as option name

[mpd-sima.git] / data / man / mpd_sima.1.xml

diff --git a/data/man/mpd_sima.1.xml b/data/man/mpd_sima.1.xml
index f187b5eb5ca33b3712f1eeb51ed63b79ccbc20fb..c0b59d49a63f891cd40bf1cac4cc1d3a6e68775b 100644 (file)
--- a/data/man/mpd_sima.1.xml
+++ b/data/man/mpd_sima.1.xml
@@ -64,7 +64,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
       <command>&dhpackage;</command>
       <arg choice="opt"><option>--daemon</option></arg>
       <arg choice="opt"><option>--config=</option><replaceable class="option">conf_file</replaceable></arg>
-      <arg choice="opt"><option>--var_dir=</option><replaceable class="option">var_directory</replaceable></arg>
+      <arg choice="opt"><option>--var-dir=</option><replaceable class="option">var_directory</replaceable></arg>
       <arg choice="opt"><option>--pid=</option><replaceable class="option">pid_file</replaceable></arg>
       <arg choice="opt"><option>--log=</option><replaceable class="option">log_file</replaceable></arg>
       <arg choice="opt"><option>--log-level=</option><replaceable class="option">log_level</replaceable></arg>
@@ -73,21 +73,26 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
     </cmdsynopsis>
     <cmdsynopsis>
       <command>&dhpackage;</command>
-      <arg choice="opt"><option>--var_dir=</option><replaceable class="option">var_directory</replaceable></arg>
-      <arg choice="opt"><option>--create-db></option></arg>
+      <arg choice="plain">--create-db</arg>
+      <arg choice="opt"><option>--var-dir=</option><replaceable class="option">var_directory</replaceable></arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <arg choice="plain">--generate-config</arg>
+      <arg choice="opt"><option>…</option></arg>
     </cmdsynopsis>
     <cmdsynopsis>
       <command>&dhpackage;</command>
       <!-- Normally the help and version options make the programs stop
            right after outputting the requested information. -->
-      <group choice="opt">
-        <arg choice="plain">
+      <group choice="plain">
+        <arg choice="req">
           <group choice="req">
             <arg choice="plain"><option>-h</option></arg>
             <arg choice="plain"><option>--help</option></arg>
           </group>
+          <arg choice="plain"><option>--version</option></arg>
         </arg>
-        <arg choice="plain"><option>--version</option></arg>
       </group>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -109,7 +114,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
         <refsect2 id="daemon">
             <title>Launch as a system service (dæmon).</title>
             <para>Here follows an example on how to launch &dhpackage; as a service on your system, not attach to regular user configuration/database.</para>
-            <para><command>&dhpackage; --daemon --conf=/etc/mpd_sima.cfg --var_dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log</command></para>
+            <para><command>&dhpackage; --daemon --conf=/etc/mpd_sima.cfg --var-dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log</command></para>
         </refsect2>
         <refsect2 id="user_land">
             <title>Launch in user land</title>
@@ -184,16 +189,22 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                    </para>
             </listitem>
         </varlistentry>
-        <varlistentry> <!-- var_dir -->
-            <term><option>--var_dir=<replaceable class="parameter">var_directory</replaceable></option></term>
+        <varlistentry> <!-- var-dir -->
+            <term><option>--var-dir=<replaceable class="parameter">var_directory</replaceable></option></term>
             <listitem>
                 <para>Use the specific path <replaceable>var_directory</replaceable> to look for (or create) var files (ie. database) instead of looking at the default user data location.<sbr />Default is to look in <envar>$XDG_DATA_HOME/mpd_sima/</envar>.  Concerning <envar>$XDG_DATA_HOME</envar> see also <xref linkend="files"/></para>
             </listitem>
         </varlistentry>
+        <varlistentry> <!-- generate-config -->
+            <term><option>--generate-config</option></term>
+            <listitem>
+                <para>Generate a sample configuration file according to the current configuration. You can put other options with this one to get them in the generated configuration.</para>
+            </listitem>
+        </varlistentry>
         <varlistentry> <!-- create-db -->
             <term><option>--create-db</option></term>
             <listitem>
-                <para>Create the database and exit. Uses folder specified with <option>--var_dir</option> or default directory.<sbr />Default is to use <envar>$XDG_DATA_HOME/mpd_sima/</envar>.  Concerning <envar>$XDG_DATA_HOME</envar> see also <xref linkend="files"/></para>
+                <para>Create the database and exit. Uses folder specified with <option>--var-dir</option> or default directory.<sbr />Default is to use <envar>$XDG_DATA_HOME/mpd_sima/</envar>.  Concerning <envar>$XDG_DATA_HOME</envar> see also <xref linkend="files"/></para>
             </listitem>
         </varlistentry>
         <varlistentry><!-- host -->
@@ -250,12 +261,8 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
               <term>DEFAULTS</term>
               <listitem>
                   <para>Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env. var. if set).</para>
-                        <para>The default behavior is to add one track,
-                            this track is to be chosen among titles from
-                            artists similar to the artist of the currently
-                            played track. MPD_sima will add one track when the
-                            unplayed queue is one track long.</para>
-                  <para>To change these defaults, use the configuration file <filename>mpd_sima.cfg</filename></para>
+                  <para>The get the defaults as detected by &dhpackage; on your system you can run &dhpackage; to print the config:</para>
+                  <para><command>&dhpackage; --generate-config</command></para>
               </listitem>
           </varlistentry>
       </variablelist>