Switch to unified view

a/doc/upmpdcli.txt b/doc/upmpdcli.txt
1
= Upmpdcli: MPD UPnP Renderer Front-End
1
= Upmpdcli: MPD UPnP Renderer Front-End
2
2
3
3
4
*upmpdcli* is an UPnP Media Renderer front-end to *MPD*, the Music Player
4
*upmpdcli* is an UPnP Media Renderer front-end to *MPD*, the Music Player
5
Daemon. The last version supports both pure UPnP and the OpenHome ohMedia
5
Daemon. It supports both pure UPnP and the OpenHome ohMedia services.
6
services.
7
6
8
[[upmpdcli.security]]
7
[[upmpdcli.security]]
9
== Security
8
== Security
10
9
11
*upmpdcli* is not audited for security issues, and, as far as I
10
*upmpdcli* is not audited for security issues, and, as far as I
...
...
26
The configuration file has a simple `name = value` format.
25
The configuration file has a simple `name = value` format.
27
26
28
The configuration parameters can be set from the command line, a
27
The configuration parameters can be set from the command line, a
29
configuration file, or the environment in this order of priority. It would
28
configuration file, or the environment in this order of priority. It would
30
be rather confusing to use a mix of methods, so you should probably chose
29
be rather confusing to use a mix of methods, so you should probably chose
31
one. 
30
one. Some less common parameters can only be set in the configuration file.
32
31
33
All parameters have defaults, and a typical installation needs no
32
All parameters have defaults, and a typical installation needs no
34
modification of the configuration file. If several instances of *upmpdcli*
33
modification of the configuration file. If several instances of *upmpdcli*
35
run on the same network, it may be useful to give them distinct names
34
run on the same network, you will want to give them distinct names
36
(_friendlyname_ parameter). The other parameters are only useful in special
35
(_friendlyname_ parameter). The other parameters are only useful in special
37
situations.
36
situations.
38
37
39
The following parameters can be set:
38
The following parameters can be set:
40
39
...
...
51
|Verbosity level (0-4)|-l loglevel||loglevel
50
|Verbosity level (0-4)|-l loglevel||loglevel
52
|UPnP network interface|-i iface|$UPMPD_UPNPIFACE|upnpiface
51
|UPnP network interface|-i iface|$UPMPD_UPNPIFACE|upnpiface
53
|UPnP IP address (if interface not set)|||upnpip
52
|UPnP IP address (if interface not set)|||upnpip
54
|UPnP port|-p port|$UPMPD_UPNPPORT|upnpport
53
|UPnP port|-p port|$UPMPD_UPNPPORT|upnpport
55
|OpenHome support switch|-O 0/1||openhome
54
|OpenHome support switch|-O 0/1||openhome
55
|OpenHome playlist disk persistence (default 1)|||ohmetapersist
56
|===========================    
56
|===========================    
57
57
58
[[upmpdcli.openhome]]
58
[[upmpdcli.openhome]]
59
== OpenHome ohMedia services
59
== OpenHome ohMedia services
60
60
61
The support for ohMedia services (play queue managed by the player instead
61
The support for ohMedia services (play queue managed by the player instead
62
of on the control point) is set to _off_ by default in the software, and
62
of on the control point) is activated by default as of release 0.8.0, only
63
_on_ in the configuration file (which normally does not
63
an explicit option will turn it off.
64
overwrite the previous one during an upgrade). If you are upgrading to a
64
65
version supporting OpenHome and you want to enable the services, you need
65
The previous version default was set to _off_ in the software, and _on_ in
66
the configuration file. As the configuration file is not usually
67
overwritten during an upgrade, if you are upgrading to 0.7.x from an
68
earlier version and you want to enable the services, you need to set the
66
to set the option in the configuration file.
69
option in the configuration file.
67
70
68
[[upmpdcli.boot]]
71
[[upmpdcli.boot]]
69
== Boot time startup
72
== Boot time startup
70
73
71
*upmpdcli* will try to change its `uid` to user `upmpdcli` if it is
74
*upmpdcli* will try to change its `uid` to user `upmpdcli` if it is