Add new command purge-history

[mpd-sima.git] / data / man / mpd-sima.1

diff --git a/data/man/mpd-sima.1 b/data/man/mpd-sima.1
index 618142d19a10cd3edfb856ab4d909c6444167b77..7d039e1aac5837ada1beeac78aa76613a6aeeebc 100644 (file)
--- a/data/man/mpd-sima.1
+++ b/data/man/mpd-sima.1
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: mpd-sima
-.\"    Author: Jack Kaliko <kaliko@azylum.org>
-.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 11/14/2019
-.\"    Manual: mpd-sima 0.15.2 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" "11/14/2019" "mpd-sima" "mpd-sima 0.15.2 User Manual"
+.TH "MPD\-SIMA" "1" "04/23/2021" "mpd-sima" "mpd-sima 0.17.0 User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -33,11 +33,15 @@ mpd-sima \- mpd\-sima will try to maintain some titles ahead in the queue follow
 .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]
 .HP \w'\fBmpd\-sima\fR\ 'u
-\fBmpd\-sima\fR \-\-create\-db [\fB\-\-var\-dir=\fR\fIvar_directory\fR]
+\fBmpd\-sima\fR {{\fB\-h\fR\ |\ \fB\-\-help\fR}\ \fB\-\-version\fR} 
 .HP \w'\fBmpd\-sima\fR\ 'u
-\fBmpd\-sima\fR \-\-generate\-config [\fB\&...\fR]
+\fBmpd\-sima\fR config\-test [\fB\-\-config=\fR\fIconf_file\fR]
 .HP \w'\fBmpd\-sima\fR\ 'u
-\fBmpd\-sima\fR {{\fB\-h\fR\ |\ \fB\-\-help\fR}\ \fB\-\-version\fR} 
+\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
@@ -148,25 +152,7 @@ Default is to look in
 \fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning
 \fB$XDG_DATA_HOME\fR
 see also
-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
-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
@@ -203,6 +189,52 @@ Default is
 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
@@ -272,11 +304,11 @@ doc/examples/\&. On Debian system please look in
 .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 get the defaults as detected by mpd\-sima on your system you can run mpd\-sima to print the config:
 .sp
-\fBmpd\-sima \-\-generate\-config\fR
+\fBmpd\-sima generate\-config\fR
 .RE
 .PP
 For details about mpd_sima\&.cfg refer to the manual
@@ -297,13 +329,13 @@ 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-2019 Jack Kaliko
+Copyright \(co 2009-2021 kaliko
 .br
 .PP
 This manual page was written for the Debian system (and may be used by others)\&.