.\" Title: mpd-sima
.\" Author: Jack Kaliko <kaliko@azylum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 01/25/2014
-.\" Manual: mpd-sima 0.12.0 User Manual
+.\" Date: 01/02/2016
+.\" Manual: mpd-sima 0.14.1 User Manual
.\" Source: mpd-sima
.\" Language: English
.\"
-.TH "MPD\-SIMA" "1" "01/25/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual"
+.TH "MPD\-SIMA" "1" "01/02/2016" "mpd-sima" "mpd-sima 0.14.1 User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-mpd-sima \- mpd\-sima will try to maintain some titles ahead in your play list following different policies\&.
+mpd-sima \- mpd\-sima will try to maintain some titles ahead in the queue following different policies\&.
.SH "SYNOPSIS"
.HP \w'\fBmpd\-sima\fR\ 'u
-\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]
+\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]
.HP \w'\fBmpd\-sima\fR\ 'u
-\fBmpd\-sima\fR [\fB\-\-var_dir=\fR\fIvar_directory\fR] [\fB\-\-create\-db>\fR]
+\fBmpd\-sima\fR \-\-create\-db [\fB\-\-var\-dir=\fR\fIvar_directory\fR]
.HP \w'\fBmpd\-sima\fR\ 'u
-\fBmpd\-sima\fR [{\fB\-h\fR\ |\ \fB\-\-help\fR} | \fB\-\-version\fR]
+\fBmpd\-sima\fR \-\-generate\-config [\fB\&...\fR]
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR {{\fB\-h\fR\ |\ \fB\-\-help\fR}\ \fB\-\-version\fR}
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
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
\fB\-S\ \&my_mpd_server\fR
option\&. For default configuration see
-the section called \(lqCONFIGURATION\(rq\&.
+the section called \(lqCONFIGURATION\(rq\&. See also environment variables special case for MPD host and port in
+the section called \(lqENVIRONMENT\(rq\&.
.SH "EXAMPLE"
.SS "Launch as a system service (d\(aemon)\&."
.PP
Here follows an example on how to launch mpd\-sima as a service on your system, not attach to regular user configuration/database\&.
.PP
-\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
+\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
.SS "Launch in user land"
.PP
Launching mpd\-sima from/whithin your user account is easy, you can simply call
to set up configuration instead of looking for the default user configuration file\&.
.br
Default is to look for
-\fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR\&. Concerning this file see also
+\fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR\&.
+.br
+
+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\&.
+.br
+
+For more details on configuration file cf\&.
+\fBmpd_sima.cfg\fR(5), see also
the section called \(lqFILES\(rq\&.
.br
-Pay attention: Because you load a specific configuration file from command line interface
-\fIdoes not mean\fR
-it will override others options pass to mpd_sima\&. In other words launching with
-\fB\-P 6666\fR
-will override port setting whatever the configuration file your using, default or command line specified\&.
+
.RE
.PP
-\fB\-\-var_dir=\fR\fB\fIvar_directory\fR\fR
+\fB\-\-var\-dir=\fR\fB\fIvar_directory\fR\fR
.RS 4
Use the specific path
\fIvar_directory\fR
the section called \(lqFILES\(rq
.RE
.PP
+\fB\-\-generate\-config\fR
+.RS 4
+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\&.
+.RE
+.PP
\fB\-\-create\-db\fR
.RS 4
Create the database and exit\&. Uses folder specified with
-\fB\-\-var_dir\fR
+\fB\-\-var\-dir\fR
or default directory\&.
.br
Default is to use
.PP
${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
.RS 4
-The per\-user configuration file\&. Usually
-\fBXDG_CONFIG_HOME\fR
-is set to
-${HOME}/\&.config\&.
+Configuration file\&.
.RE
.PP
${XDG_DATA_HOME}/mpd_sima/sima\&.db
.RS 4
-SQLite database\&. Usually
+SQLite DB file\&.
+.RE
+.PP
+${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
+.RS 4
+Persistent http cache\&.
+.RE
+.PP
+Usually
\fBXDG_DATA_HOME\fR
is set to
-${HOME}/\&.local/share\&.
-.RE
+${HOME}/\&.local/share
+and
+\fBXDG_CONFIG_HOME\fR
+to
+${HOME}/\&.config\&.
+.br
+You may override them using command line option
+\fB\-\-var\-dir\fR
+and
+\fB\-\-config\fR
+(cf\&.
+\fBmpd-sima\fR(1))
.SH "ENVIRONMENT"
.PP
\fBMPD_HOST\fR, \fBMPD_PORT\fR
.br
To use a password, provide a value of the form "password@host"\&.
.RE
+.PP
+\fBHTTP_PROXY\fR, \fBHTTPS_PROXY\fR
+.RS 4
+mpd\-sima honors
+\fBHTTP_PROXY\fR
+environment variables\&.
+.RE
.SH "CONFIGURATION"
.PP
mpd_sima\&.cfg
.RS 4
mpd_sima\&.cfg
is read if present\&. Otherwise built\-in defaults are used\&. An example should be provided in the tarball within
-doc/examples/mpd_sima\&.cfg\&. On Debian system please look in
+doc/examples/\&. On Debian system please look in
/usr/share/doc/mpd\-sima\&.
.RE
.PP
.RS 4
Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env\&. var\&. if set)\&.
.sp
-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\&.
+The get the defaults as detected by mpd\-sima on your system you can run mpd\-sima to print the config:
.sp
-To change these defaults, use the configuration file
-mpd_sima\&.cfg
+\fBmpd\-sima \-\-generate\-config\fR
.RE
+.PP
+For details about mpd_sima\&.cfg refer to the manual
+\fBmpd_sima.cfg\fR(5)
.SH "FEEDBACK/BUGS"
.PP
The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
.SH "SEE ALSO"
.PP
\fBmpc\fR(1),
-\fBmpd\fR(1),
-\fBmpd-sima.cfg\fR(5)
+\fBmpd\fR(1)
.PP
/usr/share/doc/mpd\-sima/
.SH "AUTHOR"
.RE
.SH "COPYRIGHT"
.br
-Copyright \(co 2009-2014 Jack Kaliko
+Copyright \(co 2009-2016 Jack Kaliko
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
home / dev / repositories / mpd-sima.git / blobdiff