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