data/man/mpd-sima.1

   1 '\" t
   2 .\"     Title: mpd-sima
   3 .\"    Author: Jack Kaliko <kaliko@azylum.org>
   4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
   5 .\"      Date: 06/12/2014
   6 .\"    Manual: mpd-sima 0.12.0 User Manual
   7 .\"    Source: mpd-sima
   8 .\"  Language: English
   9 .\"
  10 .TH "MPD\-SIMA" "1" "06/12/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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 mpd-sima \- mpd\-sima will try to maintain some titles ahead in the queue following different policies\&.
  32 .SH "SYNOPSIS"
  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]
  39 .SH "DESCRIPTION"
  40 .PP
  41 This manual page documents briefly the
  42 \fBmpd\-sima\fR
  43 commands\&.
  44 .PP
  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\&. See also environment variables special case for MPD host and port in
  50 the section called \(lqENVIRONMENT\(rq\&.
  51 .SH "EXAMPLE"
  52 .SS "Launch as a system service (d\(aemon)\&."
  53 .PP
  54 Here follows an example on how to launch mpd\-sima as a service on your system, not attach to regular user configuration/database\&.
  55 .PP
  56 \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
  57 .SS "Launch in user land"
  58 .PP
  59 Launching mpd\-sima from/whithin your user account is easy, you can simply call
  60 \fBmpd\-sima\fR
  61 from your shell or one of the following command:
  62 .PP
  63 Background execution (d\(aemonise), log in the specified file, save pid:
  64 .PP
  65 \fBmpd\-sima \-\-daemon \-\-pid=$HOME/var/run/mpd\-sima\&.pid \-\-log=$HOME/var/log/mpd\-sima\&.log\fR
  66 .PP
  67 Foreground execution, connect
  68 \fImy\&.mpd\&.server\&.org\fR, log to std(out|err):
  69 .PP
  70 \fBmpd\-sima \-\-host=my\&.mpd\&.server\&.org\fR
  71 .SH "OPTIONS"
  72 .PP
  73 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 .PP
  75 \fB\-h\fR, \fB\-\-help\fR
  76 .RS 4
  77 Print help and exit\&.
  78 .RE
  79 .PP
  80 \fB\-\-version\fR
  81 .RS 4
  82 Print version and exit\&.
  83 .RE
  84 .PP
  85 \fB\-\-daemon\fR
  86 .RS 4
  87 Start as a daemon\&. Log redirected to /dev/null, usually setting
  88 \fB\-\-log\fR
  89 and
  90 \fB\-\-pid\fR
  91 options in daemon mode are a good idea to monitor/stop the process\&.
  92 .RE
  93 .PP
  94 \fB\-p \fR\fB\fIpid_file\fR\fR, \fB\-\-pid=\fR\fB\fIpid_file\fR\fR
  95 .RS 4
  96 Use the specific file
  97 \fIpid_file\fR
  98 to store pid to\&.
  99 .br
 100 Default is not to store pid info\&.
 101 .RE
 102 .PP
 103 \fB\-l \fR\fB\fIlog_file\fR\fR, \fB\-\-log=\fR\fB\fIlog_file\fR\fR
 104 .RS 4
 105 Use the specific file
 106 \fIlog_file\fR
 107 to log messages to\&.
 108 .br
 109 Default is to log to stdout/stderr\&.
 110 .RE
 111 .PP
 112 \fB\-v \fR\fB\fIlog_level\fR\fR, \fB\-\-log\-level=\fR\fB\fIlog_level\fR\fR
 113 .RS 4
 114 Verbosity in [debug,info,warning,error]\&.
 115 .br
 116 Default is to log info messages\&.
 117 .RE
 118 .PP
 119 \fB\-c \fR\fB\fIconf_file\fR\fR, \fB\-\-config=\fR\fB\fIconf_file\fR\fR
 120 .RS 4
 121 Use the specific file
 122 \fIconf_file\fR
 123 to set up configuration instead of looking for the default user configuration file\&.
 124 .br
 125 Default is to look for
 126 \fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR\&.
 127 .br
 128
 129 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\&.
 130 .br
 131
 132 For more details on configuration file cf\&.
 133 \fBmpd_sima.cfg\fR(5), see also
 134 the section called \(lqFILES\(rq\&.
 135 .br
 136
 137 .RE
 138 .PP
 139 \fB\-\-var_dir=\fR\fB\fIvar_directory\fR\fR
 140 .RS 4
 141 Use the specific path
 142 \fIvar_directory\fR
 143 to look for (or create) var files (ie\&. database) instead of looking at the default user data location\&.
 144 .br
 145 Default is to look in
 146 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
 147 \fB$XDG_DATA_HOME\fR
 148 see also
 149 the section called \(lqFILES\(rq
 150 .RE
 151 .PP
 152 \fB\-\-create\-db\fR
 153 .RS 4
 154 Create the database and exit\&. Uses folder specified with
 155 \fB\-\-var_dir\fR
 156 or default directory\&.
 157 .br
 158 Default is to use
 159 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
 160 \fB$XDG_DATA_HOME\fR
 161 see also
 162 the section called \(lqFILES\(rq
 163 .RE
 164 .PP
 165 \fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR
 166 .RS 4
 167 Use the specific host
 168 \fImpd_host\fR
 169 as MPD server\&.
 170 .br
 171 \fImpd_host\fR
 172 can be an
 173 IP
 174 or a fully qualified domain name as long as your system can resolve it\&. This overrides
 175 \fBMPD_HOST\fR
 176 environment variable\&.
 177 .br
 178 Default is
 179 \fIlocalhost\fR\&.
 180 .sp
 181 See also
 182 the section called \(lqENVIRONMENT\(rq\&.
 183 .RE
 184 .PP
 185 \fB\-P \fR\fB\fImpd_port\fR\fR, \fB\-\-port=\fR\fB\fImpd_port\fR\fR
 186 .RS 4
 187 Use the specific port number
 188 \fImpd_port\fR
 189 on MPD server\&. This overrides
 190 \fBMPD_PORT\fR
 191 environment variable\&.
 192 .br
 193 Default is
 194 \fI6600\fR\&.
 195 .sp
 196 See also
 197 the section called \(lqENVIRONMENT\(rq
 198 .RE
 199 .SH "FILES"
 200 .PP
 201 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
 202 .RS 4
 203 Configuration file\&.
 204 .RE
 205 .PP
 206 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
 207 .RS 4
 208 SQLite DB file\&.
 209 .RE
 210 .PP
 211 ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
 212 .RS 4
 213 Persistent http cache\&.
 214 .RE
 215 .PP
 216 Usually
 217 \fBXDG_DATA_HOME\fR
 218 is set to
 219 ${HOME}/\&.local/share
 220 and
 221 \fBXDG_CONFIG_HOME\fR
 222 to
 223 ${HOME}/\&.config\&.
 224 .br
 225 You may override them using command line option
 226 \fB\-\-var_dir\fR
 227 (cf\&.
 228 \fBmpd_sima\fR(1))
 229 .SH "ENVIRONMENT"
 230 .PP
 231 \fBMPD_HOST\fR, \fBMPD_PORT\fR
 232 .RS 4
 233 mpd\-sima will look for
 234 \fBMPD_HOST\fR
 235 and
 236 \fBMPD_PORT\fR
 237 to override built\-in configuration (set to "localhost:6600")\&.
 238 .sp
 239 mpd\-sima expects
 240 \fBMPD_HOST\fR
 241 syntax as documented in mpc manual, cf\&.
 242 \fBmpc\fR(1)\&.
 243
 244 .br
 245 To use a password, provide a value of the form "password@host"\&.
 246 .RE
 247 .SH "CONFIGURATION"
 248 .PP
 249 mpd_sima\&.cfg
 250 .RS 4
 251 mpd_sima\&.cfg
 252 is read if present\&. Otherwise built\-in defaults are used\&. An example should be provided in the tarball within
 253 doc/examples/\&. On Debian system please look in
 254 /usr/share/doc/mpd\-sima\&.
 255 .RE
 256 .PP
 257 DEFAULTS
 258 .RS 4
 259 Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env\&. var\&. if set)\&.
 260 .sp
 261 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 unplayed queue is one track long\&.
 262 .sp
 263 To change these defaults, use the configuration file
 264 mpd_sima\&.cfg
 265 .RE
 266 .PP
 267 For details about mpd_sima\&.cfg refer to the manual
 268 \fBmpd_sima.cfg\fR(5)
 269 .SH "FEEDBACK/BUGS"
 270 .PP
 271 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
 272 \m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&.
 273 .PP
 274 XMPP
 275 users are welcome to join the dedicated chat room at
 276 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
 277 .SH "SEE ALSO"
 278 .PP
 279 \fBmpc\fR(1),
 280 \fBmpd\fR(1)
 281 .PP
 282 /usr/share/doc/mpd\-sima/
 283 .SH "AUTHOR"
 284 .PP
 285 \fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
 286 .RS 4
 287 Wrote this man page and is currently leading MPD_sima project\&.
 288 .RE
 289 .SH "COPYRIGHT"
 290 .br
 291 Copyright \(co 2009-2014 Jack Kaliko
 292 .br
 293 .PP
 294 This manual page was written for the Debian system (and may be used by others)\&.
 295 .PP
 296 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\&.
 297 .PP
 298 On Debian systems, the complete text of the GNU General Public License can be found in
 299 /usr/share/common\-licenses/GPL\&.
 300 .sp