From 91b9903125b14867b0bada7c77a1dc4b055c74ec Mon Sep 17 00:00:00 2001 From: kaliko Date: Sun, 9 May 2021 18:17:34 +0200 Subject: [PATCH] Update manual --- data/man/mpd-sima.1 | 54 ++++++++++++++++++--- data/man/mpd_sima.1.xml | 101 +++++++++++++++++++++++++++++++++------- 2 files changed, 131 insertions(+), 24 deletions(-) diff --git a/data/man/mpd-sima.1 b/data/man/mpd-sima.1 index 7d039e1..8ebe6ad 100644 --- a/data/man/mpd-sima.1 +++ b/data/man/mpd-sima.1 @@ -2,12 +2,12 @@ .\" Title: mpd-sima .\" Author: kaliko .\" Generator: DocBook XSL Stylesheets v1.79.2 -.\" Date: 04/23/2021 -.\" Manual: mpd-sima 0.17.0 User Manual +.\" Date: 05/09/2021 +.\" Manual: mpd-sima 0.18.0.dev0 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "MPD\-SIMA" "1" "04/23/2021" "mpd-sima" "mpd-sima 0.17.0 User Manual" +.TH "MPD\-SIMA" "1" "05/09/2021" "mpd-sima" "mpd-sima 0.18.0.dev0 User Manu" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,6 +42,16 @@ mpd-sima \- mpd\-sima will try to maintain some titles ahead in the queue follow \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 @@ -49,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 @@ -235,6 +245,38 @@ Default is to use 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 @@ -299,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 @@ -308,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 diff --git a/data/man/mpd_sima.1.xml b/data/man/mpd_sima.1.xml index a67b4e5..9873396 100644 --- a/data/man/mpd_sima.1.xml +++ b/data/man/mpd_sima.1.xml @@ -43,7 +43,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ - + ]> @@ -56,12 +56,12 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ &dhsection; - &dhpackage; - &dhpackage; will try to maintain some titles ahead in the queue following different policies. + &dhutils; + &dhutils; will try to maintain some titles ahead in the queue following different policies. - &dhpackage; + &dhutils; conf_file var_directory @@ -72,7 +72,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ mpd_port - &dhpackage; + &dhutils; @@ -86,35 +86,59 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ - &dhpackage; + &dhutils; config-test conf_file - &dhpackage; + &dhutils; create-db var_directory - &dhpackage; + &dhutils; generate-config - &dhpackage; + &dhutils; purge-history var_directory + + &dhutils; + bl-view + + + &dhutils; + bl-add-artist + + + + &dhutils; + bl-add-album + + + + &dhutils; + bl-add-track + + + + &dhutils; + bl-delete + + DESCRIPTION This manual page documents briefly the - &dhpackage; commands. + &dhutils; commands. At start up default configuration is first overridden by user configuration in mpd_sima.cfg (see ) 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 -S my_mpd_server option. For default + default MPD host (localhost) in your configuration + file or with -S my_mpd_server option. For default configuration see . See also environment variables special case for MPD host and port in . @@ -123,16 +147,16 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ EXAMPLE Launch as a system service (dæmon). - Here follows an example on how to launch &dhpackage; as a service on your system, not attach to regular user configuration/database. - &dhpackage; --daemon --conf=/etc/mpd_sima.cfg --var-dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log + Here follows an example on how to launch &dhutils; as a service on your system, not attach to regular user configuration/database. + &dhutils; --daemon --conf=/etc/mpd_sima.cfg --var-dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log Launch in user land - Launching &dhpackage; from/whithin your user account is easy, you can simply call &dhpackage; from your shell or one of the following command: + Launching &dhutils; from/whithin your user account is easy, you can simply call &dhutils; from your shell or one of the following command: Background execution (dæmonise), log in the specified file, save pid: - &dhpackage; --daemon --pid=$HOME/var/run/mpd-sima.pid --log=$HOME/var/log/mpd-sima.log + &dhutils; --daemon --pid=$HOME/var/run/mpd-sima.pid --log=$HOME/var/log/mpd-sima.log Foreground execution, connect my.mpd.server.org, log to std(out|err): - &dhpackage; --host=my.mpd.server.org + &dhutils; --host=my.mpd.server.org @@ -246,6 +270,47 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ Purge play history in the database and exit. Uses folder specified with or default directory.Default is to use $XDG_DATA_HOME/mpd_sima/ (see for more). + + + + View blocklist, useful to get entry IDs to remove with delete command. + + + + + + Add artist to the blocklist. If + artist + is not provided, try to get the currently playing artist. + + + + + + + Add album to the blocklist. If + album + is not provided, try to get the currently playing album. + + + + + + + Add track to the blocklist. If + track + is not provided, try to get the currently playing track. + + + + + + + Remove blocklist entry referenced by its + id. Use bloclist view command to get the id. + + + @@ -290,7 +355,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ DEFAULTS 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. - The get the defaults as detected by &dhpackage; on your system you can run &dhpackage; to print the config: + The get the defaults as detected by &dhutils; on your system you can run &dhutils; to print the config: &dhpackage; generate-config -- 2.39.5