.\" Title: mpd-sima
.\" 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
+.\" 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
.\" -----------------------------------------------------------------
\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
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
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
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
.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
<!DOCTYPE refentry [
<!ENTITY dhsection "1">
- <!ENTITY dhpackage "mpd-sima">
+ <!ENTITY dhpackage "mpd_sima">
<!ENTITY dhutils "mpd-sima">
]>
<manvolnum>&dhsection;</manvolnum>
</refmeta>
<refnamediv>
- <refname>&dhpackage;</refname>
- <refpurpose>&dhpackage; will try to maintain some titles ahead in the queue following different policies.</refpurpose>
+ <refname>&dhutils;</refname>
+ <refpurpose>&dhutils; will try to maintain some titles ahead in the queue following different policies.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>&dhpackage;</command>
+ <command>&dhutils;</command>
<arg choice="opt"><option>--daemon</option></arg>
<arg choice="opt"><option>--config=</option><replaceable class="option">conf_file</replaceable></arg>
<arg choice="opt"><option>--var-dir=</option><replaceable class="option">var_directory</replaceable></arg>
<arg choice="opt"><option>--mpd_port=</option><replaceable class="option">mpd_port</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
- <command>&dhpackage;</command>
+ <command>&dhutils;</command>
<!-- Normally the help and version options make the programs stop
right after outputting the requested information. -->
<group choice="plain">
</group>
</cmdsynopsis>
<cmdsynopsis>
- <command>&dhpackage;</command>
+ <command>&dhutils;</command>
<arg choice="plain">config-test</arg>
<arg choice="opt"><option>--config=</option><replaceable class="option">conf_file</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
- <command>&dhpackage;</command>
+ <command>&dhutils;</command>
<arg choice="plain">create-db</arg>
<arg choice="opt"><option>--var-dir=</option><replaceable class="option">var_directory</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
- <command>&dhpackage;</command>
+ <command>&dhutils;</command>
<arg choice="plain">generate-config</arg>
<arg choice="opt"><option>…</option></arg>
</cmdsynopsis>
<cmdsynopsis>
- <command>&dhpackage;</command>
+ <command>&dhutils;</command>
<arg choice="plain">purge-history</arg>
<arg choice="opt"><option>--var-dir=</option><replaceable class="option">var_directory</replaceable></arg>
</cmdsynopsis>
+ <cmdsynopsis>
+ <command>&dhutils;</command>
+ <arg choice="plain">bl-view</arg>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ <command>&dhutils;</command>
+ <arg choice="plain">bl-add-artist</arg>
+ <arg choice="opt"><option>artist</option></arg>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ <command>&dhutils;</command>
+ <arg choice="plain">bl-add-album</arg>
+ <arg choice="opt"><option>album</option></arg>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ <command>&dhutils;</command>
+ <arg choice="plain">bl-add-track</arg>
+ <arg choice="opt"><option>track</option></arg>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ <command>&dhutils;</command>
+ <arg choice="plain">bl-delete</arg>
+ <arg choice="plain"><option>id</option></arg>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<para>This manual page documents briefly the
- <command>&dhpackage;</command> commands.</para>
+ <command>&dhutils;</command> commands.</para>
<para>At start up default configuration is first overridden by user
configuration in mpd_sima.cfg (see <xref linkend="files"/>) 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 <command>-S my_mpd_server</command> option. For default
+ default MPD host (localhost) in your configuration
+ file or with <command>-S my_mpd_server</command> option. For default
configuration see <xref linkend="configuration"/>. See also environment
variables special case for MPD host and port in <xref linkend="environment"/>.
</para>
<title>EXAMPLE</title>
<refsect2 id="daemon">
<title>Launch as a system service (dæmon).</title>
- <para>Here follows an example on how to launch &dhpackage; as a service on your system, not attach to regular user configuration/database.</para>
- <para><command>&dhpackage; --daemon --conf=/etc/mpd_sima.cfg --var-dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log</command></para>
+ <para>Here follows an example on how to launch &dhutils; as a service on your system, not attach to regular user configuration/database.</para>
+ <para><command>&dhutils; --daemon --conf=/etc/mpd_sima.cfg --var-dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log</command></para>
</refsect2>
<refsect2 id="user_land">
<title>Launch in user land</title>
- <para>Launching &dhpackage; from/whithin your user account is easy, you can simply call <command>&dhpackage;</command> from your shell or one of the following command:</para>
+ <para>Launching &dhutils; from/whithin your user account is easy, you can simply call <command>&dhutils;</command> from your shell or one of the following command:</para>
<para>Background execution (dæmonise), log in the specified file, save pid:</para>
- <para><command>&dhpackage; --daemon --pid=$HOME/var/run/mpd-sima.pid --log=$HOME/var/log/mpd-sima.log</command></para>
+ <para><command>&dhutils; --daemon --pid=$HOME/var/run/mpd-sima.pid --log=$HOME/var/log/mpd-sima.log</command></para>
<para>Foreground execution, connect <emphasis>my.mpd.server.org</emphasis>, log to std(out|err):</para>
- <para><command>&dhpackage; --host=my.mpd.server.org</command></para>
+ <para><command>&dhutils; --host=my.mpd.server.org</command></para>
</refsect2>
</refsect1>
<refsect1 id="options">
<para>Purge play history in the database and exit. Uses folder specified with <option>--var-dir</option> or default directory.<sbr />Default is to use <envar>$XDG_DATA_HOME/mpd_sima/</envar> (see <xref linkend="files"/> for more).</para>
</listitem>
</varlistentry>
+ <varlistentry> <!-- bl-view -->
+ <term><option>bl-view</option></term>
+ <listitem>
+ <para>View blocklist, useful to get entry IDs to remove with delete command.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <!-- bl-add-artist -->
+ <term><option>bl-add-artist <replaceable class="parameter">artist</replaceable></option></term>
+ <listitem>
+ <para>Add artist to the blocklist. If
+ <replaceable class="parameter">artist</replaceable>
+ is not provided, try to get the currently playing artist.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <!-- bl-add-album -->
+ <term><option>bl-add-album <replaceable class="parameter">album</replaceable></option></term>
+ <listitem>
+ <para>Add album to the blocklist. If
+ <replaceable class="parameter">album</replaceable>
+ is not provided, try to get the currently playing album.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <!-- bl-add-track -->
+ <term><option>bl-add-track <replaceable class="parameter">track</replaceable></option></term>
+ <listitem>
+ <para>Add track to the blocklist. If
+ <replaceable class="parameter">track</replaceable>
+ is not provided, try to get the currently playing track.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <!-- bl-delete -->
+ <term><option>bl-delete <replaceable class="parameter">id</replaceable></option></term>
+ <listitem>
+ <para>Remove blocklist entry referenced by its
+ <replaceable class="parameter">id</replaceable>. Use bloclist view command to get the id.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<xi:include href="files.xml" />
<term>DEFAULTS</term>
<listitem>
<para>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.</para>
- <para>The get the defaults as detected by &dhpackage; on your system you can run &dhpackage; to print the config:</para>
+ <para>The get the defaults as detected by &dhutils; on your system you can run &dhutils; to print the config:</para>
<para><command>&dhpackage; generate-config</command></para>
</listitem>
</varlistentry>
home / dev / repositories / mpd-sima.git / commitdiff