X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd-sima.1;h=8e1b63d994336e3091a5f35bf4d7550e2711918a;hb=refs%2Ftags%2F0.18.0;hp=964e2e2685047df02c4ef76a992a236d986e7acf;hpb=081961f3b0570dadc2ce60c324181e66d1f66b59;p=mpd-sima.git diff --git a/data/man/mpd-sima.1 b/data/man/mpd-sima.1 index 964e2e2..8e1b63d 100644 --- a/data/man/mpd-sima.1 +++ b/data/man/mpd-sima.1 @@ -1,13 +1,13 @@ '\" t .\" Title: mpd-sima -.\" Author: Jack Kaliko -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 05/03/2020 -.\" Manual: mpd-sima 0.15.3 User Manual +.\" Author: kaliko +.\" Generator: DocBook XSL Stylesheets v1.79.2 +.\" Date: 11/16/2021 +.\" Manual: mpd-sima 0.18.0 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "MPD\-SIMA" "1" "05/03/2020" "mpd-sima" "mpd-sima 0.15.3 User Manual" +.TH "MPD\-SIMA" "1" "11/16/2021" "mpd-sima" "mpd-sima 0.18.0 User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,11 +33,25 @@ 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] +.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 @@ -45,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 @@ -148,25 +162,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 +199,84 @@ 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 +.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 @@ -267,16 +341,16 @@ 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 .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 +371,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-2020 Jack Kaliko +Copyright \(co 2009-2021 kaliko .br .PP This manual page was written for the Debian system (and may be used by others)\&.