<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.7" />
<title>Upmpdcli: MPD UPnP Renderer Front-End</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
/* Default font. */
body {
font-family: Georgia,serif;
}
/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
font-family: Arial,Helvetica,sans-serif;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
h5 {
font-size: 1.0em;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
pre {
padding: 0;
margin: 0;
}
#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}
#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
#footer-text {
float: left;
padding-bottom: 0.5em;
}
#footer-badges {
float: right;
padding-bottom: 0.5em;
}
#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #888;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
#footer-badges { display: none; }
}
#toc {
margin-bottom: 2.5em;
}
#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
div.unbreakable { page-break-inside: avoid; }
/*
* xhtml11 specific
*
* */
tt {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
}
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
/*
* html5 specific
*
* */
.monospaced {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
}
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
thead, p.tableblock.header {
font-weight: bold;
color: #527bbd;
}
p.tableblock {
margin-top: 0;
}
table.tableblock {
border-width: 3px;
border-spacing: 0px;
border-style: solid;
border-color: #527bbd;
border-collapse: collapse;
}
th.tableblock, td.tableblock {
border-width: 1px;
padding: 4px;
border-style: solid;
border-color: #527bbd;
}
table.tableblock.frame-topbot {
border-left-style: hidden;
border-right-style: hidden;
}
table.tableblock.frame-sides {
border-top-style: hidden;
border-bottom-style: hidden;
}
table.tableblock.frame-none {
border-style: hidden;
}
th.tableblock.halign-left, td.tableblock.halign-left {
text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
th.tableblock.valign-top, td.tableblock.valign-top {
vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
vertical-align: bottom;
}
/*
* manpage specific
*
* */
body.manpage h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
body.manpage h2 {
border-style: none;
}
body.manpage div.sectionbody {
margin-left: 3em;
}
@media print {
body.manpage div#toc { display: none; }
}
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>Upmpdcli: MPD UPnP Renderer Front-End</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p><strong>upmpdcli</strong> is an UPnP Media Renderer front-end to <strong>MPD</strong>, the Music Player
Daemon. It supports both pure UPnP and the OpenHome ohMedia services.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="upmpdcli.security">Security</h2>
<div class="sectionbody">
<div class="paragraph"><p><strong>upmpdcli</strong> is not audited for security issues, and, as far as I
know, it may be full of exploitable bugs. Do not run it on an
Internet-facing host.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="upmpdcli.config">Configuration</h2>
<div class="sectionbody">
<div class="paragraph"><p>See the man page for command line details. In most situations, <strong>upmpdcli</strong>
will be run as follows:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>upmpdcli -D -c /etc/upmpdcli.conf</tt></pre>
</div></div>
<div class="paragraph"><p>The <tt>-D</tt> option tells <strong>upmpdcli</strong> to fork and run in background. The <tt>-c</tt>
option specifies a configuration file.</p></div>
<div class="paragraph"><p>The configuration file has a simple <tt>name = value</tt> format.</p></div>
<div class="paragraph"><p>The configuration parameters can be set from the command line, a
configuration file, or the environment in this order of priority. It would
be rather confusing to use a mix of methods, so you should probably chose
one. Some less common parameters can only be set in the configuration file.</p></div>
<div class="paragraph"><p>All parameters have defaults, and a typical installation needs no
modification of the configuration file. If several instances of <strong>upmpdcli</strong>
run on the same network, you will want to give them distinct names
(<em>friendlyname</em> parameter). The other parameters are only useful in special
situations.</p></div>
<div class="paragraph"><p>The following parameters can be set:</p></div>
<div class="tableblock">
<table rules="all"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="25%" />
<col width="25%" />
<col width="25%" />
<col width="25%" />
<tbody>
<tr>
<td align="left" valign="top"><p class="table">What</p></td>
<td align="left" valign="top"><p class="table">Command line</p></td>
<td align="left" valign="top"><p class="table">Environment</p></td>
<td align="left" valign="top"><p class="table">Config variable</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Configuration file name</p></td>
<td align="left" valign="top"><p class="table">-c config</p></td>
<td align="left" valign="top"><p class="table">$UPMPD_CONFIG</p></td>
<td align="left" valign="top"><p class="table"></p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Host name or IP address where <strong>MPD</strong> runs</p></td>
<td align="left" valign="top"><p class="table">-h mpdhost</p></td>
<td align="left" valign="top"><p class="table">$UPMPD_HOST</p></td>
<td align="left" valign="top"><p class="table">mpdhost</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">TCP port for <strong>MPD</strong></p></td>
<td align="left" valign="top"><p class="table">-p mpdport</p></td>
<td align="left" valign="top"><p class="table">$UPMPD_PORT</p></td>
<td align="left" valign="top"><p class="table">mpdport</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><strong>MPD</strong> password</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">mpdpassword</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Do we own the <strong>MPD</strong> queue and fearlessly clear it</p></td>
<td align="left" valign="top"><p class="table">-o 0/1</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">ownqueue</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">UPnP "friendly name" for the device. This gets displayed in network search
results.</p></td>
<td align="left" valign="top"><p class="table">-f friendlyname</p></td>
<td align="left" valign="top"><p class="table">$UPMPD_FRIENDLYNAME</p></td>
<td align="left" valign="top"><p class="table">friendlyname</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Log file name. Leave empty for stderr</p></td>
<td align="left" valign="top"><p class="table">-d logfilename</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">logfilename</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Verbosity level (0-4)</p></td>
<td align="left" valign="top"><p class="table">-l loglevel</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">loglevel</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">UPnP network interface</p></td>
<td align="left" valign="top"><p class="table">-i iface</p></td>
<td align="left" valign="top"><p class="table">$UPMPD_UPNPIFACE</p></td>
<td align="left" valign="top"><p class="table">upnpiface</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">UPnP IP address (if interface not set)</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">upnpip</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">UPnP port</p></td>
<td align="left" valign="top"><p class="table">-p port</p></td>
<td align="left" valign="top"><p class="table">$UPMPD_UPNPPORT</p></td>
<td align="left" valign="top"><p class="table">upnpport</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">OpenHome support switch</p></td>
<td align="left" valign="top"><p class="table">-O 0/1</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">openhome</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">OpenHome playlist disk persistence (default 1)</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">ohmetapersist</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Directory for cached data (/var/cache/upmpdcli or ~/.cache/upmpdcli)</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">cachedir</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Path to icon to be displayed by control point. <a href="#upmpdcli.iconpathnote">See note</a></p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">iconpath</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Path to HTML file to be used as presentation
page. <a href="#upmpdcli.presentationnote">See note</a></p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">presentationhtml</p></td>
</tr>
</tbody>
</table>
</div>
<div class="paragraph" id="upmpdcli.iconpathnote"><p><strong>iconpath</strong> note: the UPnP protocol has provisions for a renderer to send
the URL to a descriptive icon as part of the device description. The icon
to use can be set using the <strong>iconpath</strong> configuration file parameter. Due to
current (and probably permanent) <strong>upmpdcli</strong> limitations, the image file
<strong>must</strong> be a 64x64 32 bits-per-pixel png file.</p></div>
<div class="paragraph" id="upmpdcli.presentationnote"><p><strong>presentationhtml</strong> note: the file referenced by the path will only be read
once when <strong>upmpdcli</strong> starts, it can’t presently be used for status updates
(but I guess that you could put a redirect in there, to something more
dynamic served by a real HTTP server).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="upmpdcli.openhome">OpenHome ohMedia services</h2>
<div class="sectionbody">
<div class="paragraph"><p>The support for ohMedia services (play queue managed by the player instead
of on the control point) is activated by default as of release 0.8.0, only
an explicit option will turn it off.</p></div>
<div class="paragraph"><p>The previous version default was set to <em>off</em> in the software, and <em>on</em> in
the configuration file. As the configuration file is not usually
overwritten during an upgrade, if you are upgrading to 0.7.x from an
earlier version and you want to enable the services, you need to set the
option in the configuration file.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="upmpdcli.songcast">Songcast integration</h2>
<div class="sectionbody">
<div class="paragraph"><p>upmpdcli recent versions support Songcast. See the
<a href="sc2mpd.html">description here</a>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="upmpdcli.boot">Boot time startup</h2>
<div class="sectionbody">
<div class="paragraph"><p><strong>upmpdcli</strong> will try to change its <tt>uid</tt> to user <tt>upmpdcli</tt> if it is
started by root. It will refuse to run if the user does not exist.</p></div>
<div class="paragraph"><p>If started by <tt>root</tt>, <strong>upmpdcli</strong> will also write its process id to
<tt>/var/run/upmpdcli.pid</tt>.</p></div>
<div class="paragraph"><p>There are boot-time startup scripts in the <tt>debian/</tt> directory inside the
source tree (for Debian/Ubuntu/Mint/Raspbian etc.). There is also a systemd
service file under <tt>systemd/</tt> (for Fedora et al.).</p></div>
<div class="paragraph"><p>The boot scripts are installed by the pre-built packages, so will just have
to edit the configuration file after installing them, all the rest should
just work.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="upmpdcli.building">Building</h2>
<div class="sectionbody">
<div class="paragraph"><p>For building from source, you will need a recent <tt>C++</tt> compiler (<tt>C++11</tt>),
and the development packages for <strong>libupnp</strong> version 1.6, <strong>libcurl</strong>,
<strong>libmpdclient</strong>, and <strong>libexpat</strong>.</p></div>
<div class="paragraph"><p>If you are using the source from Github, you will also need the
autoconf/automake/libtool trio. Use the <tt>autogen.sh</tt> script to set things
up.</p></div>
<div class="paragraph"><p>The <strong>libupnpp</strong> library, which used to be part of <strong>upmpdcli</strong>, has been
separated, and you need to build it first.</p></div>
<div class="paragraph"><p>So you need to either clone two github repositories:
<a href="https://github.com/medoc92/libupnpp">https://github.com/medoc92/libupnpp</a> and
<a href="https://github.com/medoc92/upmpdcli">https://github.com/medoc92/upmpdcli</a>,
or download the release tar files from the the
<a href="downloads.html">download area</a></p></div>
<div class="paragraph"><p>Once the source is extracted, the procedure is standard and there are
currently no specific configure options:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt># Only for git source
sh autogen.sh</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>./configure --prefix=/usr --sysconfdir=/etc
make
sudo make install</tt></pre>
</div></div>
<div class="paragraph"><p>Which you should apply first to the <strong>libupnpp</strong> source, then to <strong>upmpdcli</strong>.</p></div>
<div class="paragraph"><p>If you omit the <tt>--sysconfdir=/etc</tt> part, <tt>upmpdcli.conf</tt> will end up in
<tt>/usr/etc/</tt>, which is ok, but confusing, as package installers put it in
<tt>/etc/</tt></p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2015-05-05 10:32:34 CEST
</div>
</div>
</body>
</html>