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