doc/manpages/man5/afp_voluuid.conf.5.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="afp_voluuid.conf.5">
   3
   4   <refmeta>
   5     <refentrytitle>afp_voluuid.conf</refentrytitle>
   6
   7     <manvolnum>5</manvolnum>
   8
   9     <refmiscinfo class="date">23 Mar 2012</refmiscinfo>
  10
  11     <refmiscinfo class="source">@NETATALK_VERSION@</refmiscinfo>
  12   </refmeta>
  13
  14   <refnamediv>
  15     <refname>afp_voluuid.conf</refname>
  16
  17     <refpurpose>Configuration file used by afpd(8) to specify UUID
  18         for Time Machine volume<indexterm>
  19         <primary>afp_voluuid.conf</primary>
  20       </indexterm></refpurpose>
  21   </refnamediv>
  22
  23   <refsect1>
  24     <title>Description</title>
  25
  26     <para><filename>@localstatedir@/netatalk/afp_voluuid.conf</filename> is the
  27     configuration file used by <command>afpd</command> to specify
  28     UUID of Time Machine volume automagically. The configuration
  29     lines are composed like:</para>
  30
  31     <para><replaceable>"volume name"</replaceable>
  32     <replaceable>uuid-string</replaceable></para>
  33
  34     <para>The first field is volume name. Volume names must be quoted
  35     if they contain spaces. The second field is the 36 character
  36     hexadecimal ASCII string representation of a UUID.</para>
  37     <para>The leading spaces and tabs are ignored. Blank lines are ignored.
  38     The lines prefixed with # are ignored. The illegal lines are ignored.
  39     </para>
  40
  41     <note>
  42         <para>This UUID is advertised by Zeroconf in order to provide
  43         robust disambiguation of Time Machine volume.</para>
  44         <para>The afpd generates the UUID from random numbers and saves it
  45         into afp_voluuid.conf, only when setting "time machine = yes" option
  46         in afp.conf.</para>
  47         <para>This file should not be thoughtlessly edited and be copied
  48         onto another server.</para>
  49     </note>
  50
  51     <para></para>
  52   </refsect1>
  53
  54   <refsect1>
  55     <title>Examples</title>
  56
  57     <example>
  58       <title>afp_voluuid.conf three TM volumes on one netatalk</title>
  59
  60       <programlisting># This is a comment.
  61 "Backup for John Smith" 1573974F-0ABD-69CC-C40A-8519B681A0E1
  62 "bob" 39A487F4-55AA-8240-E584-69AA01800FE9
  63 mary 6331E2D1-446C-B68C-3066-D685AADBE911</programlisting>
  64     </example>
  65   </refsect1>
  66
  67   <refsect1>
  68     <title>See also</title>
  69
  70     <para><citerefentry>
  71         <refentrytitle>afpd</refentrytitle>
  72
  73         <manvolnum>8</manvolnum>
  74       </citerefentry>, <citerefentry>
  75         <refentrytitle>afp.conf</refentrytitle>
  76
  77         <manvolnum>5</manvolnum>
  78       </citerefentry>, <citerefentry>
  79         <refentrytitle>avahi-daemon</refentrytitle>
  80
  81         <manvolnum>8</manvolnum>
  82       </citerefentry>, <citerefentry>
  83         <refentrytitle>mDNSResponder</refentrytitle>
  84
  85         <manvolnum>8</manvolnum>
  86       </citerefentry></para>
  87   </refsect1>
  88 </refentry>