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="plain">--create-db</arg>
  77       <arg choice="opt"><option>--var-dir=</option><replaceable class="option">var_directory</replaceable></arg>
  78     </cmdsynopsis>
  79     <cmdsynopsis>
  80       <command>&dhpackage;</command>
  81       <arg choice="plain">--generate-config</arg>
  82       <arg choice="opt"><option>…</option></arg>
  83     </cmdsynopsis>
  84     <cmdsynopsis>
  85       <command>&dhpackage;</command>
  86       <!-- Normally the help and version options make the programs stop
  87            right after outputting the requested information. -->
  88       <group choice="plain">
  89         <arg choice="req">
  90           <group choice="req">
  91             <arg choice="plain"><option>-h</option></arg>
  92             <arg choice="plain"><option>--help</option></arg>
  93           </group>
  94           <arg choice="plain"><option>--version</option></arg>
  95         </arg>
  96       </group>
  97     </cmdsynopsis>
  98   </refsynopsisdiv>
  99   <refsect1 id="description">
 100     <title>DESCRIPTION</title>
 101     <para>This manual page documents briefly the
 102       <command>&dhpackage;</command> commands.</para>
 103     <para>At start up default configuration is first overridden by user
 104         configuration in mpd_sima.cfg (see <xref linkend="files"/>) and finally
 105         command lines options are honored. For instance you can override
 106         default MPD_HOST set in defaults (localhost) or in your configuration
 107         file with <command>-S my_mpd_server</command> option. For default
 108         configuration see <xref linkend="configuration"/>. See also environment
 109         variables special case for MPD host and port in <xref linkend="environment"/>.
 110     </para>
 111   </refsect1>
 112     <refsect1 id="example">
 113         <title>EXAMPLE</title>
 114         <refsect2 id="daemon">
 115             <title>Launch as a system service (dæmon).</title>
 116             <para>Here follows an example on how to launch &dhpackage; as a service on your system, not attach to regular user configuration/database.</para>
 117             <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>
 118         </refsect2>
 119         <refsect2 id="user_land">
 120             <title>Launch in user land</title>
 121             <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>
 122             <para>Background execution (dæmonise), log in the specified file, save pid:</para>
 123             <para><command>&dhpackage; --daemon --pid=$HOME/var/run/mpd-sima.pid --log=$HOME/var/log/mpd-sima.log</command></para>
 124             <para>Foreground execution, connect <emphasis>my.mpd.server.org</emphasis>, log to std(out|err):</para>
 125             <para><command>&dhpackage; --host=my.mpd.server.org</command></para>
 126         </refsect2>
 127     </refsect1>
 128   <refsect1 id="options">
 129     <title>OPTIONS</title>
 130     <para>The program follows the usual GNU command line syntax,
 131       with long options starting with two dashes (`-').  A summary of
 132       options is included below.</para>
 133     <variablelist>
 134       <!-- Use the variablelist.term.separator and the
 135            variablelist.term.break.after parameters to
 136            control the term elements. -->
 137            <varlistentry> <!-- help -->
 138             <term><option>-h</option></term>
 139             <term><option>--help</option></term>
 140             <listitem>
 141                 <para>Print help and exit.</para>
 142             </listitem>
 143         </varlistentry>
 144         <varlistentry> <!-- version -->
 145             <term><option>--version</option></term>
 146             <listitem>
 147                 <para>Print version and exit.</para>
 148             </listitem>
 149         </varlistentry>
 150         <varlistentry> <!-- daemon -->
 151             <term><option>--daemon</option></term>
 152             <listitem>
 153                 <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>
 154             </listitem>
 155         </varlistentry>
 156         <varlistentry> <!-- pid_file -->
 157             <term><option>-p <replaceable class="parameter">pid_file</replaceable></option></term>
 158             <term><option>--pid=<replaceable class="parameter">pid_file</replaceable></option></term>
 159             <listitem>
 160                 <para>Use the specific file <replaceable>pid_file</replaceable> to store pid to.<sbr />Default is not to store pid info.</para>
 161             </listitem>
 162         </varlistentry>
 163         <varlistentry> <!-- log -->
 164             <term><option>-l <replaceable class="parameter">log_file</replaceable></option></term>
 165             <term><option>--log=<replaceable class="parameter">log_file</replaceable></option></term>
 166             <listitem>
 167                 <para>Use the specific file <replaceable>log_file</replaceable> to log messages to.<sbr />Default is to log to stdout/stderr.</para>
 168             </listitem>
 169         </varlistentry>
 170         <varlistentry> <!-- log-level -->
 171             <term><option>-v <replaceable class="parameter">log_level</replaceable></option></term>
 172             <term><option>--log-level=<replaceable class="parameter">log_level</replaceable></option></term>
 173             <listitem>
 174                 <para>Verbosity in [debug,info,warning,error].<sbr />Default is to log info messages.</para>
 175             </listitem>
 176         </varlistentry>
 177         <varlistentry><!-- config -->
 178             <term><option>-c <replaceable class="parameter">conf_file</replaceable></option></term>
 179             <term><option>--config=<replaceable class="parameter">conf_file</replaceable></option></term>
 180             <listitem>
 181                 <para>Use the specific file <replaceable>conf_file</replaceable> to set up
 182                     configuration instead of looking for the default user
 183                     configuration file.<sbr />Default is to look for
 184                     <envar>$XDG_CONFIG_HOME/mpd_sima/mpd_sima.cfg</envar>.<sbr />
 185                     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 />
 186                     For more details on configuration file cf.
 187                     <citerefentry><refentrytitle>mpd_sima.cfg</refentrytitle>
 188                 <manvolnum>5</manvolnum></citerefentry>, see also <xref linkend="files"/>.<sbr />
 189                    </para>
 190             </listitem>
 191         </varlistentry>
 192         <varlistentry> <!-- var-dir -->
 193             <term><option>--var-dir=<replaceable class="parameter">var_directory</replaceable></option></term>
 194             <listitem>
 195                 <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>
 196             </listitem>
 197         </varlistentry>
 198         <varlistentry> <!-- generate-config -->
 199             <term><option>--generate-config</option></term>
 200             <listitem>
 201                 <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>
 202             </listitem>
 203         </varlistentry>
 204         <varlistentry> <!-- create-db -->
 205             <term><option>--create-db</option></term>
 206             <listitem>
 207                 <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>
 208             </listitem>
 209         </varlistentry>
 210         <varlistentry><!-- host -->
 211             <term><option>-S <replaceable class="parameter">mpd_host</replaceable></option></term>
 212             <term><option>--host=<replaceable class="parameter">mpd_host</replaceable></option></term>
 213             <listitem>
 214                 <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>
 215                 <para>See also <xref linkend="environment"/>.</para>
 216             </listitem>
 217         </varlistentry>
 218         <varlistentry><!-- port -->
 219             <term><option>-P <replaceable class="parameter">mpd_port</replaceable></option></term>
 220             <term><option>--port=<replaceable class="parameter">mpd_port</replaceable></option></term>
 221             <listitem>
 222                 <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>
 223                 <para>See also <xref linkend="environment"/></para>
 224             </listitem>
 225         </varlistentry>
 226     </variablelist>
 227   </refsect1>
 228   <xi:include href="files.xml" />
 229   <refsect1 id="environment">
 230       <title>ENVIRONMENT</title>
 231       <variablelist>
 232           <varlistentry>
 233               <term><envar>MPD_HOST</envar>, <envar>MPD_PORT</envar></term>
 234               <listitem>
 235                   <para>&dhutils; will look for <envar>MPD_HOST</envar> and
 236                       <envar>MPD_PORT</envar> to override built-in configuration
 237                       (set to "localhost:6600").</para>
 238                   <para>&dhutils; expects <envar>MPD_HOST</envar> syntax as documented in mpc manual,
 239                       cf. <citerefentry><refentrytitle>mpc</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
 240                       <sbr/>To use a password, provide a value of the form "password@host".
 241                   </para>
 242               </listitem>
 243           </varlistentry>
 244       </variablelist>
 245   </refsect1>
 246   <refsect1 id="configuration">
 247       <title>CONFIGURATION</title>
 248       <variablelist>
 249           <varlistentry>
 250               <term><filename>mpd_sima.cfg</filename></term>
 251               <listitem>
 252                   <para><filename>mpd_sima.cfg</filename> is read if present.
 253                       Otherwise built-in defaults are used. An example should be
 254                       provided in the tarball within
 255                       <filename>doc/examples/</filename>. On Debian
 256                       system please look in
 257                       <filename>/usr/share/doc/&dhpackage;</filename>.</para>
 258               </listitem>
 259           </varlistentry>
 260           <varlistentry>
 261               <term>DEFAULTS</term>
 262               <listitem>
 263                   <para>Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env. var. if set).</para>
 264                   <para>The get the defaults as detected by &dhpackage; on your system you can run &dhpackage; to print the config:</para>
 265                   <para><command>&dhpackage; --generate-config</command></para>
 266               </listitem>
 267           </varlistentry>
 268       </variablelist>
 269       <para>For details about mpd_sima.cfg refer to the manual
 270           <citerefentry>
 271               <refentrytitle>mpd_sima.cfg</refentrytitle>
 272               <manvolnum>5</manvolnum>
 273           </citerefentry>
 274       </para>
 275   </refsect1>
 276   <xi:include href="feedback.xml" />
 277   <xi:include href="seealso.xml" />
 278 </refentry>