3 .\" Author: kaliko <kaliko@azylum.org>
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
6 .\" Manual: mpd-sima 0.17.0 User Manual
10 .TH "MPD\-SIMA" "1" "04/22/2021" "mpd-sima" "mpd-sima 0.17.0 User Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 mpd-sima \- mpd\-sima will try to maintain some titles ahead in the queue following different policies\&.
33 .HP \w'\fBmpd\-sima\fR\ 'u
34 \fBmpd\-sima\fR [\fB\-\-daemon\fR] [\fB\-\-config=\fR\fIconf_file\fR] [\fB\-\-var\-dir=\fR\fIvar_directory\fR] [\fB\-\-pid=\fR\fIpid_file\fR] [\fB\-\-log=\fR\fIlog_file\fR] [\fB\-\-log\-level=\fR\fIlog_level\fR] [\fB\-\-host=\fR\fImpd_host\fR] [\fB\-\-mpd_port=\fR\fImpd_port\fR]
35 .HP \w'\fBmpd\-sima\fR\ 'u
36 \fBmpd\-sima\fR {{\fB\-h\fR\ |\ \fB\-\-help\fR}\ \fB\-\-version\fR}
37 .HP \w'\fBmpd\-sima\fR\ 'u
38 \fBmpd\-sima\fR config\-test [\fB\-\-config=\fR\fIconf_file\fR]
39 .HP \w'\fBmpd\-sima\fR\ 'u
40 \fBmpd\-sima\fR create\-db [\fB\-\-var\-dir=\fR\fIvar_directory\fR]
41 .HP \w'\fBmpd\-sima\fR\ 'u
42 \fBmpd\-sima\fR generate\-config [\fB\&...\fR]
45 This manual page documents briefly the
49 At start up default configuration is first overridden by user configuration in mpd_sima\&.cfg (see
50 the section called \(lqFILES\(rq) and finally command lines options are honored\&. For instance you can override default MPD_HOST set in defaults (localhost) or in your configuration file with
51 \fB\-S\ \&my_mpd_server\fR
52 option\&. For default configuration see
53 the section called \(lqCONFIGURATION\(rq\&. See also environment variables special case for MPD host and port in
54 the section called \(lqENVIRONMENT\(rq\&.
56 .SS "Launch as a system service (d\(aemon)\&."
58 Here follows an example on how to launch mpd\-sima as a service on your system, not attach to regular user configuration/database\&.
60 \fBmpd\-sima \-\-daemon \-\-conf=/etc/mpd_sima\&.cfg \-\-var\-dir=/var/cache/mpd\-sima/ \-\-pid=/run/mpd\-sima\&.pid \-\-log=/var/log/mpd\-sima\&.log\fR
61 .SS "Launch in user land"
63 Launching mpd\-sima from/whithin your user account is easy, you can simply call
65 from your shell or one of the following command:
67 Background execution (d\(aemonise), log in the specified file, save pid:
69 \fBmpd\-sima \-\-daemon \-\-pid=$HOME/var/run/mpd\-sima\&.pid \-\-log=$HOME/var/log/mpd\-sima\&.log\fR
71 Foreground execution, connect
72 \fImy\&.mpd\&.server\&.org\fR, log to std(out|err):
74 \fBmpd\-sima \-\-host=my\&.mpd\&.server\&.org\fR
77 The program follows the usual GNU command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
79 \fB\-h\fR, \fB\-\-help\fR
81 Print help and exit\&.
86 Print version and exit\&.
91 Start as a daemon\&. Log redirected to /dev/null, usually setting
95 options in daemon mode are a good idea to monitor/stop the process\&.
98 \fB\-p \fR\fB\fIpid_file\fR\fR, \fB\-\-pid=\fR\fB\fIpid_file\fR\fR
100 Use the specific file
104 Default is not to store pid info\&.
107 \fB\-l \fR\fB\fIlog_file\fR\fR, \fB\-\-log=\fR\fB\fIlog_file\fR\fR
109 Use the specific file
111 to log messages to\&.
113 Default is to log to stdout/stderr\&.
116 \fB\-v \fR\fB\fIlog_level\fR\fR, \fB\-\-log\-level=\fR\fB\fIlog_level\fR\fR
118 Verbosity in [debug,info,warning,error]\&.
120 Default is to log info messages\&.
123 \fB\-c \fR\fB\fIconf_file\fR\fR, \fB\-\-config=\fR\fB\fIconf_file\fR\fR
125 Use the specific file
127 to set up configuration instead of looking for the default user configuration file\&.
129 Default is to look for
130 \fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR\&.
133 CLI option overrides any equivalent mentioned in configuration file, ie\&. launching mpd\-sima with \*(Aq\fB\-\-port\fR\*(Aq CLI option will ignore port setting in configuration file\&.
136 For more details on configuration file cf\&.
137 \fBmpd_sima.cfg\fR(5), see also
138 the section called \(lqFILES\(rq\&.
143 \fB\-\-var\-dir=\fR\fB\fIvar_directory\fR\fR
145 Use the specific path
147 to look for (or create) var files (ie\&. database) instead of looking at the default user data location\&.
149 Default is to look in
150 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
153 the section called \(lqFILES\(rq\&.
156 \fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR
158 Use the specific host
165 or a fully qualified domain name as long as your system can resolve it\&. This overrides
167 environment variable\&.
173 the section called \(lqENVIRONMENT\(rq\&.
176 \fB\-P \fR\fB\fImpd_port\fR\fR, \fB\-\-port=\fR\fB\fImpd_port\fR\fR
178 Use the specific port number
180 on MPD server\&. This overrides
182 environment variable\&.
188 the section called \(lqENVIRONMENT\(rq
193 Test configuration file and exit\&. Uses the configuration file specified with
195 or default location\&.
198 \fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR
200 the section called \(lqFILES\(rq
203 config\-test tests MPD connection and Tags plugin configuration\&.
208 Create the database and exit\&. Uses folder specified with
210 or default directory\&.
213 \fB$XDG_DATA_HOME/mpd_sima/\fR
215 the section called \(lqFILES\(rq
219 \fBgenerate\-config\fR
221 Generate a sample configuration file according to the current CLI options and env\&. var\&.\&. The configuration is written on stdout\&.
225 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
227 Configuration file\&.
230 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
235 ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
237 Persistent http cache\&.
243 ${HOME}/\&.local/share
245 \fBXDG_CONFIG_HOME\fR
249 You may override them using command line option
257 \fBMPD_HOST\fR, \fBMPD_PORT\fR
259 mpd\-sima will look for
263 to override built\-in configuration (set to "localhost:6600")\&.
267 syntax as documented in mpc manual, cf\&.
271 To use a password, provide a value of the form "password@host"\&.
274 \fBHTTP_PROXY\fR, \fBHTTPS_PROXY\fR
278 environment variables\&.
285 is read if present\&. Otherwise built\-in defaults are used\&. An example should be provided in the tarball within
286 doc/examples/\&. On Debian system please look in
287 /usr/share/doc/mpd\-sima\&.
292 Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env\&. var\&. if set)\&. The default plugins will use Last\&.fm to find similar tracks to queue and fallback to random if nothing if found\&.
294 The get the defaults as detected by mpd\-sima on your system you can run mpd\-sima to print the config:
296 \fBmpd\-sima generate\-config\fR
299 For details about mpd_sima\&.cfg refer to the manual
300 \fBmpd_sima.cfg\fR(5)
303 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
304 \m[blue]\fB\%https://kaliko.me/contact/\fR\m[]\&.
307 users are welcome to join the dedicated chat room at
308 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
314 /usr/share/doc/mpd\-sima/
317 \fBkaliko\fR <\&kaliko@azylum\&.org\&>
319 Wrote this man page and is currently leading MPD_sima project\&.
323 Copyright \(co 2009-2021 kaliko
326 This manual page was written for the Debian system (and may be used by others)\&.
328 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation\&.
330 On Debian systems, the complete text of the GNU General Public License can be found in
331 /usr/share/common\-licenses/GPL\&.