X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.1.xml;h=7d4269a29c3172d384b0ff6c151632c3c28b9145;hb=b75a67a8ef2924dbcfdb9838d5b35447baf1e4be;hp=48cf028cd2aa45ae3dc712120fc8a0bf5aa1bb01;hpb=d906b7f06726d9dd34ac9a6873bdf8fe683059d4;p=mpd-sima.git

diff --git a/data/man/mpd_sima.1.xml b/data/man/mpd_sima.1.xml
index 48cf028..7d4269a 100644
--- a/data/man/mpd_sima.1.xml
+++ b/data/man/mpd_sima.1.xml
@@ -64,32 +64,42 @@ 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>
       <arg choice="opt"><option>--host=</option><replaceable class="option">mpd_host</replaceable></arg>
       <arg choice="opt"><option>--mpd_port=</option><replaceable class="option">mpd_port</replaceable></arg>
     </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>
-    </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>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <arg choice="plain">config-test</arg>
+      <arg choice="opt"><option>--config=</option><replaceable class="option">conf_file</replaceable></arg>
+    </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>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <arg choice="plain">generate-config</arg>
+      <arg choice="opt"><option>…</option></arg>
+    </cmdsynopsis>
   </refsynopsisdiv>
   <refsect1 id="description">
     <title>DESCRIPTION</title>
@@ -109,7 +119,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 +194,10 @@ 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> <!-- 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>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><!-- host -->
@@ -212,6 +216,25 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <para>See also <xref linkend="environment"/></para>
             </listitem>
         </varlistentry>
+        <varlistentry> <!-- config-test -->
+            <term><option>config-test</option></term>
+            <listitem>
+              <para>Test configuration file and exit. Uses the configuration file specified with <option>--config</option> or default location.<sbr />Default is to use <envar>$XDG_CONFIG_HOME/mpd_sima/mpd_sima.cfg</envar> (see <xref linkend="files"/> for more).</para>
+                <para>config-test tests MPD connection and Tags plugin 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> (see <xref linkend="files"/> for more).</para>
+            </listitem>
+        </varlistentry>
+        <varlistentry> <!-- generate-config -->
+            <term><option>generate-config</option></term>
+            <listitem>
+                <para>Generate a sample configuration file according to the current CLI options and env. var.. The configuration is written on stdout.</para>
+            </listitem>
+        </varlistentry>
     </variablelist>
   </refsect1>
   <xi:include href="files.xml" />
@@ -230,6 +253,12 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                   </para>
               </listitem>
           </varlistentry>
+          <varlistentry>
+              <term><envar>HTTP_PROXY</envar>, <envar>HTTPS_PROXY</envar></term>
+              <listitem>
+                  <para>&dhutils; honors <envar>HTTP_PROXY</envar> environment variables.</para>
+              </listitem>
+          </varlistentry>
       </variablelist>
   </refsect1>
   <refsect1 id="configuration">
@@ -249,13 +278,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <varlistentry>
               <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 last artist in the queue.  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>Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env. var. if set). The default plugins will use Last.fm to find similar tracks to queue and fallback to random if nothing if found.</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>