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/23/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]
43 .HP \w'\fBmpd\-sima\fR\ 'u
44 \fBmpd\-sima\fR purge\-history [\fB\-\-var\-dir=\fR\fIvar_directory\fR]
47 This manual page documents briefly the
51 At start up default configuration is first overridden by user configuration in mpd_sima\&.cfg (see
52 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
53 \fB\-S\ \&my_mpd_server\fR
54 option\&. For default configuration see
55 the section called \(lqCONFIGURATION\(rq\&. See also environment variables special case for MPD host and port in
56 the section called \(lqENVIRONMENT\(rq\&.
58 .SS "Launch as a system service (d\(aemon)\&."
60 Here follows an example on how to launch mpd\-sima as a service on your system, not attach to regular user configuration/database\&.
62 \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
63 .SS "Launch in user land"
65 Launching mpd\-sima from/whithin your user account is easy, you can simply call
67 from your shell or one of the following command:
69 Background execution (d\(aemonise), log in the specified file, save pid:
71 \fBmpd\-sima \-\-daemon \-\-pid=$HOME/var/run/mpd\-sima\&.pid \-\-log=$HOME/var/log/mpd\-sima\&.log\fR
73 Foreground execution, connect
74 \fImy\&.mpd\&.server\&.org\fR, log to std(out|err):
76 \fBmpd\-sima \-\-host=my\&.mpd\&.server\&.org\fR
79 The program follows the usual GNU command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
81 \fB\-h\fR, \fB\-\-help\fR
83 Print help and exit\&.
88 Print version and exit\&.
93 Start as a daemon\&. Log redirected to /dev/null, usually setting
97 options in daemon mode are a good idea to monitor/stop the process\&.
100 \fB\-p \fR\fB\fIpid_file\fR\fR, \fB\-\-pid=\fR\fB\fIpid_file\fR\fR
102 Use the specific file
106 Default is not to store pid info\&.
109 \fB\-l \fR\fB\fIlog_file\fR\fR, \fB\-\-log=\fR\fB\fIlog_file\fR\fR
111 Use the specific file
113 to log messages to\&.
115 Default is to log to stdout/stderr\&.
118 \fB\-v \fR\fB\fIlog_level\fR\fR, \fB\-\-log\-level=\fR\fB\fIlog_level\fR\fR
120 Verbosity in [debug,info,warning,error]\&.
122 Default is to log info messages\&.
125 \fB\-c \fR\fB\fIconf_file\fR\fR, \fB\-\-config=\fR\fB\fIconf_file\fR\fR
127 Use the specific file
129 to set up configuration instead of looking for the default user configuration file\&.
131 Default is to look for
132 \fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR\&.
135 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\&.
138 For more details on configuration file cf\&.
139 \fBmpd_sima.cfg\fR(5), see also
140 the section called \(lqFILES\(rq\&.
145 \fB\-\-var\-dir=\fR\fB\fIvar_directory\fR\fR
147 Use the specific path
149 to look for (or create) var files (ie\&. database) instead of looking at the default user data location\&.
151 Default is to look in
152 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
155 the section called \(lqFILES\(rq\&.
158 \fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR
160 Use the specific host
167 or a fully qualified domain name as long as your system can resolve it\&. This overrides
169 environment variable\&.
175 the section called \(lqENVIRONMENT\(rq\&.
178 \fB\-P \fR\fB\fImpd_port\fR\fR, \fB\-\-port=\fR\fB\fImpd_port\fR\fR
180 Use the specific port number
182 on MPD server\&. This overrides
184 environment variable\&.
190 the section called \(lqENVIRONMENT\(rq
195 Test configuration file and exit\&. Uses the configuration file specified with
197 or default location\&.
200 \fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR
202 the section called \(lqFILES\(rq
205 config\-test tests MPD connection and Tags plugin configuration\&.
210 Create the database and exit\&. Uses folder specified with
212 or default directory\&.
215 \fB$XDG_DATA_HOME/mpd_sima/\fR
217 the section called \(lqFILES\(rq
221 \fBgenerate\-config\fR
223 Generate a sample configuration file according to the current CLI options and env\&. var\&.\&. The configuration is written on stdout\&.
228 Purge play history in the database and exit\&. Uses folder specified with
230 or default directory\&.
233 \fB$XDG_DATA_HOME/mpd_sima/\fR
235 the section called \(lqFILES\(rq
240 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
242 Configuration file\&.
245 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
250 ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
252 Persistent http cache\&.
258 ${HOME}/\&.local/share
260 \fBXDG_CONFIG_HOME\fR
264 You may override them using command line option
272 \fBMPD_HOST\fR, \fBMPD_PORT\fR
274 mpd\-sima will look for
278 to override built\-in configuration (set to "localhost:6600")\&.
282 syntax as documented in mpc manual, cf\&.
286 To use a password, provide a value of the form "password@host"\&.
289 \fBHTTP_PROXY\fR, \fBHTTPS_PROXY\fR
293 environment variables\&.
300 is read if present\&. Otherwise built\-in defaults are used\&. An example should be provided in the tarball within
301 doc/examples/\&. On Debian system please look in
302 /usr/share/doc/mpd\-sima\&.
307 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\&.
309 The get the defaults as detected by mpd\-sima on your system you can run mpd\-sima to print the config:
311 \fBmpd\-sima generate\-config\fR
314 For details about mpd_sima\&.cfg refer to the manual
315 \fBmpd_sima.cfg\fR(5)
318 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
319 \m[blue]\fB\%https://kaliko.me/contact/\fR\m[]\&.
322 users are welcome to join the dedicated chat room at
323 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
329 /usr/share/doc/mpd\-sima/
332 \fBkaliko\fR <\&kaliko@azylum\&.org\&>
334 Wrote this man page and is currently leading MPD_sima project\&.
338 Copyright \(co 2009-2021 kaliko
341 This manual page was written for the Debian system (and may be used by others)\&.
343 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\&.
345 On Debian systems, the complete text of the GNU General Public License can be found in
346 /usr/share/common\-licenses/GPL\&.