Add Docbook documentation to tree

[netatalk.git] / doc / manpages / man5 / afp_voluuid.conf.5.xml

diff --git a/doc/manpages/man5/afp_voluuid.conf.5.xml b/doc/manpages/man5/afp_voluuid.conf.5.xml
new file mode 100644 (file)
index 0000000..b91614e
--- /dev/null
+++ b/doc/manpages/man5/afp_voluuid.conf.5.xml
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry id="afp_voluuid.conf.5">
+
+  <refmeta>
+    <refentrytitle>afp_voluuid.conf</refentrytitle>
+
+    <manvolnum>5</manvolnum>
+
+    <refmiscinfo class="date">23 Mar 2012</refmiscinfo>
+
+    <refmiscinfo class="source">:NETATALK_VERSION:</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>afp_voluuid.conf</refname>
+
+    <refpurpose>Configuration file used by afpd(8) to specify UUID
+        for Time Machine volume<indexterm>
+        <primary>afp_voluuid.conf</primary>
+      </indexterm></refpurpose>
+  </refnamediv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><filename>:STATEDIR:/netatalk/afp_voluuid.conf</filename> is the
+    configuration file used by <command>afpd</command> to specify
+    UUID of Time Machine volume automagically. The configuration
+    lines are composed like:</para>
+
+    <para><replaceable>"volume name"</replaceable>
+    <replaceable>uuid-string</replaceable></para>
+
+    <para>The first field is volume name. Volume names must be quoted
+    if they contain spaces. The second field is the 36 character
+    hexadecimal ASCII string representation of a UUID.</para>
+    <para>The leading spaces and tabs are ignored. Blank lines are ignored.
+    The lines prefixed with # are ignored. The illegal lines are ignored.
+    </para>
+
+    <note>
+        <para>This UUID is advertised by Zeroconf in order to provide
+        robust disambiguation of Time Machine volume.</para>
+        <para>The afpd generates the UUID from random numbers and saves it
+        into afp_voluuid.conf, only when setting "time machine = yes" option
+        in afp.conf.</para>
+        <para>This file should not be thoughtlessly edited and be copied
+        onto another server.</para>
+    </note>
+
+    <para></para>
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+
+    <example>
+      <title>afp_voluuid.conf three TM volumes on one netatalk</title>
+
+      <programlisting># This is a comment.
+"Backup for John Smith" 1573974F-0ABD-69CC-C40A-8519B681A0E1
+"bob" 39A487F4-55AA-8240-E584-69AA01800FE9
+mary 6331E2D1-446C-B68C-3066-D685AADBE911</programlisting>
+    </example>
+  </refsect1>
+
+  <refsect1>
+    <title>See also</title>
+
+    <para><citerefentry>
+        <refentrytitle>afpd</refentrytitle>
+
+        <manvolnum>8</manvolnum>
+      </citerefentry>, <citerefentry>
+        <refentrytitle>afp.conf</refentrytitle>
+
+        <manvolnum>5</manvolnum>
+      </citerefentry>, <citerefentry>
+        <refentrytitle>avahi-daemon</refentrytitle>
+
+        <manvolnum>8</manvolnum>
+      </citerefentry>, <citerefentry>
+        <refentrytitle>mDNSResponder</refentrytitle>
+
+        <manvolnum>8</manvolnum>
+      </citerefentry></para>
+  </refsect1>
+</refentry>