Switch to unified view

a/doc/upmpdcli.html b/doc/upmpdcli.html
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4
<head>
4
<head>
5
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
5
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
6
<meta name="generator" content="AsciiDoc 8.6.7" />
6
<meta name="generator" content="AsciiDoc 8.6.9" />
7
<title>Upmpdcli: MPD UPnP Renderer Front-End</title>
7
<title>Upmpdcli: MPD UPnP Renderer Front-End</title>
8
<style type="text/css">
8
<style type="text/css">
9
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
9
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
10
11
/* Default font. */
11
/* Default font. */
...
...
85
  margin-top: 0;
85
  margin-top: 0;
86
}
86
}
87
ul > li     { color: #aaa; }
87
ul > li     { color: #aaa; }
88
ul > li > * { color: black; }
88
ul > li > * { color: black; }
89
89
90
pre {
90
.monospaced, code, pre {
91
  font-family: "Courier New", Courier, monospace;
92
  font-size: inherit;
93
  color: navy;
91
  padding: 0;
94
  padding: 0;
92
  margin: 0;
95
  margin: 0;
96
}
97
pre {
98
  white-space: pre-wrap;
93
}
99
}
94
100
95
#author {
101
#author {
96
  color: #527bbd;
102
  color: #527bbd;
97
  font-weight: bold;
103
  font-weight: bold;
...
...
217
  border-left: 3px solid #dddddd;
223
  border-left: 3px solid #dddddd;
218
  padding-left: 0.5em;
224
  padding-left: 0.5em;
219
}
225
}
220
226
221
div.imageblock div.content { padding-left: 0; }
227
div.imageblock div.content { padding-left: 0; }
222
span.image img { border-style: none; }
228
span.image img { border-style: none; vertical-align: text-bottom; }
223
a.image:visited { color: white; }
229
a.image:visited { color: white; }
224
230
225
dl {
231
dl {
226
  margin-top: 0.8em;
232
  margin-top: 0.8em;
227
  margin-bottom: 0.8em;
233
  margin-bottom: 0.8em;
...
...
413
/*
419
/*
414
 * xhtml11 specific
420
 * xhtml11 specific
415
 *
421
 *
416
 * */
422
 * */
417
423
418
tt {
419
  font-family: "Courier New", Courier, monospace;
420
  font-size: inherit;
421
  color: navy;
422
}
423
424
div.tableblock {
424
div.tableblock {
425
  margin-top: 1.0em;
425
  margin-top: 1.0em;
426
  margin-bottom: 1.5em;
426
  margin-bottom: 1.5em;
427
}
427
}
428
div.tableblock > table {
428
div.tableblock > table {
...
...
451
451
452
/*
452
/*
453
 * html5 specific
453
 * html5 specific
454
 *
454
 *
455
 * */
455
 * */
456
457
.monospaced {
458
  font-family: "Courier New", Courier, monospace;
459
  font-size: inherit;
460
  color: navy;
461
}
462
456
463
table.tableblock {
457
table.tableblock {
464
  margin-top: 1.0em;
458
  margin-top: 1.0em;
465
  margin-bottom: 1.5em;
459
  margin-bottom: 1.5em;
466
}
460
}
...
...
537
}
531
}
538
532
539
@media print {
533
@media print {
540
  body.manpage div#toc { display: none; }
534
  body.manpage div#toc { display: none; }
541
}
535
}
536
537
542
</style>
538
</style>
543
<script type="text/javascript">
539
<script type="text/javascript">
544
/*<![CDATA[*/
540
/*<![CDATA[*/
545
var asciidoc = {  // Namespace.
541
var asciidoc = {  // Namespace.
546
542
...
...
760
<div class="sectionbody">
756
<div class="sectionbody">
761
<div class="paragraph"><p>See the man page for command line details. In most situations, <strong>upmpdcli</strong>
757
<div class="paragraph"><p>See the man page for command line details. In most situations, <strong>upmpdcli</strong>
762
will be run as follows:</p></div>
758
will be run as follows:</p></div>
763
<div class="literalblock">
759
<div class="literalblock">
764
<div class="content">
760
<div class="content">
765
<pre><tt>upmpdcli -D -c /etc/upmpdcli.conf</tt></pre>
761
<pre><code>upmpdcli -D -c /etc/upmpdcli.conf</code></pre>
766
</div></div>
762
</div></div>
767
<div class="paragraph"><p>The <tt>-D</tt> option tells <strong>upmpdcli</strong> to fork and run in background. The <tt>-c</tt>
763
<div class="paragraph"><p>The <code>-D</code> option tells <strong>upmpdcli</strong> to fork and run in background. The <code>-c</code>
768
option specifies a configuration file.</p></div>
764
option specifies a configuration file.</p></div>
769
<div class="paragraph"><p>The configuration file has a simple <tt>name = value</tt> format.</p></div>
765
<div class="paragraph"><p>The configuration file has a simple <code>name = value</code> format.</p></div>
770
<div class="paragraph"><p>The configuration parameters can be set from the command line, a
766
<div class="paragraph"><p>The configuration parameters can be set from the command line, a
771
configuration file, or the environment in this order of priority. It would
767
configuration file, or the environment in this order of priority. It would
772
be rather confusing to use a mix of methods, so you should probably chose
768
be rather confusing to use a mix of methods, so you should probably chose
773
one.</p></div>
769
one.</p></div>
774
<div class="paragraph"><p>All parameters have defaults, and a typical installation needs no
770
<div class="paragraph"><p>All parameters have defaults, and a typical installation needs no
...
...
883
</div>
879
</div>
884
</div>
880
</div>
885
<div class="sect1">
881
<div class="sect1">
886
<h2 id="upmpdcli.boot">Boot time startup</h2>
882
<h2 id="upmpdcli.boot">Boot time startup</h2>
887
<div class="sectionbody">
883
<div class="sectionbody">
888
<div class="paragraph"><p><strong>upmpdcli</strong> will try to change its <tt>uid</tt> to user <tt>upmpdcli</tt> if it is
884
<div class="paragraph"><p><strong>upmpdcli</strong> will try to change its <code>uid</code> to user <code>upmpdcli</code> if it is
889
started by root. It will refuse to run if the user does not exist.</p></div>
885
started by root. It will refuse to run if the user does not exist.</p></div>
890
<div class="paragraph"><p>If started by <tt>root</tt>, <strong>upmpdcli</strong> will also write its process id to
886
<div class="paragraph"><p>If started by <code>root</code>, <strong>upmpdcli</strong> will also write its process id to
891
<tt>/var/run/upmpdcli.pid</tt>.</p></div>
887
<code>/var/run/upmpdcli.pid</code>.</p></div>
892
<div class="paragraph"><p>There are boot-time startup scripts in the <tt>debian/</tt> directory inside the
888
<div class="paragraph"><p>There are boot-time startup scripts in the <code>debian/</code> directory inside the
893
source tree (for Debian/Ubuntu/Mint/Raspbian etc.). There is also a systemd
889
source tree (for Debian/Ubuntu/Mint/Raspbian etc.). There is also a systemd
894
service file under <tt>systemd/</tt> (for Fedora et al.).</p></div>
890
service file under <code>systemd/</code> (for Fedora et al.).</p></div>
895
<div class="paragraph"><p>The boot scripts are installed by the pre-built packages, so will just have
891
<div class="paragraph"><p>The boot scripts are installed by the pre-built packages, so will just have
896
to edit the configuration file after installing them, all the rest should
892
to edit the configuration file after installing them, all the rest should
897
just work.</p></div>
893
just work.</p></div>
898
</div>
894
</div>
899
</div>
895
</div>
900
<div class="sect1">
896
<div class="sect1">
901
<h2 id="upmpdcli.building">Building</h2>
897
<h2 id="upmpdcli.building">Building</h2>
902
<div class="sectionbody">
898
<div class="sectionbody">
903
<div class="paragraph"><p>For building from source, you will need a recent <tt>C++</tt> compiler (<tt>C++11</tt>),
899
<div class="paragraph"><p>For building from source, you will need a recent <code>C++</code> compiler (<code>C++11</code>),
904
and the development packages for <strong>libupnp</strong> version 1.6, and <strong>libmpdclient</strong>.</p></div>
900
and the development packages for <strong>libupnp</strong> version 1.6, <strong>libmpdclient</strong>, and
901
<strong>libexpat</strong>.</p></div>
905
<div class="paragraph"><p>If you are using the source from Github, you will also need the
902
<div class="paragraph"><p>If you are using the source from Github, you will also need the
906
autoconf/automake/libtool trio. Use the <tt>autogen.sh</tt> script to set things
903
autoconf/automake/libtool trio. Use the <code>autogen.sh</code> script to set things
907
up.</p></div>
904
up.</p></div>
908
<div class="paragraph"><p>Otherwise, the procedure is standard and there are currently no specific
905
<div class="paragraph"><p>Otherwise, the procedure is standard and there are currently no specific
909
configure options:</p></div>
906
configure options:</p></div>
910
<div class="literalblock">
907
<div class="literalblock">
911
<div class="content">
908
<div class="content">
912
<pre><tt>configure --prefix=/usr
909
<pre><code>configure --prefix=/usr
913
make
910
make
914
sudo make install</tt></pre>
911
sudo make install</code></pre>
915
</div></div>
912
</div></div>
916
</div>
913
</div>
917
</div>
914
</div>
918
</div>
915
</div>
919
<div id="footnotes"><hr /></div>
916
<div id="footnotes"><hr /></div>
920
<div id="footer">
917
<div id="footer">
921
<div id="footer-text">
918
<div id="footer-text">
922
Last updated 2014-05-25 09:43:40 CEST
919
Last updated 2014-07-14 14:11:50 CEST
923
</div>
920
</div>
924
</div>
921
</div>
925
</body>
922
</body>
926
</html>
923
</html>