<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="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
</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>
+ <cmdsynopsis>
+ <command>&dhpackage;</command>
+ <arg choice="plain">purge-history</arg>
+ <arg choice="opt"><option>--var-dir=</option><replaceable class="option">var_directory</replaceable></arg>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<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>
</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>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 -->
<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>
+ <varlistentry> <!-- purge-history -->
+ <term><option>purge-history</option></term>
+ <listitem>
+ <para>Purge play history in 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>
</variablelist>
</refsect1>
<xi:include href="files.xml" />
</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">
<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>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>
+ <para><command>&dhpackage; generate-config</command></para>
</listitem>
</varlistentry>
</variablelist>
home / dev / repositories / mpd-sima.git / blobdiff