Update documentation, generate manuals

[mpd-sima.git] / data / man / files.xml

diff --git a/data/man/files.xml b/data/man/files.xml
new file mode 100644 (file)
index 0000000..992d2b4
--- /dev/null
+++ b/data/man/files.xml
@@ -0,0 +1,32 @@
+<?xml version='1.0' encoding='UTF-8'?>
+    <refsect1 id="files">
+        <title>FILES</title>
+        <variablelist>
+          <varlistentry>
+              <term><filename>${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg</filename></term>
+              <listitem>
+                  <para>Configuration file.</para>
+              </listitem>
+          </varlistentry>
+            <varlistentry>
+                <term><filename>${XDG_DATA_HOME}/mpd_sima/sima.db</filename></term>
+                <listitem>
+                    <para>SQLite DB file.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term><filename>${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/</filename></term>
+                <listitem>
+                    <para>Persistant http cache.</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+        <para>Usually <envar>XDG_DATA_HOME</envar> is set to
+            <filename>${HOME}/.local/share</filename> and <envar>XDG_CONFIG_HOME</envar> to
+            <filename>${HOME}/.config</filename>.<sbr />You may override them using
+            command line option <option>--var_dir</option> (cf.
+            <citerefentry><refentrytitle>mpd_sima</refentrytitle>
+                <manvolnum>1</manvolnum></citerefentry>)</para>
+    </refsect1>
+<!-- vim:filetype=docbk
+-->