]> arthur.barton.de Git - netatalk.git/blob - doc/manpages/man8/cnid_metad.8.xml
Add Docbook documentation to tree
[netatalk.git] / doc / manpages / man8 / cnid_metad.8.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="cnid_metad.8">
3   <refmeta>
4     <refentrytitle>cnid_metad</refentrytitle>
5
6     <manvolnum>8</manvolnum>
7
8     <refmiscinfo class="date">23 Mar 2012</refmiscinfo>
9
10     <refmiscinfo class="source">:NETATALK_VERSION:</refmiscinfo>
11   </refmeta>
12
13   <refnamediv>
14     <refname>cnid_metad</refname>
15
16     <refpurpose>start cnid_dbd daemons on request</refpurpose>
17   </refnamediv>
18
19   <refsynopsisdiv>
20     <cmdsynopsis>
21       <command>cnid_metad<indexterm>
22           <primary>cnid_metad</primary>
23         </indexterm></command>
24
25       <arg choice="opt">-d</arg>
26
27       <arg choice="opt"><arg choice="plain">-F </arg><arg
28       choice="plain"><replaceable>configuration file</replaceable></arg></arg>
29
30       <sbr />
31
32       <command>cnid_metad<indexterm>
33           <primary>cnid_metad</primary>
34         </indexterm></command>
35
36         <group choice="plain">
37           <arg choice="plain">-v</arg>
38           <arg choice="plain">-V</arg>
39         </group>
40     </cmdsynopsis>
41   </refsynopsisdiv>
42
43   <refsect1>
44     <title>DESCRIPTION</title>
45
46     <para><command>cnid_metad</command> waits for requests from <emphasis
47     remap="B">afpd</emphasis> to start up instances of the <emphasis
48     remap="B">cnid_dbd</emphasis> daemon. It keeps track of the status of a
49     <emphasis remap="B">cnid_dbd</emphasis> instance once started and will
50     restart it if necessary. <command>cnid_metad</command> is normally started
51     at boot time by <command>netatalk</command>(8) and runs
52     until shutdown.</para>
53   </refsect1>
54
55   <refsect1>
56     <title>OPTIONS</title>
57
58     <variablelist remap="TP">
59  
60      <varlistentry>
61         <term><option>-d</option></term>
62
63         <listitem>
64           <para><emphasis remap="B">cnid_metad will remain in the foreground
65           and</emphasis> will also leave the standard input, standard output
66           and standard error file descriptors open. Useful for
67           debugging.</para>
68         </listitem>
69       </varlistentry>
70
71       <varlistentry>
72         <term><option>-F</option> <replaceable>configuration file</replaceable></term>
73
74         <listitem>
75           <para>Use <emphasis remap="I">configuration file</emphasis> as the
76             configuration file. The default is
77             <emphasis remap="I">:ETCDIR:/afp.conf</emphasis>.</para>
78         </listitem>
79       </varlistentry>
80
81       <varlistentry>
82         <term><option>-v, -V</option></term>
83
84         <listitem>
85           <para>Show version and exit.</para>
86         </listitem>
87       </varlistentry>
88     </variablelist>
89   </refsect1>
90
91   <refsect1>
92     <title>CAVEATS</title>
93
94     <para><command>cnid_metad</command> does not block or catch any signals
95     apart from SIGPIPE. It will therefore exit on most signals received. This
96     will also cause all instances of <emphasis remap="B">cnid_dbd's</emphasis>
97     started by that <command>cnid_metad</command> to exit gracefully. Since
98     state about and IPC access to the subprocesses is only maintained in
99     memory by <command>cnid_metad</command> this is desired behaviour. As soon
100     as <command>cnid_metad</command> is restarted <emphasis
101     remap="B">afpd</emphasis> processes will transparently reconnect.</para>
102   </refsect1>
103
104   <refsect1>
105     <title>SEE ALSO</title>
106
107     <para><citerefentry>
108         <refentrytitle>netatalk</refentrytitle>
109
110         <manvolnum>8</manvolnum>
111       </citerefentry>, <citerefentry>
112         <refentrytitle>cnid_dbd</refentrytitle>
113
114         <manvolnum>8</manvolnum>
115       </citerefentry>, <citerefentry>
116         <refentrytitle>afpd</refentrytitle>
117
118         <manvolnum>8</manvolnum>
119       </citerefentry>, <citerefentry>
120         <refentrytitle>dbd</refentrytitle>
121
122         <manvolnum>1</manvolnum>
123       </citerefentry>, <citerefentry>
124         <refentrytitle>afp.conf</refentrytitle>
125
126         <manvolnum>5</manvolnum>
127       </citerefentry></para>
128   </refsect1>
129 </refentry>