data/man/mpd-sima.1

   1 '\" t
   2 .\"     Title: mpd-sima
   3 .\"    Author: kaliko <kaliko@azylum.org>
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 04/22/2021
   6 .\"    Manual: mpd-sima 0.17.0 User Manual
   7 .\"    Source: mpd-sima
   8 .\"  Language: English
   9 .\"
  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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  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\-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 .SH "DESCRIPTION"
  44 .PP
  45 This manual page documents briefly the
  46 \fBmpd\-sima\fR
  47 commands\&.
  48 .PP
  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\&.
  55 .SH "EXAMPLE"
  56 .SS "Launch as a system service (d\(aemon)\&."
  57 .PP
  58 Here follows an example on how to launch mpd\-sima as a service on your system, not attach to regular user configuration/database\&.
  59 .PP
  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"
  62 .PP
  63 Launching mpd\-sima from/whithin your user account is easy, you can simply call
  64 \fBmpd\-sima\fR
  65 from your shell or one of the following command:
  66 .PP
  67 Background execution (d\(aemonise), log in the specified file, save pid:
  68 .PP
  69 \fBmpd\-sima \-\-daemon \-\-pid=$HOME/var/run/mpd\-sima\&.pid \-\-log=$HOME/var/log/mpd\-sima\&.log\fR
  70 .PP
  71 Foreground execution, connect
  72 \fImy\&.mpd\&.server\&.org\fR, log to std(out|err):
  73 .PP
  74 \fBmpd\-sima \-\-host=my\&.mpd\&.server\&.org\fR
  75 .SH "OPTIONS"
  76 .PP
  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\&.
  78 .PP
  79 \fB\-h\fR, \fB\-\-help\fR
  80 .RS 4
  81 Print help and exit\&.
  82 .RE
  83 .PP
  84 \fB\-\-version\fR
  85 .RS 4
  86 Print version and exit\&.
  87 .RE
  88 .PP
  89 \fB\-\-daemon\fR
  90 .RS 4
  91 Start as a daemon\&. Log redirected to /dev/null, usually setting
  92 \fB\-\-log\fR
  93 and
  94 \fB\-\-pid\fR
  95 options in daemon mode are a good idea to monitor/stop the process\&.
  96 .RE
  97 .PP
  98 \fB\-p \fR\fB\fIpid_file\fR\fR, \fB\-\-pid=\fR\fB\fIpid_file\fR\fR
  99 .RS 4
 100 Use the specific file
 101 \fIpid_file\fR
 102 to store pid to\&.
 103 .br
 104 Default is not to store pid info\&.
 105 .RE
 106 .PP
 107 \fB\-l \fR\fB\fIlog_file\fR\fR, \fB\-\-log=\fR\fB\fIlog_file\fR\fR
 108 .RS 4
 109 Use the specific file
 110 \fIlog_file\fR
 111 to log messages to\&.
 112 .br
 113 Default is to log to stdout/stderr\&.
 114 .RE
 115 .PP
 116 \fB\-v \fR\fB\fIlog_level\fR\fR, \fB\-\-log\-level=\fR\fB\fIlog_level\fR\fR
 117 .RS 4
 118 Verbosity in [debug,info,warning,error]\&.
 119 .br
 120 Default is to log info messages\&.
 121 .RE
 122 .PP
 123 \fB\-c \fR\fB\fIconf_file\fR\fR, \fB\-\-config=\fR\fB\fIconf_file\fR\fR
 124 .RS 4
 125 Use the specific file
 126 \fIconf_file\fR
 127 to set up configuration instead of looking for the default user configuration file\&.
 128 .br
 129 Default is to look for
 130 \fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR\&.
 131 .br
 132
 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\&.
 134 .br
 135
 136 For more details on configuration file cf\&.
 137 \fBmpd_sima.cfg\fR(5), see also
 138 the section called \(lqFILES\(rq\&.
 139 .br
 140
 141 .RE
 142 .PP
 143 \fB\-\-var\-dir=\fR\fB\fIvar_directory\fR\fR
 144 .RS 4
 145 Use the specific path
 146 \fIvar_directory\fR
 147 to look for (or create) var files (ie\&. database) instead of looking at the default user data location\&.
 148 .br
 149 Default is to look in
 150 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
 151 \fB$XDG_DATA_HOME\fR
 152 see also
 153 the section called \(lqFILES\(rq\&.
 154 .RE
 155 .PP
 156 \fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR
 157 .RS 4
 158 Use the specific host
 159 \fImpd_host\fR
 160 as MPD server\&.
 161 .br
 162 \fImpd_host\fR
 163 can be an
 164 IP
 165 or a fully qualified domain name as long as your system can resolve it\&. This overrides
 166 \fBMPD_HOST\fR
 167 environment variable\&.
 168 .br
 169 Default is
 170 \fIlocalhost\fR\&.
 171 .sp
 172 See also
 173 the section called \(lqENVIRONMENT\(rq\&.
 174 .RE
 175 .PP
 176 \fB\-P \fR\fB\fImpd_port\fR\fR, \fB\-\-port=\fR\fB\fImpd_port\fR\fR
 177 .RS 4
 178 Use the specific port number
 179 \fImpd_port\fR
 180 on MPD server\&. This overrides
 181 \fBMPD_PORT\fR
 182 environment variable\&.
 183 .br
 184 Default is
 185 \fI6600\fR\&.
 186 .sp
 187 See also
 188 the section called \(lqENVIRONMENT\(rq
 189 .RE
 190 .PP
 191 \fBconfig\-test\fR
 192 .RS 4
 193 Test configuration file and exit\&. Uses the configuration file specified with
 194 \fB\-\-config\fR
 195 or default location\&.
 196 .br
 197 Default is to use
 198 \fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR
 199 (see
 200 the section called \(lqFILES\(rq
 201 for more)\&.
 202 .sp
 203 config\-test tests MPD connection and Tags plugin configuration\&.
 204 .RE
 205 .PP
 206 \fBcreate\-db\fR
 207 .RS 4
 208 Create the database and exit\&. Uses folder specified with
 209 \fB\-\-var\-dir\fR
 210 or default directory\&.
 211 .br
 212 Default is to use
 213 \fB$XDG_DATA_HOME/mpd_sima/\fR
 214 (see
 215 the section called \(lqFILES\(rq
 216 for more)\&.
 217 .RE
 218 .PP
 219 \fBgenerate\-config\fR
 220 .RS 4
 221 Generate a sample configuration file according to the current CLI options and env\&. var\&.\&. The configuration is written on stdout\&.
 222 .RE
 223 .SH "FILES"
 224 .PP
 225 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
 226 .RS 4
 227 Configuration file\&.
 228 .RE
 229 .PP
 230 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
 231 .RS 4
 232 SQLite DB file\&.
 233 .RE
 234 .PP
 235 ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
 236 .RS 4
 237 Persistent http cache\&.
 238 .RE
 239 .PP
 240 Usually
 241 \fBXDG_DATA_HOME\fR
 242 is set to
 243 ${HOME}/\&.local/share
 244 and
 245 \fBXDG_CONFIG_HOME\fR
 246 to
 247 ${HOME}/\&.config\&.
 248 .br
 249 You may override them using command line option
 250 \fB\-\-var\-dir\fR
 251 and
 252 \fB\-\-config\fR
 253 (cf\&.
 254 \fBmpd-sima\fR(1))
 255 .SH "ENVIRONMENT"
 256 .PP
 257 \fBMPD_HOST\fR, \fBMPD_PORT\fR
 258 .RS 4
 259 mpd\-sima will look for
 260 \fBMPD_HOST\fR
 261 and
 262 \fBMPD_PORT\fR
 263 to override built\-in configuration (set to "localhost:6600")\&.
 264 .sp
 265 mpd\-sima expects
 266 \fBMPD_HOST\fR
 267 syntax as documented in mpc manual, cf\&.
 268 \fBmpc\fR(1)\&.
 269
 270 .br
 271 To use a password, provide a value of the form "password@host"\&.
 272 .RE
 273 .PP
 274 \fBHTTP_PROXY\fR, \fBHTTPS_PROXY\fR
 275 .RS 4
 276 mpd\-sima honors
 277 \fBHTTP_PROXY\fR
 278 environment variables\&.
 279 .RE
 280 .SH "CONFIGURATION"
 281 .PP
 282 mpd_sima\&.cfg
 283 .RS 4
 284 mpd_sima\&.cfg
 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\&.
 288 .RE
 289 .PP
 290 DEFAULTS
 291 .RS 4
 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\&.
 293 .sp
 294 The get the defaults as detected by mpd\-sima on your system you can run mpd\-sima to print the config:
 295 .sp
 296 \fBmpd\-sima generate\-config\fR
 297 .RE
 298 .PP
 299 For details about mpd_sima\&.cfg refer to the manual
 300 \fBmpd_sima.cfg\fR(5)
 301 .SH "FEEDBACK/BUGS"
 302 .PP
 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[]\&.
 305 .PP
 306 XMPP
 307 users are welcome to join the dedicated chat room at
 308 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
 309 .SH "SEE ALSO"
 310 .PP
 311 \fBmpc\fR(1),
 312 \fBmpd\fR(1)
 313 .PP
 314 /usr/share/doc/mpd\-sima/
 315 .SH "AUTHOR"
 316 .PP
 317 \fBkaliko\fR <\&kaliko@azylum\&.org\&>
 318 .RS 4
 319 Wrote this man page and is currently leading MPD_sima project\&.
 320 .RE
 321 .SH "COPYRIGHT"
 322 .br
 323 Copyright \(co 2009-2021 kaliko
 324 .br
 325 .PP
 326 This manual page was written for the Debian system (and may be used by others)\&.
 327 .PP
 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\&.
 329 .PP
 330 On Debian systems, the complete text of the GNU General Public License can be found in
 331 /usr/share/common\-licenses/GPL\&.
 332 .sp