'\" t
.\" Title: mpd-sima
-.\" Author: Jack Kaliko <kaliko@azylum.org>
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 06/11/2014
-.\" Manual: mpd-sima 0.12.0 User Manual
+.\" Author: kaliko <kaliko@azylum.org>
+.\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
+.\" Date: 04/23/2021
+.\" Manual: mpd-sima 0.17.0 User Manual
.\" Source: mpd-sima
.\" Language: English
.\"
-.TH "MPD\-SIMA" "1" "06/11/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual"
+.TH "MPD\-SIMA" "1" "04/23/2021" "mpd-sima" "mpd-sima 0.17.0 User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
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 {{\fB\-h\fR\ |\ \fB\-\-help\fR}\ \fB\-\-version\fR}
.HP \w'\fBmpd\-sima\fR\ 'u
-\fBmpd\-sima\fR [{\fB\-h\fR\ |\ \fB\-\-help\fR} | \fB\-\-version\fR]
+\fBmpd\-sima\fR config\-test [\fB\-\-config=\fR\fIconf_file\fR]
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR create\-db [\fB\-\-var\-dir=\fR\fIvar_directory\fR]
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR generate\-config [\fB\&...\fR]
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR purge\-history [\fB\-\-var\-dir=\fR\fIvar_directory\fR]
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
.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
.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
\fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
\fB$XDG_DATA_HOME\fR
see also
-the section called \(lqFILES\(rq
-.RE
-.PP
-\fB\-\-create\-db\fR
-.RS 4
-Create the database and exit\&. Uses folder specified with
-\fB\-\-var_dir\fR
-or default directory\&.
-.br
-Default is to use
-\fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
-\fB$XDG_DATA_HOME\fR
-see also
-the section called \(lqFILES\(rq
+the section called \(lqFILES\(rq\&.
.RE
.PP
\fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR
See also
the section called \(lqENVIRONMENT\(rq
.RE
+.PP
+\fBconfig\-test\fR
+.RS 4
+Test configuration file and exit\&. Uses the configuration file specified with
+\fB\-\-config\fR
+or default location\&.
+.br
+Default is to use
+\fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR
+(see
+the section called \(lqFILES\(rq
+for more)\&.
+.sp
+config\-test tests MPD connection and Tags plugin configuration\&.
+.RE
+.PP
+\fBcreate\-db\fR
+.RS 4
+Create the database and exit\&. Uses folder specified with
+\fB\-\-var\-dir\fR
+or default directory\&.
+.br
+Default is to use
+\fB$XDG_DATA_HOME/mpd_sima/\fR
+(see
+the section called \(lqFILES\(rq
+for more)\&.
+.RE
+.PP
+\fBgenerate\-config\fR
+.RS 4
+Generate a sample configuration file according to the current CLI options and env\&. var\&.\&. The configuration is written on stdout\&.
+.RE
+.PP
+\fBpurge\-history\fR
+.RS 4
+Purge play history in the database and exit\&. Uses folder specified with
+\fB\-\-var\-dir\fR
+or default directory\&.
+.br
+Default is to use
+\fB$XDG_DATA_HOME/mpd_sima/\fR
+(see
+the section called \(lqFILES\(rq
+for more)\&.
+.RE
.SH "FILES"
.PP
${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
.PP
${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
.RS 4
-Persistant http cache\&.
+Persistent http cache\&.
.RE
.PP
Usually
${HOME}/\&.config\&.
.br
You may override them using command line option
-\fB\-\-var_dir\fR
+\fB\-\-var\-dir\fR
+and
+\fB\-\-config\fR
(cf\&.
-\fBmpd_sima\fR(1))
+\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
.PP
DEFAULTS
.RS 4
-Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env\&. var\&. if set)\&.
+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\&.
.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 unplayed queue 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
.SH "FEEDBACK/BUGS"
.PP
The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
-\m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&.
+\m[blue]\fB\%https://kaliko.me/contact/\fR\m[]\&.
.PP
XMPP
users are welcome to join the dedicated chat room at
/usr/share/doc/mpd\-sima/
.SH "AUTHOR"
.PP
-\fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
+\fBkaliko\fR <\&kaliko@azylum\&.org\&>
.RS 4
Wrote this man page and is currently leading MPD_sima project\&.
.RE
.SH "COPYRIGHT"
.br
-Copyright \(co 2009-2014 Jack Kaliko
+Copyright \(co 2009-2021 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