data/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: 01/25/2014
   6 .\"    Manual: mpd-sima 0.12.0 User Manual
   7 .\"    Source: mpd-sima
   8 .\"  Language: English
   9 .\"
  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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  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 your play list 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\&.
  50 .SH "EXAMPLE"
  51 .SS "Launch as a system service (d\(aemon)\&."
  52 .PP
  53 Here follows an example on how to launch mpd\-sima as a service on your system, not attach to regular user configuration/database\&.
  54 .PP
  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"
  57 .PP
  58 Launching mpd\-sima from/whithin your user account is easy, you can simply call
  59 \fBmpd\-sima\fR
  60 from your shell or one of the following command:
  61 .PP
  62 Background execution (d\(aemonise), log in the specified file, save pid:
  63 .PP
  64 \fBmpd\-sima \-\-daemon \-\-pid=$HOME/var/run/mpd\-sima\&.pid \-\-log=$HOME/var/log/mpd\-sima\&.log\fR
  65 .PP
  66 Foreground execution, connect
  67 \fImy\&.mpd\&.server\&.org\fR, log to std(out|err):
  68 .PP
  69 \fBmpd\-sima \-\-host=my\&.mpd\&.server\&.org\fR
  70 .SH "OPTIONS"
  71 .PP
  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\&.
  73 .PP
  74 \fB\-h\fR, \fB\-\-help\fR
  75 .RS 4
  76 Print help and exit\&.
  77 .RE
  78 .PP
  79 \fB\-\-version\fR
  80 .RS 4
  81 Print version and exit\&.
  82 .RE
  83 .PP
  84 \fB\-\-daemon\fR
  85 .RS 4
  86 Start as a daemon\&. Log redirected to /dev/null, usually setting
  87 \fB\-\-log\fR
  88 and
  89 \fB\-\-pid\fR
  90 options in daemon mode are a good idea to monitor/stop the process\&.
  91 .RE
  92 .PP
  93 \fB\-p \fR\fB\fIpid_file\fR\fR, \fB\-\-pid=\fR\fB\fIpid_file\fR\fR
  94 .RS 4
  95 Use the specific file
  96 \fIpid_file\fR
  97 to store pid to\&.
  98 .br
  99 Default is not to store pid info\&.
 100 .RE
 101 .PP
 102 \fB\-l \fR\fB\fIlog_file\fR\fR, \fB\-\-log=\fR\fB\fIlog_file\fR\fR
 103 .RS 4
 104 Use the specific file
 105 \fIlog_file\fR
 106 to log messages to\&.
 107 .br
 108 Default is to log to stdout/stderr\&.
 109 .RE
 110 .PP
 111 \fB\-v \fR\fB\fIlog_level\fR\fR, \fB\-\-log\-level=\fR\fB\fIlog_level\fR\fR
 112 .RS 4
 113 Verbosity in [debug,info,warning,error]\&.
 114 .br
 115 Default is to log info messages\&.
 116 .RE
 117 .PP
 118 \fB\-c \fR\fB\fIconf_file\fR\fR, \fB\-\-config=\fR\fB\fIconf_file\fR\fR
 119 .RS 4
 120 Use the specific file
 121 \fIconf_file\fR
 122 to set up configuration instead of looking for the default user configuration file\&.
 123 .br
 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\&.
 127 .br
 128 Pay attention: Because you load a specific configuration file from command line interface
 129 \fIdoes not mean\fR
 130 it will override others options pass to mpd_sima\&. In other words launching with
 131 \fB\-P 6666\fR
 132 will override port setting whatever the configuration file your using, default or command line specified\&.
 133 .RE
 134 .PP
 135 \fB\-\-var_dir=\fR\fB\fIvar_directory\fR\fR
 136 .RS 4
 137 Use the specific path
 138 \fIvar_directory\fR
 139 to look for (or create) var files (ie\&. database) instead of looking at the default user data location\&.
 140 .br
 141 Default is to look in
 142 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
 143 \fB$XDG_DATA_HOME\fR
 144 see also
 145 the section called \(lqFILES\(rq
 146 .RE
 147 .PP
 148 \fB\-\-create\-db\fR
 149 .RS 4
 150 Create the database and exit\&. Uses folder specified with
 151 \fB\-\-var_dir\fR
 152 or default directory\&.
 153 .br
 154 Default is to use
 155 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
 156 \fB$XDG_DATA_HOME\fR
 157 see also
 158 the section called \(lqFILES\(rq
 159 .RE
 160 .PP
 161 \fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR
 162 .RS 4
 163 Use the specific host
 164 \fImpd_host\fR
 165 as MPD server\&.
 166 .br
 167 \fImpd_host\fR
 168 can be an
 169 IP
 170 or a fully qualified domain name as long as your system can resolve it\&. This overrides
 171 \fBMPD_HOST\fR
 172 environment variable\&.
 173 .br
 174 Default is
 175 \fIlocalhost\fR\&.
 176 .sp
 177 See also
 178 the section called \(lqENVIRONMENT\(rq\&.
 179 .RE
 180 .PP
 181 \fB\-P \fR\fB\fImpd_port\fR\fR, \fB\-\-port=\fR\fB\fImpd_port\fR\fR
 182 .RS 4
 183 Use the specific port number
 184 \fImpd_port\fR
 185 on MPD server\&. This overrides
 186 \fBMPD_PORT\fR
 187 environment variable\&.
 188 .br
 189 Default is
 190 \fI6600\fR\&.
 191 .sp
 192 See also
 193 the section called \(lqENVIRONMENT\(rq
 194 .RE
 195 .SH "FILES"
 196 .PP
 197 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
 198 .RS 4
 199 The per\-user configuration file\&. Usually
 200 \fBXDG_CONFIG_HOME\fR
 201 is set to
 202 ${HOME}/\&.config\&.
 203 .RE
 204 .PP
 205 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
 206 .RS 4
 207 SQLite database\&. Usually
 208 \fBXDG_DATA_HOME\fR
 209 is set to
 210 ${HOME}/\&.local/share\&.
 211 .RE
 212 .SH "ENVIRONMENT"
 213 .PP
 214 \fBMPD_HOST\fR, \fBMPD_PORT\fR
 215 .RS 4
 216 mpd\-sima will look for
 217 \fBMPD_HOST\fR
 218 and
 219 \fBMPD_PORT\fR
 220 to override built\-in configuration (set to "localhost:6600")\&.
 221 .sp
 222 mpd\-sima expects
 223 \fBMPD_HOST\fR
 224 syntax as documented in mpc manual, cf\&.
 225 \fBmpc\fR(1)\&.
 226
 227 .br
 228 To use a password, provide a value of the form "password@host"\&.
 229 .RE
 230 .SH "CONFIGURATION"
 231 .PP
 232 mpd_sima\&.cfg
 233 .RS 4
 234 mpd_sima\&.cfg
 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\&.
 238 .RE
 239 .PP
 240 DEFAULTS
 241 .RS 4
 242 Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env\&. var\&. if set)\&.
 243 .sp
 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\&.
 245 .sp
 246 To change these defaults, use the configuration file
 247 mpd_sima\&.cfg
 248 .RE
 249 .SH "FEEDBACK/BUGS"
 250 .PP
 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[]\&.
 253 .PP
 254 XMPP
 255 users are welcome to join the dedicated chat room at
 256 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
 257 .SH "SEE ALSO"
 258 .PP
 259 \fBmpc\fR(1),
 260 \fBmpd\fR(1),
 261 \fBmpd-sima.cfg\fR(5)
 262 .PP
 263 /usr/share/doc/mpd\-sima/
 264 .SH "AUTHOR"
 265 .PP
 266 \fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
 267 .RS 4
 268 Wrote this man page and is currently leading MPD_sima project\&.
 269 .RE
 270 .SH "COPYRIGHT"
 271 .br
 272 Copyright \(co 2009-2014 Jack Kaliko
 273 .br
 274 .PP
 275 This manual page was written for the Debian system (and may be used by others)\&.
 276 .PP
 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\&.
 278 .PP
 279 On Debian systems, the complete text of the GNU General Public License can be found in
 280 /usr/share/common\-licenses/GPL\&.
 281 .sp