data/man/mpd_sima.1.xml

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <!--
   3
   4 `xsltproc -''-nonet \
   5           -''-param man.charmap.use.subset "0" \
   6           -''-param make.year.ranges "1" \
   7           -''-param make.single.year.ranges "1" \
   8           /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
   9           manpage.xml'
  10
  11 A manual page <package>.<section> will be generated. You may view the
  12 manual page with: nroff -man <package>.<section> | less'. A typical entry
  13 in a Makefile or Makefile.am is:
  14
  15 DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
  16 XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
  17
  18 manpage.1: manpage.xml
  19         $(XP) $(DB2MAN) $<
  20
  21 The xsltproc binary is found in the xsltproc package. The XSL files are in
  22 docbook-xsl. A description of the parameters you can use can be found in the
  23 docbook-xsl-doc-* packages. Please remember that if you create the nroff
  24 version in one of the debian/rules file targets (such as build), you will need
  25 to include xsltproc and docbook-xsl in your Build-Depends control field.
  26 Alternatively use the xmlto command/package. That will also automatically
  27 pull in xsltproc and docbook-xsl.
  28
  29 Notes for using docbook2x: docbook2x-man does not automatically create the
  30 AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
  31 <refsect1> ... </refsect1>.
  32
  33 To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
  34 read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
  35 found in the docbook-xsl-doc-html package.
  36
  37 Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
  38
  39 General documentation about man-pages and man-page-formatting:
  40 man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
  41
  42 -->
  43 <!DOCTYPE refentry [
  44
  45   <!ENTITY dhsection   "1">
  46   <!ENTITY dhpackage "mpd-sima">
  47   <!ENTITY dhutils "mpd-sima">
  48
  49 ]>
  50
  51 <refentry xmlns="http://docbook.org/ns/docbook"
  52           xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0">
  53   <xi:include href="info.xml" />
  54   <refmeta>
  55       <refentrytitle>&dhutils;</refentrytitle>
  56       <manvolnum>&dhsection;</manvolnum>
  57   </refmeta>
  58   <refnamediv>
  59     <refname>&dhpackage;</refname>
  60     <refpurpose>&dhpackage; will try to maintain some titles ahead in the queue following different policies.</refpurpose>
  61   </refnamediv>
  62   <refsynopsisdiv>
  63     <cmdsynopsis>
  64       <command>&dhpackage;</command>
  65       <arg choice="opt"><option>--daemon</option></arg>
  66       <arg choice="opt"><option>--config=</option><replaceable class="option">conf_file</replaceable></arg>
  67       <arg choice="opt"><option>--var_dir=</option><replaceable class="option">var_directory</replaceable></arg>
  68       <arg choice="opt"><option>--pid=</option><replaceable class="option">pid_file</replaceable></arg>
  69       <arg choice="opt"><option>--log=</option><replaceable class="option">log_file</replaceable></arg>
  70       <arg choice="opt"><option>--log-level=</option><replaceable class="option">log_level</replaceable></arg>
  71       <arg choice="opt"><option>--host=</option><replaceable class="option">mpd_host</replaceable></arg>
  72       <arg choice="opt"><option>--mpd_port=</option><replaceable class="option">mpd_port</replaceable></arg>
  73     </cmdsynopsis>
  74     <cmdsynopsis>
  75       <command>&dhpackage;</command>
  76       <arg choice="opt"><option>--var_dir=</option><replaceable class="option">var_directory</replaceable></arg>
  77       <arg choice="opt"><option>--create-db></option></arg>
  78     </cmdsynopsis>
  79     <cmdsynopsis>
  80       <command>&dhpackage;</command>
  81       <!-- Normally the help and version options make the programs stop
  82            right after outputting the requested information. -->
  83       <group choice="opt">
  84         <arg choice="plain">
  85           <group choice="req">
  86             <arg choice="plain"><option>-h</option></arg>
  87             <arg choice="plain"><option>--help</option></arg>
  88           </group>
  89         </arg>
  90         <arg choice="plain"><option>--version</option></arg>
  91       </group>
  92     </cmdsynopsis>
  93   </refsynopsisdiv>
  94   <refsect1 id="description">
  95     <title>DESCRIPTION</title>
  96     <para>This manual page documents briefly the
  97       <command>&dhpackage;</command> commands.</para>
  98     <para>At start up default configuration is first overridden by user
  99         configuration in mpd_sima.cfg (see <xref linkend="files"/>) and finally
 100         command lines options are honored. For instance you can override
 101         default MPD_HOST set in defaults (localhost) or in your configuration
 102         file with <command>-S my_mpd_server</command> option. For default
 103         configuration see <xref linkend="configuration"/>. See also environment
 104         variables special case for MPD host and port in <xref linkend="environment"/>.
 105     </para>
 106   </refsect1>
 107     <refsect1 id="example">
 108         <title>EXAMPLE</title>
 109         <refsect2 id="daemon">
 110             <title>Launch as a system service (dæmon).</title>
 111             <para>Here follows an example on how to launch &dhpackage; as a service on your system, not attach to regular user configuration/database.</para>
 112             <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>
 113         </refsect2>
 114         <refsect2 id="user_land">
 115             <title>Launch in user land</title>
 116             <para>Launching &dhpackage; from/whithin your user account is easy, you can simply call <command>&dhpackage;</command> from your shell or one of the following command:</para>
 117             <para>Background execution (dæmonise), log in the specified file, save pid:</para>
 118             <para><command>&dhpackage; --daemon --pid=$HOME/var/run/mpd-sima.pid --log=$HOME/var/log/mpd-sima.log</command></para>
 119             <para>Foreground execution, connect <emphasis>my.mpd.server.org</emphasis>, log to std(out|err):</para>
 120             <para><command>&dhpackage; --host=my.mpd.server.org</command></para>
 121         </refsect2>
 122     </refsect1>
 123   <refsect1 id="options">
 124     <title>OPTIONS</title>
 125     <para>The program follows the usual GNU command line syntax,
 126       with long options starting with two dashes (`-').  A summary of
 127       options is included below.</para>
 128     <variablelist>
 129       <!-- Use the variablelist.term.separator and the
 130            variablelist.term.break.after parameters to
 131            control the term elements. -->
 132            <varlistentry> <!-- help -->
 133             <term><option>-h</option></term>
 134             <term><option>--help</option></term>
 135             <listitem>
 136                 <para>Print help and exit.</para>
 137             </listitem>
 138         </varlistentry>
 139         <varlistentry> <!-- version -->
 140             <term><option>--version</option></term>
 141             <listitem>
 142                 <para>Print version and exit.</para>
 143             </listitem>
 144         </varlistentry>
 145         <varlistentry> <!-- daemon -->
 146             <term><option>--daemon</option></term>
 147             <listitem>
 148                 <para>Start as a daemon. Log redirected to /dev/null, usually setting <option>--log</option> and <option>--pid</option> options in daemon mode are a good idea to monitor/stop the process.</para>
 149             </listitem>
 150         </varlistentry>
 151         <varlistentry> <!-- pid_file -->
 152             <term><option>-p <replaceable class="parameter">pid_file</replaceable></option></term>
 153             <term><option>--pid=<replaceable class="parameter">pid_file</replaceable></option></term>
 154             <listitem>
 155                 <para>Use the specific file <replaceable>pid_file</replaceable> to store pid to.<sbr />Default is not to store pid info.</para>
 156             </listitem>
 157         </varlistentry>
 158         <varlistentry> <!-- log -->
 159             <term><option>-l <replaceable class="parameter">log_file</replaceable></option></term>
 160             <term><option>--log=<replaceable class="parameter">log_file</replaceable></option></term>
 161             <listitem>
 162                 <para>Use the specific file <replaceable>log_file</replaceable> to log messages to.<sbr />Default is to log to stdout/stderr.</para>
 163             </listitem>
 164         </varlistentry>
 165         <varlistentry> <!-- log-level -->
 166             <term><option>-v <replaceable class="parameter">log_level</replaceable></option></term>
 167             <term><option>--log-level=<replaceable class="parameter">log_level</replaceable></option></term>
 168             <listitem>
 169                 <para>Verbosity in [debug,info,warning,error].<sbr />Default is to log info messages.</para>
 170             </listitem>
 171         </varlistentry>
 172         <varlistentry><!-- config -->
 173             <term><option>-c <replaceable class="parameter">conf_file</replaceable></option></term>
 174             <term><option>--config=<replaceable class="parameter">conf_file</replaceable></option></term>
 175             <listitem>
 176                 <para>Use the specific file <replaceable>conf_file</replaceable> to set up
 177                     configuration instead of looking for the default user
 178                     configuration file.<sbr />Default is to look for
 179                     <envar>$XDG_CONFIG_HOME/mpd_sima/mpd_sima.cfg</envar>.<sbr />
 180                     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 />
 181                     For more details on configuration file cf.
 182                     <citerefentry><refentrytitle>mpd_sima.cfg</refentrytitle>
 183                 <manvolnum>5</manvolnum></citerefentry>, see also <xref linkend="files"/>.<sbr />
 184                    </para>
 185             </listitem>
 186         </varlistentry>
 187         <varlistentry> <!-- var_dir -->
 188             <term><option>--var_dir=<replaceable class="parameter">var_directory</replaceable></option></term>
 189             <listitem>
 190                 <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>
 191             </listitem>
 192         </varlistentry>
 193         <varlistentry> <!-- create-db -->
 194             <term><option>--create-db</option></term>
 195             <listitem>
 196                 <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>
 197             </listitem>
 198         </varlistentry>
 199         <varlistentry><!-- host -->
 200             <term><option>-S <replaceable class="parameter">mpd_host</replaceable></option></term>
 201             <term><option>--host=<replaceable class="parameter">mpd_host</replaceable></option></term>
 202             <listitem>
 203                 <para>Use the specific host <replaceable>mpd_host</replaceable> as MPD server.<sbr /><replaceable>mpd_host</replaceable> can be an <acronym>IP</acronym> or a fully qualified domain name as long as your system can resolve it. This overrides <envar>MPD_HOST</envar> environment variable.<sbr />Default is <emphasis>localhost</emphasis>.</para>
 204                 <para>See also <xref linkend="environment"/>.</para>
 205             </listitem>
 206         </varlistentry>
 207         <varlistentry><!-- port -->
 208             <term><option>-P <replaceable class="parameter">mpd_port</replaceable></option></term>
 209             <term><option>--port=<replaceable class="parameter">mpd_port</replaceable></option></term>
 210             <listitem>
 211                 <para>Use the specific port number <replaceable>mpd_port</replaceable> on MPD server. This overrides <envar>MPD_PORT</envar> environment variable.<sbr />Default is <emphasis>6600</emphasis>.</para>
 212                 <para>See also <xref linkend="environment"/></para>
 213             </listitem>
 214         </varlistentry>
 215     </variablelist>
 216   </refsect1>
 217   <xi:include href="files.xml" />
 218   <refsect1 id="environment">
 219       <title>ENVIRONMENT</title>
 220       <variablelist>
 221           <varlistentry>
 222               <term><envar>MPD_HOST</envar>, <envar>MPD_PORT</envar></term>
 223               <listitem>
 224                   <para>&dhutils; will look for <envar>MPD_HOST</envar> and
 225                       <envar>MPD_PORT</envar> to override built-in configuration
 226                       (set to "localhost:6600").</para>
 227                   <para>&dhutils; expects <envar>MPD_HOST</envar> syntax as documented in mpc manual,
 228                       cf. <citerefentry><refentrytitle>mpc</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
 229                       <sbr/>To use a password, provide a value of the form "password@host".
 230                   </para>
 231               </listitem>
 232           </varlistentry>
 233       </variablelist>
 234   </refsect1>
 235   <refsect1 id="configuration">
 236       <title>CONFIGURATION</title>
 237       <variablelist>
 238           <varlistentry>
 239               <term><filename>mpd_sima.cfg</filename></term>
 240               <listitem>
 241                   <para><filename>mpd_sima.cfg</filename> is read if present.
 242                       Otherwise built-in defaults are used. An example should be
 243                       provided in the tarball within
 244                       <filename>doc/examples/</filename>. On Debian
 245                       system please look in
 246                       <filename>/usr/share/doc/&dhpackage;</filename>.</para>
 247               </listitem>
 248           </varlistentry>
 249           <varlistentry>
 250               <term>DEFAULTS</term>
 251               <listitem>
 252                   <para>Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env. var. if set).</para>
 253                         <para>The default behavior is to add one track,
 254                             this track is to be chosen among titles from
 255                             artists similar to the artist of the currently
 256                             played track. MPD_sima will add one track when the
 257                             unplayed queue is one track long.</para>
 258                   <para>To change these defaults, use the configuration file <filename>mpd_sima.cfg</filename></para>
 259               </listitem>
 260           </varlistentry>
 261       </variablelist>
 262       <para>For details about mpd_sima.cfg refer to the manual
 263           <citerefentry>
 264               <refentrytitle>mpd_sima.cfg</refentrytitle>
 265               <manvolnum>5</manvolnum>
 266           </citerefentry>
 267       </para>
 268   </refsect1>
 269   <xi:include href="feedback.xml" />
 270   <xi:include href="seealso.xml" />
 271 </refentry>