Releasing 0.18.0

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

diff --git a/data/man/mpd-sima.1 b/data/man/mpd-sima.1
index b676ecd07df3d9249f8a854c6ce67de32d0cea1d..8e1b63d994336e3091a5f35bf4d7550e2711918a 100644 (file)
--- a/data/man/mpd-sima.1
+++ b/data/man/mpd-sima.1
@@ -2,12 +2,12 @@
 .\"     Title: mpd-sima
 .\"    Author: kaliko <kaliko@azylum.org>
 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
-.\"      Date: 04/22/2021
-.\"    Manual: mpd-sima 0.17.0 User Manual
+.\"      Date: 11/16/2021
+.\"    Manual: mpd-sima 0.18.0 User Manual
 .\"    Source: mpd-sima
 .\"  Language: English
 .\"
-.TH "MPD\-SIMA" "1" "04/22/2021" "mpd-sima" "mpd-sima 0.17.0 User Manual"
+.TH "MPD\-SIMA" "1" "11/16/2021" "mpd-sima" "mpd-sima 0.18.0 User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -40,6 +40,18 @@ mpd-sima \- mpd\-sima will try to maintain some titles ahead in the queue follow
 \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]
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR bl\-view
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR bl\-add\-artist [\fBartist\fR]
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR bl\-add\-album [\fBalbum\fR]
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR bl\-add\-track [\fBtrack\fR]
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR bl\-delete \fBid\fR
 .SH "DESCRIPTION"
 .PP
 This manual page documents briefly the
@@ -47,7 +59,7 @@ This manual page documents briefly the
 commands\&.
 .PP
 At start up default configuration is first overridden by user configuration in mpd_sima\&.cfg (see
-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
+the section called \(lqFILES\(rq) and finally command lines options are honored\&. For instance you can override default MPD host (localhost) in your configuration file or with
 \fB\-S\ \&my_mpd_server\fR
 option\&. For default configuration see
 the section called \(lqCONFIGURATION\(rq\&. See also environment variables special case for MPD host and port in
@@ -220,6 +232,51 @@ for more)\&.
 .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
+.PP
+\fBbl\-view\fR
+.RS 4
+View blocklist, useful to get entry IDs to remove with delete command\&.
+.RE
+.PP
+\fBbl\-add\-artist \fR\fB\fIartist\fR\fR
+.RS 4
+Add artist to the blocklist\&. If
+\fIartist\fR
+is not provided, try to get the currently playing artist\&.
+.RE
+.PP
+\fBbl\-add\-album \fR\fB\fIalbum\fR\fR
+.RS 4
+Add album to the blocklist\&. If
+\fIalbum\fR
+is not provided, try to get the currently playing album\&.
+.RE
+.PP
+\fBbl\-add\-track \fR\fB\fItrack\fR\fR
+.RS 4
+Add track to the blocklist\&. If
+\fItrack\fR
+is not provided, try to get the currently playing track\&.
+.RE
+.PP
+\fBbl\-delete \fR\fB\fIid\fR\fR
+.RS 4
+Remove blocklist entry referenced by its
+\fIid\fR\&. Use bloclist view command to get the id\&.
+.RE
 .SH "FILES"
 .PP
 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
@@ -284,7 +341,7 @@ mpd_sima\&.cfg
 mpd_sima\&.cfg
 is read if present\&. Otherwise built\-in defaults are used\&. An example should be provided in the tarball within
 doc/examples/\&. On Debian system please look in
-/usr/share/doc/mpd\-sima\&.
+/usr/share/doc/mpd_sima\&.
 .RE
 .PP
 DEFAULTS
@@ -293,7 +350,7 @@ Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env\&.
 .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