X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fsimadb_cli.1.xml;fp=data%2Fman%2Fsimadb_cli.1.xml;h=0000000000000000000000000000000000000000;hb=3636f8f37183e1b1f1c581b4edfff1b1abd70462;hp=6bab00402194cb068e2b9746a8fd5d3dbd9bb17d;hpb=5de446a3d7e67a95afa7cff1c9c12642daeaf8ce;p=mpd-sima.git

diff --git a/data/man/simadb_cli.1.xml b/data/man/simadb_cli.1.xml
deleted file mode 100644
index 6bab004..0000000
--- a/data/man/simadb_cli.1.xml
+++ /dev/null
@@ -1,255 +0,0 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<!--
-
-`xsltproc -''-nonet \
-          -''-param man.charmap.use.subset "0" \
-          -''-param make.year.ranges "1" \
-          -''-param make.single.year.ranges "1" \
-          /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
-          manpage.xml'
-
-A manual page <package>.<section> will be generated. You may view the
-manual page with: nroff -man <package>.<section> | less'. A typical entry
-in a Makefile or Makefile.am is:
-
-DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
-XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
-
-manpage.1: manpage.xml
-        $(XP) $(DB2MAN) $<
-
-The xsltproc binary is found in the xsltproc package. The XSL files are in
-docbook-xsl. A description of the parameters you can use can be found in the
-docbook-xsl-doc-* packages. Please remember that if you create the nroff
-version in one of the debian/rules file targets (such as build), you will need
-to include xsltproc and docbook-xsl in your Build-Depends control field.
-Alternatively use the xmlto command/package. That will also automatically
-pull in xsltproc and docbook-xsl.
-
-Notes for using docbook2x: docbook2x-man does not automatically create the
-AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
-<refsect1> ... </refsect1>.
-
-To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
-read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
-found in the docbook-xsl-doc-html package.
-
-Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
-
-General documentation about man-pages and man-page-formatting:
-man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
-
--->
-<!DOCTYPE refentry [
-
-  <!ENTITY dhsection   "1">
-  <!ENTITY dhpackage "mpd-sima">
-  <!ENTITY dhutils "simadb_cli">
-
-]>
-
-<refentry xmlns="http://docbook.org/ns/docbook"
-          xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0">
-  <xi:include href="info.xml" />
-  <refmeta>
-      <refentrytitle>&dhutils;</refentrytitle>
-      <manvolnum>&dhsection;</manvolnum>
-  </refmeta>
-    <refnamediv>
-        <refname>&dhutils;</refname>
-        <refpurpose>&dhutils; is a command line interface editor for the sima user DB.</refpurpose>
-    </refnamediv>
-    <refsynopsisdiv>
-        <cmdsynopsis><!-- EDIT (RM ARTIST) OPTIONS -->
-            <command>&dhutils;</command>
-            <arg choice="plain"><option>--remove_artist=</option><replaceable class="parameter">artist</replaceable></arg>
-            <arg choice="opt">
-                <option>--dbfile=</option><replaceable class="option">db_file</replaceable>
-            </arg>
-            <arg choice="opt">
-                <option>--reciprocal</option>
-            </arg>
-        </cmdsynopsis>
-        <cmdsynopsis><!-- EDIT (PURGE HIST) OPTIONS -->
-            <command>&dhutils;</command>
-            <arg choice="plain"><option>--purge_hist</option></arg>
-            <arg choice="opt">
-                <option>--dbfile=</option><replaceable class="option">db_file</replaceable>
-            </arg>
-        </cmdsynopsis>
-        <cmdsynopsis><!-- VIEW ALL ENTRIES OPTIONS -->
-            <command>&dhutils;</command>
-            <arg choice="plain"><option>--view_all</option></arg>
-            <arg choice="opt">
-                <option>--dbfile=</option><replaceable class="option">db_file</replaceable>
-            </arg>
-        </cmdsynopsis>
-        <cmdsynopsis><!-- EDIT (BLACK LIST) OPTIONS -->
-            <command>&dhutils;</command>
-            <group choice="req">
-                <arg choice="plain"><option>--bl_curr_trk</option></arg>
-                <arg choice="plain"><option>--bl_curr_art</option></arg>
-                <arg choice="plain"><option>--bl_curr_alb</option></arg>
-                <arg choice="plain"><option>--bl_art=</option><replaceable class="parameter">artist_name</replaceable></arg>
-            </group>
-            <arg choice="opt">
-                <arg choice="plain"><option>--dbfile=</option><replaceable class="parameter">db_file</replaceable></arg>
-            </arg>
-            <arg choice="opt">
-                <arg choice="plain"><option>--host=</option><replaceable class="option">mpd_host</replaceable></arg>
-            </arg>
-            <arg choice="opt">
-                <arg choice="plain"><option>--port=</option><replaceable class="option">mpd_port</replaceable></arg>
-            </arg>
-        </cmdsynopsis>
-        <cmdsynopsis><!-- EDIT (RM BL) OPTIONS -->
-            <command>&dhutils;</command>
-            <arg choice="plain"><option>--remove_bl=</option><replaceable class="parameter">row_id</replaceable></arg>
-            <arg choice="opt">
-                <option>--dbfile=</option><replaceable class="option">db_file</replaceable>
-            </arg>
-        </cmdsynopsis>
-        <cmdsynopsis><!-- VIEW BL OPTIONS -->
-            <command>&dhutils;</command>
-            <arg choice="plain"><option>--view_bl</option></arg>
-            <arg choice="opt">
-                <option>--dbfile=</option><replaceable class="option">db_file</replaceable>
-            </arg>
-        </cmdsynopsis>
-        <cmdsynopsis><!-- HELP/VERSION -->
-            <command>&dhutils;</command>
-            <!-- Normally the help and version options make the programs stop
-            right after outputting the requested information. -->
-            <group choice="req">
-                <arg choice="plain">
-                    <group choice="req">
-                        <arg choice="plain"><option>-h</option></arg>
-                        <arg choice="plain"><option>--help</option></arg>
-                    </group>
-                </arg>
-                <arg choice="plain"><option>--version</option></arg>
-            </group>
-        </cmdsynopsis>
-    </refsynopsisdiv>
-    <refsect1 id="description">
-        <title>DESCRIPTION</title>
-        <para>This manual page documents briefly the
-            <command>&dhutils;</command> commands.</para>
-        <para>simadb_cli is a command line interface to get and edit users
-            blacklist database used with MPD_sima. The default
-            database file (see <xref linkend="files"/>) can be overridden if
-            you want.</para>
-    </refsect1>
-    <refsect1 id="example">
-        <title>EXAMPLE</title>
-        <refsect2 id="blacklist">
-            <title>Black list edition</title>
-            <para><emphasis>Adding to black list.</emphasis> You can add a single
-                track, an album or an artist to the black list. The element to
-                black list is chosen from the currently playing track. Use
-                <option>--bl_curr_trk</option> to prevent &dhutils; to queue this
-                track, <option>--bl_curr_alb</option> or <option>--bl_curr_art</option> respectively for the album and the
-                artist.
-            </para>
-            <para>Remember you need access to your MPD server to retrieve
-                information to black list. Defaults are localhost:6600 or found in
-                environment variables but you may set it up from command
-                line:
-            </para>
-            <para><command>&dhutils; --bl_curr_art -S mympd.example.org</command></para>
-            <para>
-                <emphasis>To black list a specific artist</emphasis> (not
-                currently playing) you can use <option>--bl_ar="Artist name to black list"</option>.
-            </para>
-        </refsect2>
-    </refsect1>
-    <refsect1 id="options">
-        <title>OPTIONS</title>
-        <para>The program follows the usual GNU command line syntax,
-            with long options starting with two dashes ("-").  A summary of
-            options is included below.</para>
-        <variablelist>
-            <!-- Use the variablelist.term.separator and the
-            variablelist.term.break.after parameters to
-            control the term elements. -->
-            <varlistentry> <!-- help -->
-                <term><option>-h</option></term>
-                <term><option>--help</option></term>
-                <listitem>
-                    <para>Print help and exit.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry> <!-- version -->
-                <term><option>--version</option></term>
-                <listitem>
-                    <para>Print version and exit.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry> <!-- black list artist -->
-                <term><option>--bl_art=<replaceable class="parameter">artist_name</replaceable></option></term>
-                <listitem>
-                    <para>Use to black list <replaceable class="parameter">artist_name</replaceable>. &dhutils; is checking <replaceable class="parameter">artist_name</replaceable> is actually in MPD music library (cf <option>-S</option> and <option>-P</option> options to set MPD host/address if necessary).</para>
-                    <para>If <replaceable class="parameter">artist_name</replaceable> is not found the script print out a list of matching artists.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry> <!-- black list -->
-                <term><option>--bl_curr_trk</option> | <option>--bl_curr_art</option> | <option>--bl_curr_alb</option></term>
-                <listitem>
-                    <para>Use to black list the currently playing track|artist|album. You need access to your MPD server, use <option>-S</option> and <option>-P</option> to set MPD host/address if necessary.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry> <!-- dbfile -->
-                <term><option>-d <replaceable class="parameter">db_file</replaceable></option></term>
-                <term><option>--dbfile=<replaceable class="parameter">db_file</replaceable></option></term>
-                <listitem>
-                    <para>Use the specific file <replaceable>db_file</replaceable> as database.<sbr />Default is too use <envar>XDG_DATA_HOME</envar> (see <xref linkend="files"/>).</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry> <!-- purge history -->
-                <term><option>--purge_hist</option></term>
-                <listitem>
-                    <para>Purge history, you may supply an alternative DB file with --dbfile option.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry> <!-- remove bl id -->
-                <term><option>--remove_bl=<replaceable class="parameter">row_id</replaceable></option></term>
-                <listitem>
-                    <para>Use to remove a black list entry. To get the row_id to suppress use <option>--view_bl</option> option.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry> <!-- view bl -->
-                <term><option>--view_bl</option></term>
-                <listitem>
-                    <para>Get all entries in the black list.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term><option>-P <replaceable class="parameter">mpd_port</replaceable></option></term>
-                <term><option>--port=<replaceable class="parameter">mpd_port</replaceable></option></term>
-                <listitem>
-                    <para>Use the specific port number <replaceable>mpd_port</replaceable> on MPD server. This overrides <envar>MPD_PORT</envar> environment variable.<sbr />Default is <emphasis>6600</emphasis>.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term><option>-S <replaceable class="parameter">mpd_host</replaceable></option></term>
-                <term><option>--host=<replaceable class="parameter">mpd_host</replaceable></option></term>
-                <listitem>
-                    <para>Use the specific host <replaceable>mpd_host</replaceable> as MPD server.<sbr /><replaceable>mpd_host</replaceable> can be an <acronym>IP</acronym> or a fully qualified domain name as long as your system can resolve it. This overrides <envar>MPD_HOST</envar> environment variable.<sbr />Default is <emphasis>localhost</emphasis>.</para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsect1>
-    <refsect1 id="files">
-        <title>FILES</title>
-        <variablelist>
-            <varlistentry>
-                <term><filename>${XDG_DATA_HOME}/mpd_sima/sima.db</filename></term>
-                <listitem>
-                    <para>SQLite DB file. Usually <envar>XDG_DATA_HOME</envar> is set to <filename>${HOME}/.local/share</filename>.</para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsect1>
-  <xi:include href="feedback.xml" />
-  <xi:include href="seealso.xml" />
-</refentry>