data/man/mpd_sima.1.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>mpd-sima</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="idm1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>mpd-sima &#8212; mpd-sima will try to maintain some titles ahead in the queue following different policies.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">mpd-sima</code>  [<code class="option">--daemon</code>] [<code class="option">--config=</code><em class="replaceable"><code>conf_file</code></em>] [<code class="option">--var-dir=</code><em class="replaceable"><code>var_directory</code></em>] [<code class="option">--pid=</code><em class="replaceable"><code>pid_file</code></em>] [<code class="option">--log=</code><em class="replaceable"><code>log_file</code></em>] [<code class="option">--log-level=</code><em class="replaceable"><code>log_level</code></em>] [<code class="option">--host=</code><em class="replaceable"><code>mpd_host</code></em>] [<code class="option">--mpd_port=</code><em class="replaceable"><code>mpd_port</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">mpd-sima</code>   --create-db  [<code class="option">--var-dir=</code><em class="replaceable"><code>var_directory</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">mpd-sima</code>   --generate-config  [<code class="option">&#8230;</code>]</p></div><div class="cmdsynopsis"><p><code class="command">mpd-sima</code>   {
   2           { <code class="option">-h</code>  |   <code class="option">--help</code> }
   3             <code class="option">--version</code>
   4         } </p></div></div><div class="refsect1"><a name="description"></a><h2>DESCRIPTION</h2><p>This manual page documents briefly the
   5       <span class="command"><strong>mpd-sima</strong></span> commands.</p><p>At start up default configuration is first overridden by user
   6         configuration in mpd_sima.cfg (see <a class="xref" href="#files" title="FILES">the section called &#8220;FILES&#8221;</a>) and finally
   7         command lines options are honored. For instance you can override
   8         default MPD_HOST set in defaults (localhost) or in your configuration
   9         file with <span class="command"><strong>-S my_mpd_server</strong></span> option. For default
  10         configuration see <a class="xref" href="#configuration" title="CONFIGURATION">the section called &#8220;CONFIGURATION&#8221;</a>. See also environment
  11         variables special case for MPD host and port in <a class="xref" href="#environment" title="ENVIRONMENT">the section called &#8220;ENVIRONMENT&#8221;</a>.
  12     </p></div><div class="refsect1"><a name="example"></a><h2>EXAMPLE</h2><div class="refsect2"><a name="daemon"></a><h3>Launch as a system service (dæmon).</h3><p>Here follows an example on how to launch mpd-sima as a service on your system, not attach to regular user configuration/database.</p><p><span class="command"><strong>mpd-sima --daemon --conf=/etc/mpd_sima.cfg --var-dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log</strong></span></p></div><div class="refsect2"><a name="user_land"></a><h3>Launch in user land</h3><p>Launching mpd-sima from/whithin your user account is easy, you can simply call <span class="command"><strong>mpd-sima</strong></span> from your shell or one of the following command:</p><p>Background execution (dæmonise), log in the specified file, save pid:</p><p><span class="command"><strong>mpd-sima --daemon --pid=$HOME/var/run/mpd-sima.pid --log=$HOME/var/log/mpd-sima.log</strong></span></p><p>Foreground execution, connect <span class="emphasis"><em>my.mpd.server.org</em></span>, log to std(out|err):</p><p><span class="command"><strong>mpd-sima --host=my.mpd.server.org</strong></span></p></div></div><div class="refsect1"><a name="options"></a><h2>OPTIONS</h2><p>The program follows the usual GNU command line syntax,
  13       with long options starting with two dashes (`-').  A summary of
  14       options is included below.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p>Print help and exit.</p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p>Print version and exit.</p></dd><dt><span class="term"><code class="option">--daemon</code></span></dt><dd><p>Start as a daemon. Log redirected to /dev/null, usually setting <code class="option">--log</code> and <code class="option">--pid</code> options in daemon mode are a good idea to monitor/stop the process.</p></dd><dt><span class="term"><code class="option">-p <em class="replaceable"><code>pid_file</code></em></code>, </span><span class="term"><code class="option">--pid=<em class="replaceable"><code>pid_file</code></em></code></span></dt><dd><p>Use the specific file <em class="replaceable"><code>pid_file</code></em> to store pid to.<br>Default is not to store pid info.</p></dd><dt><span class="term"><code class="option">-l <em class="replaceable"><code>log_file</code></em></code>, </span><span class="term"><code class="option">--log=<em class="replaceable"><code>log_file</code></em></code></span></dt><dd><p>Use the specific file <em class="replaceable"><code>log_file</code></em> to log messages to.<br>Default is to log to stdout/stderr.</p></dd><dt><span class="term"><code class="option">-v <em class="replaceable"><code>log_level</code></em></code>, </span><span class="term"><code class="option">--log-level=<em class="replaceable"><code>log_level</code></em></code></span></dt><dd><p>Verbosity in [debug,info,warning,error].<br>Default is to log info messages.</p></dd><dt><span class="term"><code class="option">-c <em class="replaceable"><code>conf_file</code></em></code>, </span><span class="term"><code class="option">--config=<em class="replaceable"><code>conf_file</code></em></code></span></dt><dd><p>Use the specific file <em class="replaceable"><code>conf_file</code></em> to set up
  15                     configuration instead of looking for the default user
  16                     configuration file.<br>Default is to look for
  17                     <code class="envar">$XDG_CONFIG_HOME/mpd_sima/mpd_sima.cfg</code>.<br>
  18                     CLI option overrides any equivalent mentioned in configuration file, ie. launching mpd-sima with '<code class="option">--port</code>' CLI option will ignore port setting in configuration file.<br>
  19                     For more details on configuration file cf.
  20                     <span class="citerefentry"><span class="refentrytitle">mpd_sima.cfg</span>(5)</span>, see also <a class="xref" href="#files" title="FILES">the section called &#8220;FILES&#8221;</a>.<br>
  21                    </p></dd><dt><span class="term"><code class="option">--var-dir=<em class="replaceable"><code>var_directory</code></em></code></span></dt><dd><p>Use the specific path <em class="replaceable"><code>var_directory</code></em> to look for (or create) var files (ie. database) instead of looking at the default user data location.<br>Default is to look in <code class="envar">$XDG_DATA_HOME/mpd_sima/</code>.  Concerning <code class="envar">$XDG_DATA_HOME</code> see also <a class="xref" href="#files" title="FILES">the section called &#8220;FILES&#8221;</a></p></dd><dt><span class="term"><code class="option">--generate-config</code></span></dt><dd><p>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.</p></dd><dt><span class="term"><code class="option">--create-db</code></span></dt><dd><p>Create the database and exit. Uses folder specified with <code class="option">--var-dir</code> or default directory.<br>Default is to use <code class="envar">$XDG_DATA_HOME/mpd_sima/</code>.  Concerning <code class="envar">$XDG_DATA_HOME</code> see also <a class="xref" href="#files" title="FILES">the section called &#8220;FILES&#8221;</a></p></dd><dt><span class="term"><code class="option">-S <em class="replaceable"><code>mpd_host</code></em></code>, </span><span class="term"><code class="option">--host=<em class="replaceable"><code>mpd_host</code></em></code></span></dt><dd><p>Use the specific host <em class="replaceable"><code>mpd_host</code></em> as MPD server.<br><em class="replaceable"><code>mpd_host</code></em> can be an <acronym class="acronym">IP</acronym> or a fully qualified domain name as long as your system can resolve it. This overrides <code class="envar">MPD_HOST</code> environment variable.<br>Default is <span class="emphasis"><em>localhost</em></span>.</p><p>See also <a class="xref" href="#environment" title="ENVIRONMENT">the section called &#8220;ENVIRONMENT&#8221;</a>.</p></dd><dt><span class="term"><code class="option">-P <em class="replaceable"><code>mpd_port</code></em></code>, </span><span class="term"><code class="option">--port=<em class="replaceable"><code>mpd_port</code></em></code></span></dt><dd><p>Use the specific port number <em class="replaceable"><code>mpd_port</code></em> on MPD server. This overrides <code class="envar">MPD_PORT</code> environment variable.<br>Default is <span class="emphasis"><em>6600</em></span>.</p><p>See also <a class="xref" href="#environment" title="ENVIRONMENT">the section called &#8220;ENVIRONMENT&#8221;</a></p></dd></dl></div></div><div class="refsect1"><a name="files"></a><h2>FILES</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="filename">${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg</code></span></dt><dd><p>Configuration file.</p></dd><dt><span class="term"><code class="filename">${XDG_DATA_HOME}/mpd_sima/sima.db</code></span></dt><dd><p>SQLite DB file.</p></dd><dt><span class="term"><code class="filename">${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/</code></span></dt><dd><p>Persistent http cache.</p></dd></dl></div><p>Usually <code class="envar">XDG_DATA_HOME</code> is set to
  22             <code class="filename">${HOME}/.local/share</code> and <code class="envar">XDG_CONFIG_HOME</code> to
  23             <code class="filename">${HOME}/.config</code>.<br>You may override them using
  24             command line option <code class="option">--var-dir</code> and <code class="option">--config</code> (cf.
  25             <span class="citerefentry"><span class="refentrytitle">mpd-sima</span>(1)</span>)</p></div><div class="refsect1"><a name="environment"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="envar">MPD_HOST</code>, <code class="envar">MPD_PORT</code></span></dt><dd><p>mpd-sima will look for <code class="envar">MPD_HOST</code> and
  26                       <code class="envar">MPD_PORT</code> to override built-in configuration
  27                       (set to "localhost:6600").</p><p>mpd-sima expects <code class="envar">MPD_HOST</code> syntax as documented in mpc manual,
  28                       cf. <span class="citerefentry"><span class="refentrytitle">mpc</span>(1)</span>.
  29                       <br>To use a password, provide a value of the form "password@host".
  30                   </p></dd><dt><span class="term"><code class="envar">HTTP_PROXY</code>, <code class="envar">HTTPS_PROXY</code></span></dt><dd><p>mpd-sima honors <code class="envar">HTTP_PROXY</code> environment variables.</p></dd></dl></div></div><div class="refsect1"><a name="configuration"></a><h2>CONFIGURATION</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="filename">mpd_sima.cfg</code></span></dt><dd><p><code class="filename">mpd_sima.cfg</code> is read if present.
  31                       Otherwise built-in defaults are used. An example should be
  32                       provided in the tarball within
  33                       <code class="filename">doc/examples/</code>. On Debian
  34                       system please look in
  35                       <code class="filename">/usr/share/doc/mpd-sima</code>.</p></dd><dt><span class="term">DEFAULTS</span></dt><dd><p>Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env. var. if set).</p><p>The get the defaults as detected by mpd-sima on your system you can run mpd-sima to print the config:</p><p><span class="command"><strong>mpd-sima --generate-config</strong></span></p></dd></dl></div><p>For details about mpd_sima.cfg refer to the manual
  36           <span class="citerefentry"><span class="refentrytitle">mpd_sima.cfg</span>(5)</span>
  37       </p></div><div class="refsect1"><a name="feedback"></a><h2>FEEDBACK/BUGS</h2><p>The maintainer would be more than happy to ear from you, don't hesitate to send feedback, <a class="ulink" href="https://kaliko.me/contact/" target="_top">https://kaliko.me/contact/</a>.</p><p><acronym class="acronym">XMPP</acronym> users are welcome to join the dedicated chat room at <a class="ulink" href="kaliko.me@conf.azylum.org" target="_top">kaliko.me@conf.azylum.org</a>.</p></div><div class="refsect1"><a name="see_also"></a><h2>SEE ALSO</h2><p><span class="citerefentry"><span class="refentrytitle">mpc</span>(1)</span>, <span class="citerefentry"><span class="refentrytitle">mpd</span>(1)</span></p><p>
  38         <code class="filename">/usr/share/doc/mpd-sima/</code>
  39     </p></div></div></body></html>