3 .\" Author: Jack Kaliko <kaliko@azylum.org>
4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
6 .\" Manual: mpd-sima 0.12.0 User Manual
10 .TH "MPD\-SIMA" "1" "01/25/2014" "mpd-sima" "mpd-sima 0.12.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 your play list 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\-\-var_dir=\fR\fIvar_directory\fR] [\fB\-\-create\-db>\fR]
37 .HP \w'\fBmpd\-sima\fR\ 'u
38 \fBmpd\-sima\fR [{\fB\-h\fR\ |\ \fB\-\-help\fR} | \fB\-\-version\fR]
41 This manual page documents briefly the
45 At start up default configuration is first overridden by user configuration in mpd_sima\&.cfg (see
46 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
47 \fB\-S\ \&my_mpd_server\fR
48 option\&. For default configuration see
49 the section called \(lqCONFIGURATION\(rq\&.
51 .SS "Launch as a system service (d\(aemon)\&."
53 Here follows an example on how to launch mpd\-sima as a service on your system, not attach to regular user configuration/database\&.
55 \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
56 .SS "Launch in user land"
58 Launching mpd\-sima from/whithin your user account is easy, you can simply call
60 from your shell or one of the following command:
62 Background execution (d\(aemonise), log in the specified file, save pid:
64 \fBmpd\-sima \-\-daemon \-\-pid=$HOME/var/run/mpd\-sima\&.pid \-\-log=$HOME/var/log/mpd\-sima\&.log\fR
66 Foreground execution, connect
67 \fImy\&.mpd\&.server\&.org\fR, log to std(out|err):
69 \fBmpd\-sima \-\-host=my\&.mpd\&.server\&.org\fR
72 The program follows the usual GNU command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
74 \fB\-h\fR, \fB\-\-help\fR
76 Print help and exit\&.
81 Print version and exit\&.
86 Start as a daemon\&. Log redirected to /dev/null, usually setting
90 options in daemon mode are a good idea to monitor/stop the process\&.
93 \fB\-p \fR\fB\fIpid_file\fR\fR, \fB\-\-pid=\fR\fB\fIpid_file\fR\fR
99 Default is not to store pid info\&.
102 \fB\-l \fR\fB\fIlog_file\fR\fR, \fB\-\-log=\fR\fB\fIlog_file\fR\fR
104 Use the specific file
106 to log messages to\&.
108 Default is to log to stdout/stderr\&.
111 \fB\-v \fR\fB\fIlog_level\fR\fR, \fB\-\-log\-level=\fR\fB\fIlog_level\fR\fR
113 Verbosity in [debug,info,warning,error]\&.
115 Default is to log info messages\&.
118 \fB\-c \fR\fB\fIconf_file\fR\fR, \fB\-\-config=\fR\fB\fIconf_file\fR\fR
120 Use the specific file
122 to set up configuration instead of looking for the default user configuration file\&.
124 Default is to look for
125 \fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR\&. Concerning this file see also
126 the section called \(lqFILES\(rq\&.
128 Pay attention: Because you load a specific configuration file from command line interface
130 it will override others options pass to mpd_sima\&. In other words launching with
132 will override port setting whatever the configuration file your using, default or command line specified\&.
135 \fB\-\-var_dir=\fR\fB\fIvar_directory\fR\fR
137 Use the specific path
139 to look for (or create) var files (ie\&. database) instead of looking at the default user data location\&.
141 Default is to look in
142 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
145 the section called \(lqFILES\(rq
150 Create the database and exit\&. Uses folder specified with
152 or default directory\&.
155 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
158 the section called \(lqFILES\(rq
161 \fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR
163 Use the specific host
170 or a fully qualified domain name as long as your system can resolve it\&. This overrides
172 environment variable\&.
178 the section called \(lqENVIRONMENT\(rq\&.
181 \fB\-P \fR\fB\fImpd_port\fR\fR, \fB\-\-port=\fR\fB\fImpd_port\fR\fR
183 Use the specific port number
185 on MPD server\&. This overrides
187 environment variable\&.
193 the section called \(lqENVIRONMENT\(rq
197 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
199 The per\-user configuration file\&. Usually
200 \fBXDG_CONFIG_HOME\fR
205 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
207 SQLite database\&. Usually
210 ${HOME}/\&.local/share\&.
214 \fBMPD_HOST\fR, \fBMPD_PORT\fR
216 mpd\-sima will look for
220 to override built\-in configuration (set to "localhost:6600")\&.
224 syntax as documented in mpc manual, cf\&.
228 To use a password, provide a value of the form "password@host"\&.
235 is read if present\&. Otherwise built\-in defaults are used\&. An example should be provided in the tarball within
236 doc/examples/mpd_sima\&.cfg\&. On Debian system please look in
237 /usr/share/doc/mpd\-sima\&.
242 Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env\&. var\&. if set)\&.
244 The default behavior is to add one track, this track is to be chosen among titles from artists similar to the artist of the currently played track\&. MPD_sima will add one track when the play list is one track long\&.
246 To change these defaults, use the configuration file
251 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
252 \m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&.
255 users are welcome to join the dedicated chat room at
256 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
261 \fBmpd-sima.cfg\fR(5)
263 /usr/share/doc/mpd\-sima/
266 \fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
268 Wrote this man page and is currently leading MPD_sima project\&.
272 Copyright \(co 2009-2014 Jack Kaliko
275 This manual page was written for the Debian system (and may be used by others)\&.
277 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\&.
279 On Debian systems, the complete text of the GNU General Public License can be found in
280 /usr/share/common\-licenses/GPL\&.