Switch to unified view

a/src/upmpdcli.conf-dist b/src/upmpdcli.conf-dist
...
...
3
# comments are just comments. Edit at will.
3
# comments are just comments. Edit at will.
4
4
5
# The command line options have higher priorities than the values in
5
# The command line options have higher priorities than the values in
6
# this file.
6
# this file.
7
7
8
8
# <grouptitle>Upmpdcli general parameters</grouptitle>
9
# <grouptitle>Upmpdcli general parameters</grouptitle>
10
11
# <var name="logfilename" type="fn"><brief>Log file
12
# name.</brief><descr>Defaults to stderr. This can also be specified as -d
13
# logfilename.</descr></var>
14
#logfilename = 
15
16
# <var name="loglevel" type="int" values="0 5 2"><brief>Log
17
# level.</brief><descr>Can also be specified as -l loglevel.</descr></var>
18
#loglevel = 2
19
20
# <var name="pkgdatadir" type="dfn"><brief>XML and other constant data storage
21
# directory.</brief><descr>Default: '$prefix/share/upmpcli' (e.g.:
22
# '/usr/share/upmpdcli').</descr></var>
23
#pkgdatadir=/usr/share/upmpdcli
24
25
# <var name="pidfile" type="fn"><brief>Name of lock file used to store the
26
# current process pid.</brief><descr>Only used if the process is launched
27
# by user root. Used by the init system, and to avoid multiple
28
# instances. The only reason to change the value is if you actually want to
29
# have several instances running (also change cachedir in this
30
# case).</descr></var>
31
#pidfile = /var/run/upmpdcli.pid
32
33
34
# <grouptitle>UPnP network parameters</grouptitle>
35
36
# <var name="upnpiface" type="cstr" values="dynamic"><brief>Network interface to
37
# use for UPnP.</brief><descr>libupnp/pupnp only supports communicating on
38
# a single interface and will use the first found, this allows forcing the
39
# use of another interface.</descr></var>
40
#upnpiface = 
41
42
# <var name="upnpip" type="string"><brief>IP address to use for UPnP, 
43
# alternative to using an interface name.</brief></var>
44
#upnpip = 
45
46
# <var name="upnpport" type="int" values="0 65635 49152"><brief>Port number
47
# used for UPnP.</brief><descr>libupnp/pupnp defaults to using the first
48
# free port after 49152. Note that clients do not need to know about the
49
# value, which is automatically discovered.</descr></var>
50
#upnpport = 
51
52
53
54
# <grouptitle>Media Renderer parameters</grouptitle>
9
55
10
# <var name="friendlyname" type="string"><brief>"Friendly Name" for the
56
# <var name="friendlyname" type="string"><brief>"Friendly Name" for the
11
# UPnP Media Renderer.</brief><descr>This will be displayed by most Control
57
# UPnP Media Renderer.</brief><descr>This will be displayed by most Control
12
# Points to identify the Renderer. Some OpenHome Control Points may display
58
# Points to identify the Renderer. Some OpenHome Control Points may display
13
# the 'ohproductroom' value instead.</descr></var>
59
# the 'ohproductroom' value instead.</descr></var>
...
...
22
# <var name="openhome" type="bool" values="1"><brief>Enable OpenHome services
68
# <var name="openhome" type="bool" values="1"><brief>Enable OpenHome services
23
# (0/1).</brief><descr>This defaults to 1, as OpenHome queuing is superior
69
# (0/1).</brief><descr>This defaults to 1, as OpenHome queuing is superior
24
# for most usages. There should be little reason to turn it
70
# for most usages. There should be little reason to turn it
25
# off.</descr></var>
71
# off.</descr></var>
26
#openhome = 1
72
#openhome = 1
27
28
# <var name="logfilename" type="fn"><brief>Log file
29
# name.</brief><descr>Defaults to stderr. This can also be specified as -d
30
# logfilename.</descr></var>
31
#logfilename = 
32
33
# <var name="loglevel" type="int" values="0 5 2"><brief>Log
34
# level.</brief><descr>Can also be specified as -l loglevel.</descr></var>
35
#loglevel = 2
36
73
37
# <var name="checkcontentformat" type="bool" values="1"><brief>Check that
74
# <var name="checkcontentformat" type="bool" values="1"><brief>Check that
38
# input format is supported.</brief><descr>Extract the protocolinfo
75
# input format is supported.</brief><descr>Extract the protocolinfo
39
# information from the input metadata and check it against our supported
76
# information from the input metadata and check it against our supported
40
# formats. Set this option to 0 if a control point or media server sends
77
# formats. Set this option to 0 if a control point or media server sends
...
...
49
# 64x64 32 bits-per-pixel png file. Default: '$pkgdatadir/icon.png'.
86
# 64x64 32 bits-per-pixel png file. Default: '$pkgdatadir/icon.png'.
50
# The icon will only be read once, when upmpdcli starts
87
# The icon will only be read once, when upmpdcli starts
51
# up.</descr></var>
88
# up.</descr></var>
52
#iconpath = /usr/share/upmpdcli/icon.png
89
#iconpath = /usr/share/upmpdcli/icon.png
53
90
54
# <var name="pkgdatadir" type="dfn"><brief>XML and other constant data storage
55
# directory.</brief><descr>Default: '$prefix/share/upmpcli' (e.g.:
56
# '/usr/share/upmpdcli').</descr></var>
57
#pkgdatadir=/usr/share/upmpdcli
58
59
# <var name="cachedir" type="dfn"><brief>Directory used to store cached
91
# <var name="cachedir" type="dfn"><brief>Directory used to store cached
60
# data</brief><descr>Only used for the OpenHome queue metadata for now.
92
# data</brief><descr>Only used for the OpenHome queue metadata for now.
61
# The default value is ~/.cache/upmpdcli for normal users or
93
# The default value is ~/.cache/upmpdcli for normal users or
62
# /var/cache/upmpdcli when upmpdcli is started as root.</descr></var>
94
# /var/cache/upmpdcli when upmpdcli is started as root.</descr></var>
63
#cachedir = /var/cache/upmpdcli
95
#cachedir = /var/cache/upmpdcli
...
...
68
# up. It can't presently be used for status updates (but I guess that you
100
# up. It can't presently be used for status updates (but I guess that you
69
# could put a redirect in there, to something more dynamic served by a real
101
# could put a redirect in there, to something more dynamic served by a real
70
# HTTP server). Default: '$pkgdatadir/presentation.html'.</descr></var>
102
# HTTP server). Default: '$pkgdatadir/presentation.html'.</descr></var>
71
#presentationhtml = /usr/share/upmpdcli/presentation.html
103
#presentationhtml = /usr/share/upmpdcli/presentation.html
72
104
73
# <var name="pidfile" type="fn"><brief>Name of lock file used to store the
74
# current process pid.</brief><descr>Only used if the process is launched
75
# by user root. Used by the init system, and to avoid multiple
76
# instances. The only reason to change the value is if you actually want to
77
# have several instances running (also change cachedir in this
78
# case).</descr></var>
79
#pidfile = /var/run/upmpdcli.pid
80
81
# <grouptitle>Tidal streaming service parameters</grouptitle>
82
83
# <var name="tidaluser" type="string"><brief>Tidal user name.</brief>
84
# <descr>Your Tidal login name.</descr></var>
85
#tidaluser = your tidal user name
86
# <var name="tidalpass" type="string"><brief>Tidal password.</brief>
87
# <descr>The password for your Tidal account.</descr></var>
88
#tidalpass = your Tidal password
89
# <var name="tidalquality" type="cstr" "values="low high lossless">
90
# <brief>Tidal stream quality.</brief> <descr>'low' and 'high' are aac
91
# streams. 'lossless' is FLAC and will only work if your subscription
92
# allows it.</descr></var>
93
#tidalquality = low/high/lossless
94
95
# <grouptitle>Qobuz streaming service parameters</grouptitle>
96
97
# <var name="qobuzuser" type="string"><brief>Qobuz user name.</brief>
98
# <descr>Your Qobuz login name.</descr></var>
99
#qobuzuser = me@some.place
100
# <var name="qobuzpass" type="string"><brief>Qobuz password.</brief>
101
# <descr>The password for your Qobuz account.</descr></var>
102
#qobuzpass = agoodpassword
103
# <var name="qobuzformatid" type="cstr" "values="5 7">
104
# <brief>Qobuz stream quality.</brief> <descr>5 for mp3/320, 7 for FLAC if
105
# your subscription allows it.</descr></var>
106
#qobuzformatid = 5
107
108
# <grouptitle>Google Music streaming service parameters</grouptitle>
109
110
# <var name="gmusicuser" type="string"><brief>Google Music user name.</brief>
111
# <descr>Your Google Music login name (probably a gmail address).</descr></var>
112
#gmusicuser = me@gmail.com
113
# <var name="gmusicpass" type="string"><brief>Google Music password.</brief>
114
# <descr>The password for your Google Music account.</descr></var>
115
#gmusicpass = agoodpassword
116
# <var name="gmusicquality" type="cstr" "values="hi med low">
117
# <brief>Google Music stream quality.</brief> <descr>'hi' for mp3/320, 'med'
118
# for mp3/160, 'low' for mp3/128.</descr></var>
119
#gmusicquality = med
120
# <var name="gmusicdeviceid" type="string"> <brief>Google Music device
121
# id.</brief> <descr>Your system MAC address will be used by default, but
122
# this will count against the maximum count of registered devices for this
123
# account.  You can set the gmusicdeviceid value to the device ID from a
124
# phone or tablet on which you also use Google Play Music.</descr></var>
125
#gmusicdeviceid =
126
127
# <grouptitle>Local Media Server parameters</grouptitle>
128
129
# <var name="uprcluser" type="string"><brief>Bogus user name variable.</brief>
130
# <descr>Used for consistency with other Media Server plugins to decide if
131
# the service should be started (so, do set it if you want a Media Server).
132
# </descr></var>
133
#uprcluser = bugsbunny
134
135
# <var name="uprclmediadirs" type="string"> <brief>Media
136
# directories</brief><descr>This is a space-separated list of directories
137
# to explore for music files. This is used directly as the recoll "topdirs"
138
# value, so you can use double-quote quoting for paths with embedded
139
# spaces.</descr></var>
140
#uprclmediadirs = /tmp
141
142
# <var name="uprclhostport" type="string"><brief>HTTP host and ports for
143
# serving media files</brief><descr>The Media Server HTTP server will run
144
# on this address and port, which will also be inserted on the URLs we
145
# produce. If the variable is not set, we will use port 9090 and the first
146
# non-loopback ipv4 address in "ip addr" output, which may be right or
147
# not. Example: 192.168.1.1:9090</descr></var>
148
#uprclhostport = 192.168.4.4:9090
149
150
# <var name="uprclpaths" type="string"><brief></brief><descr>This is used
151
# to translate real path to ones relative to the HTTP server doc tree. It
152
# also performs a form of access control. If this is not set, uprcl will
153
# use a null translation for each of the uprclmediadirs
154
# entries.</descr></var> 
155
#uprclpaths =
156
157
# <var name="uprclconfdir" type="dfn"><brief>Recoll index
158
# directory</brief><descr>This is usually not defined and defaults to
159
# /var/cache/upmpdcli/uprcl</descr></var>
160
#uprclconfdir = /var/cache/upmpdcli/uprcl
161
162
# <var name="uprclautostart" type="bool"><brief>Initialize uprcl as soon as
163
# upmpdcli starts</brief><descr>This is useful because uprcl initialization
164
# can take quite some time so it is better not to wait for the first
165
# access. The general default is false for the autostart variables, so this
166
# is normally explicitely set to true.</descr></var>
167
uprclautostart = 1
168
105
169
106
170
# <grouptitle>MPD parameters</grouptitle>
107
# <grouptitle>MPD parameters</grouptitle>
171
108
172
# <var name="mpdhost" type="string"><brief>Host MPD runs on.</brief>
109
# <var name="mpdhost" type="string"><brief>Host MPD runs on.</brief>
...
...
189
# queue.</brief>.<descr>If this is set (on by default), we own the MPD
126
# queue.</brief>.<descr>If this is set (on by default), we own the MPD
190
# queue and will fearlessly clear it. Can also be specified as -q
127
# queue and will fearlessly clear it. Can also be specified as -q
191
# 0|1.</descr></var>
128
# 0|1.</descr></var>
192
#ownqueue = 1
129
#ownqueue = 1
193
130
194
# <grouptitle>UPnP network parameters</grouptitle>
195
196
# <var name="upnpiface" type="cstr" values="dynamic"><brief>Network interface to
197
# use for UPnP.</brief><descr>libupnp/pupnp only supports communicating on
198
# a single interface and will use the first found, this allows forcing the
199
# use of another interface.</descr></var>
200
#upnpiface = 
201
202
# <var name="upnpip" type="string"><brief>IP address to use for UPnP, 
203
# alternative to using an interface name.</brief></var>
204
#upnpip = 
205
206
# <var name="upnpport" type="int" values="0 65635 49152"><brief>Port number
207
# used for UPnP.</brief><descr>libupnp/pupnp defaults to using the first
208
# free port after 49152. Note that clients do not need to know about the
209
# value, which is automatically discovered.</descr></var>
210
#upnpport = 
211
131
212
# <grouptitle>Audio control hooks</grouptitle>
132
# <grouptitle>Audio control hooks</grouptitle>
213
133
214
# <var name="onstart" type="fn"><brief>Command to run when playback is
134
# <var name="onstart" type="fn"><brief>Command to run when playback is
215
# about to begin.</brief><descr>Specify the full path to the program,
135
# about to begin.</brief><descr>Specify the full path to the program,
...
...
336
# may improve playlist load speed on a slow device. The default is to start
256
# may improve playlist load speed on a slow device. The default is to start
337
# a new save as soon as the previous one is done (if the list changed again
257
# a new save as soon as the previous one is done (if the list changed again
338
# inbetween).</descr></var>
258
# inbetween).</descr></var>
339
#ohmetasleep = 0
259
#ohmetasleep = 0
340
260
261
262
# <grouptitle>Media Server general parameters</grouptitle>
263
264
# <var name="msfriendlyname" type="string"><brief>Friendly name for the
265
# Media Server (if enabled).</brief><descr>The default is to append
266
# "-mediaserver" to the friendlyname value.</descr></var>
267
#msfriendlyname = UpMpd-mediaserver
268
269
# <var name="plgmicrohttpport" type="int"><brief>IP port for the
270
# tidal/qobuz/gmusic local HTTP service.</brief> <descr>The URLs for tracks
271
# streamed from these services point to a local microhttpd server running on
272
# this port (it uses redirection to the actual service URL when
273
# actually streaming). The default is 49149.</descr></var>
274
#plgmicrohttpport = 49149
275
276
# <grouptitle>Tidal streaming service parameters</grouptitle>
277
278
# <var name="tidaluser" type="string"><brief>Tidal user name.</brief>
279
# <descr>Your Tidal login name.</descr></var>
280
#tidaluser = your tidal user name
281
# <var name="tidalpass" type="string"><brief>Tidal password.</brief>
282
# <descr>The password for your Tidal account.</descr></var>
283
#tidalpass = your Tidal password
284
# <var name="tidalquality" type="cstr" "values="low high lossless">
285
# <brief>Tidal stream quality.</brief> <descr>'low' and 'high' are aac
286
# streams. 'lossless' is FLAC and will only work if your subscription
287
# allows it.</descr></var>
288
#tidalquality = low/high/lossless
289
290
# <grouptitle>Qobuz streaming service parameters</grouptitle>
291
292
# <var name="qobuzuser" type="string"><brief>Qobuz user name.</brief>
293
# <descr>Your Qobuz login name.</descr></var>
294
#qobuzuser = me@some.place
295
# <var name="qobuzpass" type="string"><brief>Qobuz password.</brief>
296
# <descr>The password for your Qobuz account.</descr></var>
297
#qobuzpass = agoodpassword
298
# <var name="qobuzformatid" type="cstr" "values="5 7">
299
# <brief>Qobuz stream quality.</brief> <descr>5 for mp3/320, 7 for FLAC if
300
# your subscription allows it.</descr></var>
301
#qobuzformatid = 5
302
303
# <grouptitle>Google Music streaming service parameters</grouptitle>
304
305
# <var name="gmusicuser" type="string"><brief>Google Music user name.</brief>
306
# <descr>Your Google Music login name (probably a gmail address).</descr></var>
307
#gmusicuser = me@gmail.com
308
# <var name="gmusicpass" type="string"><brief>Google Music password.</brief>
309
# <descr>The password for your Google Music account.</descr></var>
310
#gmusicpass = agoodpassword
311
# <var name="gmusicquality" type="cstr" "values="hi med low">
312
# <brief>Google Music stream quality.</brief> <descr>'hi' for mp3/320, 'med'
313
# for mp3/160, 'low' for mp3/128.</descr></var>
314
#gmusicquality = med
315
# <var name="gmusicdeviceid" type="string"> <brief>Google Music device
316
# id.</brief> <descr>Your system MAC address will be used by default, but
317
# this will count against the maximum count of registered devices for this
318
# account.  You can set the gmusicdeviceid value to the device ID from a
319
# phone or tablet on which you also use Google Play Music.</descr></var>
320
#gmusicdeviceid =
321
322
# <grouptitle>Local Media Server parameters</grouptitle>
323
324
# <var name="uprcluser" type="string"><brief>Bogus user name variable.</brief>
325
# <descr>Used for consistency with other Media Server plugins to decide if
326
# the service should be started (so, do set it if you want a Media Server).
327
# </descr></var>
328
#uprcluser = bugsbunny
329
330
# <var name="uprclmediadirs" type="string"> <brief>Media
331
# directories</brief><descr>This is a space-separated list of directories
332
# to explore for music files. This is used directly as the recoll "topdirs"
333
# value, so you can use double-quote quoting for paths with embedded
334
# spaces.</descr></var>
335
#uprclmediadirs = /tmp
336
337
# <var name="uprclhostport" type="string"><brief>HTTP host and ports for
338
# serving media files</brief><descr>The Media Server HTTP server will run
339
# on this address and port, which will also be inserted on the URLs we
340
# produce. If the variable is not set, we will use port 9090 and the first
341
# non-loopback ipv4 address in "ip addr" output, which may be right or
342
# not. Example: 192.168.1.1:9090</descr></var>
343
#uprclhostport = 192.168.4.4:9090
344
345
# <var name="uprclpaths" type="string"><brief></brief><descr>This is used
346
# to translate real path to ones relative to the HTTP server doc tree. It
347
# also performs a form of access control. If this is not set, uprcl will
348
# use a null translation for each of the uprclmediadirs
349
# entries.</descr></var> 
350
#uprclpaths =
351
352
# <var name="uprclconfdir" type="dfn"><brief>Recoll index
353
# directory</brief><descr>This is usually not defined and defaults to
354
# /var/cache/upmpdcli/uprcl</descr></var>
355
#uprclconfdir = /var/cache/upmpdcli/uprcl
356
357
# <var name="uprclautostart" type="bool"><brief>Initialize uprcl as soon as
358
# upmpdcli starts</brief><descr>This is useful because uprcl initialization
359
# can take quite some time so it is better not to wait for the first
360
# access. The general default is false for the autostart variables, so this
361
# is normally explicitely set to true.</descr></var>
362
uprclautostart = 1
363
364
365
341
# <grouptitle>Songcast Receiver parameters</grouptitle>
366
# <grouptitle>Songcast Receiver parameters</grouptitle>
342
367
343
# Parameters for the Songcast modes. These are read by either/both the
368
# Parameters for the Songcast modes. These are read by either/both the
344
# songcast and upmpdcli processes
369
# songcast and upmpdcli processes
345
370