doc/manpages/man8/afpd.8.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="afpd.8">
   3   <refmeta>
   4     <refentrytitle>afpd</refentrytitle>
   5
   6     <manvolnum>8</manvolnum>
   7
   8     <refmiscinfo class="date">19 Jan 2013</refmiscinfo>
   9
  10     <refmiscinfo class="source">@NETATALK_VERSION@</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv>
  14     <refname>afpd</refname>
  15
  16     <refpurpose>Apple Filing Protocol daemon</refpurpose>
  17   </refnamediv>
  18
  19   <refsynopsisdiv>
  20     <cmdsynopsis>
  21       <command>afpd<indexterm>
  22           <primary>afpd</primary>
  23         </indexterm></command>
  24
  25       <arg choice="opt">-d</arg>
  26
  27       <arg choice="opt">-F <replaceable>configfile</replaceable></arg>
  28
  29       <sbr />
  30
  31       <command>afpd<indexterm>
  32           <primary>afpd</primary>
  33         </indexterm></command>
  34
  35       <group choice="plain">
  36         <arg choice="plain">-v</arg>
  37         <arg choice="plain">-V</arg>
  38         <arg choice="plain">-h</arg>
  39       </group>
  40
  41     </cmdsynopsis>
  42   </refsynopsisdiv>
  43
  44   <refsect1>
  45     <title>Description</title>
  46
  47     <para><command>afpd</command> provides an Apple Filing Protocol (AFP)
  48     interface to the Unix file system. It is normally started at boot time
  49     by <command>netatalk</command>(8).</para>
  50
  51     <para><filename>@pkgconfdir@/afp.conf</filename> is the configuration file
  52     used by <command>afpd</command> to determine the behavior and
  53     configuration of a file server.</para>
  54
  55   </refsect1>
  56
  57   <refsect1>
  58     <title>Options</title>
  59
  60     <variablelist>
  61       <varlistentry>
  62         <term>-d</term>
  63
  64         <listitem>
  65           <para>Specifies that the daemon should not fork.</para>
  66         </listitem>
  67       </varlistentry>
  68
  69
  70       <varlistentry>
  71         <term>-v</term>
  72
  73         <listitem>
  74           <para>Print version information and exit.</para>
  75         </listitem>
  76       </varlistentry>
  77
  78       <varlistentry>
  79         <term>-V</term>
  80
  81         <listitem>
  82           <para>Print verbose information and exit.</para>
  83         </listitem>
  84       </varlistentry>
  85
  86       <varlistentry>
  87         <term>-h</term>
  88
  89         <listitem>
  90           <para>Print help and exit.</para>
  91         </listitem>
  92       </varlistentry>
  93
  94       <varlistentry>
  95         <term>-F <replaceable>configfile</replaceable></term>
  96
  97         <listitem>
  98           <para>Specifies the configuration file to use. (Defaults to
  99           <filename>@pkgconfdir@/afp.conf</filename>.)</para>
 100         </listitem>
 101       </varlistentry>
 102
 103     </variablelist>
 104   </refsect1>
 105
 106   <refsect1>
 107     <title>SIGNALS</title>
 108
 109     <para>To shut down a user's <command>afpd</command> process it is
 110       recommended that <command>SIGKILL (-9)</command>
 111       <emphasis>NOT</emphasis> be used, except as a last resort, as this
 112       may leave the CNID database in an inconsistent state. The safe way
 113       to terminate an <command>afpd</command> is to send it a
 114       <command>SIGTERM (-15)</command> signal and wait for it to die on
 115       its own.</para>
 116     <para>SIGTERM and SIGUSR1 signals that are sent to the main <command>afpd</command> process
 117     are propagated to the children, so all will be affected.</para>
 118
 119     <variablelist>
 120       <varlistentry>
 121         <term>SIGTERM</term>
 122         <listitem>
 123           <para>Clean exit. Propagates from master to childs.</para>
 124         </listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term>SIGQUIT</term>
 129         <listitem>
 130           <para>Send this to the master <command>afpd</command>, it will
 131           exit leaving all children running! Can be used to implement
 132           AFP service without downtime.</para>
 133         </listitem>
 134       </varlistentry>
 135
 136       <varlistentry>
 137         <term>SIGHUP</term>
 138         <listitem>
 139           <para>Sending a <command>SIGHUP</command> to afpd will cause it to
 140           reload its configuration files.</para>
 141         </listitem>
 142       </varlistentry>
 143
 144       <varlistentry>
 145         <term>SIGINT</term>
 146         <listitem>
 147           <para>Sending a <command>SIGINT</command> to a child
 148           <command>afpd</command> enables <emphasis>max_debug</emphasis>
 149           logging for this process. The log is sent to the file
 150           <filename>/tmp/afpd.PID.XXXXXX</filename>. Sending another
 151           <command>SIGINT</command> will revert to the original log settings.</para>
 152         </listitem>
 153       </varlistentry>
 154
 155       <varlistentry>
 156         <term>SIGUSR1</term>
 157         <listitem>
 158           <para>The <command>afpd</command> process will send the message "The
 159           server is going down for maintenance." to the client and shut itself
 160           down in 5 minutes. New connections are not allowed. If this is sent
 161           to a child afpd, the other children are not affected. However, the
 162           main process will still exit, disabling all new connections.</para>
 163         </listitem>
 164       </varlistentry>
 165
 166       <varlistentry>
 167         <term>SIGUSR2</term>
 168         <listitem>
 169           <para>The <command>afpd</command> process will look in the message
 170           directory configured at build time for a file named message.pid. For
 171           each one found, a the contents will be sent as a message to the
 172           associated AFP client. The file is removed after the message is
 173           sent. This should only be sent to a child
 174           <command>afpd</command>.</para>
 175         </listitem>
 176       </varlistentry>
 177     </variablelist>
 178   </refsect1>
 179
 180   <refsect1>
 181     <title>FILES</title>
 182
 183     <variablelist>
 184       <varlistentry>
 185         <term><filename>@pkgconfdir@/afp.conf</filename></term>
 186
 187         <listitem>
 188           <para>configuration file used by afpd</para>
 189         </listitem>
 190       </varlistentry>
 191
 192       <varlistentry>
 193         <term><filename>@localstatedir@/netatalk/afp_signature.conf</filename></term>
 194
 195         <listitem>
 196           <para>list of server signature</para>
 197         </listitem>
 198       </varlistentry>
 199
 200       <varlistentry>
 201         <term><filename>@localstatedir@/netatalk/afp_voluuid.conf</filename></term>
 202
 203         <listitem>
 204           <para>list of UUID for Time Machine volume</para>
 205         </listitem>
 206       </varlistentry>
 207
 208       <varlistentry>
 209         <term><filename>@pkgconfdir@/extmap.conf</filename></term>
 210
 211         <listitem>
 212           <para>file name extension mapping</para>
 213         </listitem>
 214       </varlistentry>
 215
 216       <varlistentry>
 217         <term><filename>@pkgconfdir@/msg/message.pid</filename></term>
 218
 219         <listitem>
 220           <para>contains messages to be sent to users.</para>
 221         </listitem>
 222       </varlistentry>
 223     </variablelist>
 224   </refsect1>
 225
 226   <refsect1>
 227     <title>SEE ALSO</title>
 228
 229     <para><citerefentry>
 230         <refentrytitle>netatalk</refentrytitle>
 231
 232         <manvolnum>8</manvolnum>
 233       </citerefentry>, <citerefentry>
 234         <refentrytitle>hosts_access</refentrytitle>
 235
 236         <manvolnum>5</manvolnum>
 237       </citerefentry>, <citerefentry>
 238         <refentrytitle>afp.conf</refentrytitle>
 239
 240         <manvolnum>5</manvolnum>
 241       </citerefentry>, <citerefentry>
 242         <refentrytitle>afp_signature.conf</refentrytitle>
 243
 244         <manvolnum>5</manvolnum>
 245       </citerefentry>, <citerefentry>
 246         <refentrytitle>afp_voluuid.conf</refentrytitle>
 247
 248         <manvolnum>5</manvolnum>
 249       </citerefentry>, <citerefentry>
 250         <refentrytitle>extmap.conf</refentrytitle>
 251
 252         <manvolnum>5</manvolnum>
 253       </citerefentry>, <citerefentry>
 254         <refentrytitle>dbd</refentrytitle>
 255
 256         <manvolnum>1</manvolnum>
 257       </citerefentry>.</para>
 258   </refsect1>
 259 </refentry>