X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.1.xml;h=9a36ee5731a7f0471abc97e69016a08b9f99d52d;hb=fe1ed51724531b8c1e78e7d7eb590c9be20e275c;hp=5362cb9579c047c4d1bbdb39f170a6706e63c3e5;hpb=14a769add6d435a7ad7db4d36074dc79511af4e3;p=mpd-sima.git

diff --git a/data/man/mpd_sima.1.xml b/data/man/mpd_sima.1.xml
index 5362cb9..9a36ee5 100644
--- a/data/man/mpd_sima.1.xml
+++ b/data/man/mpd_sima.1.xml
@@ -57,7 +57,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
   </refmeta>
   <refnamediv>
     <refname>&dhpackage;</refname>
-    <refpurpose>&dhpackage; will try to maintain some titles ahead in your play list following different policies.</refpurpose>
+    <refpurpose>&dhpackage; will try to maintain some titles ahead in the queue following different policies.</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
     <cmdsynopsis>
@@ -73,21 +73,26 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
     </cmdsynopsis>
     <cmdsynopsis>
       <command>&dhpackage;</command>
+      <arg choice="plain">--create-db</arg>
       <arg choice="opt"><option>--var_dir=</option><replaceable class="option">var_directory</replaceable></arg>
-      <arg choice="opt"><option>--create-db></option></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>
@@ -100,7 +105,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
         command lines options are honored. For instance you can override
         default MPD_HOST set in defaults (localhost) or in your configuration
         file with <command>-S my_mpd_server</command> option. For default
-        configuration see <xref linkend="configuration"/>.</para>
+        configuration see <xref linkend="configuration"/>. See also environment
+        variables special case for MPD host and port in <xref linkend="environment"/>.
+    </para>
   </refsect1>
     <refsect1 id="example">
         <title>EXAMPLE</title>
@@ -167,11 +174,19 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <para>Verbosity in [debug,info,warning,error].<sbr />Default is to log info messages.</para>
             </listitem>
         </varlistentry>
-        <varlistentry>
+        <varlistentry><!-- config -->
             <term><option>-c <replaceable class="parameter">conf_file</replaceable></option></term>
             <term><option>--config=<replaceable class="parameter">conf_file</replaceable></option></term>
             <listitem>
-                <para>Use the specific file <replaceable>conf_file</replaceable> to set up configuration instead of looking for the default user configuration file.<sbr />Default is to look for <envar>$XDG_CONFIG_HOME/mpd_sima/mpd_sima.cfg</envar>.  Concerning this file see also <xref linkend="files"/>.<sbr />Pay attention: Because you load a specific configuration file from command line interface <emphasis>does not mean</emphasis> it will override others options pass to mpd_sima. In other words launching with <option>-P 6666</option> will override port setting whatever the configuration file your using, default or command line specified.</para>
+                <para>Use the specific file <replaceable>conf_file</replaceable> to set up
+                    configuration instead of looking for the default user
+                    configuration file.<sbr />Default is to look for
+                    <envar>$XDG_CONFIG_HOME/mpd_sima/mpd_sima.cfg</envar>.<sbr />
+                    CLI option overrides any equivalent mentioned in configuration file, ie. launching &dhutils; with '<option>--port</option>' CLI option will ignore port setting in configuration file.<sbr />
+                    For more details on configuration file cf.
+                    <citerefentry><refentrytitle>mpd_sima.cfg</refentrytitle>
+                <manvolnum>5</manvolnum></citerefentry>, see also <xref linkend="files"/>.<sbr />
+                   </para>
             </listitem>
         </varlistentry>
         <varlistentry> <!-- var_dir -->
@@ -180,6 +195,12 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <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>
@@ -240,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
-                            play list 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>