man/man8/cnid_metad.8.tmpl

   1 '\" t
   2 .\"     Title: cnid_metad
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
   5 .\"      Date: 23 Dec 2009
   6 .\"    Manual: Netatalk 2.1
   7 .\"    Source: Netatalk 2.1
   8 .\"  Language: English
   9 .\"
  10 .TH "CNID_METAD" "8" "23 Dec 2009" "Netatalk 2.1" "Netatalk 2.1"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 cnid_metad \- start cnid_dbd daemons on request
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBcnid_metad\fR\fB\fR\ 'u
  25 \fBcnid_metad\fR\fB\fR [\-l\ \fIloglevel\fR\ [\-f\ \fIfilename\fR]] [\-d] [\-h\ \fIhostname\fR] [\-p\ \fIport\fR] [\-u\ \fIuser\fR] [\-g\ \fIgroup\fR] [\-s\ \fIcnid_dbdpathname\fR]
  26 .SH "DESCRIPTION"
  27 .PP
  28 \fBcnid_metad\fR
  29 waits for requests from
  30 \fBafpd\fR
  31 to start up instances of the
  32 \fBcnid_dbd\fR
  33 daemon\&. It keeps track of the status of a
  34 \fBcnid_dbd\fR
  35 instance once started and will restart it if necessary\&.
  36 \fBcnid_metad\fR
  37 is normally started at boot time from
  38 /etc/rc
  39 or equivalent and runs until shutdown\&.
  40 \fBafpd\fR
  41 needs to be configured with the
  42 \fB\-cnidserver\fR
  43 option in
  44 \fBafpd\&.conf\fR
  45 in order to access
  46 \fBcnid_metad\&.\fR
  47 It is possible to run more than one instance of
  48 \fBcnid_metad\fR
  49 on the same machine if different values for the interface and/or port are specified with the
  50 \fB\-h\fR
  51 and
  52 \fB\-p\fR
  53 options\&.
  54 .SH "OPTIONS"
  55 .PP
  56 \fB\-l\fR\fI <loglevel> [\-f <filename>]\fR
  57 .RS 4
  58 Specify that any message of a loglevel up to the given
  59 \fBloglevel\fR
  60 should be logged to the given file\&. If the filename is ommited the loglevel applies to messages passed to syslog\&. Default is logs to syslog with a default logging setup of
  61 \fB"log_note\fR"\&.
  62 .sp
  63 \fBNote:\fR
  64 \fBcnid_metad\fR
  65 passes this to
  66 \fBcnid_dbd\fR
  67 which will in turn use this for its logging setup\&.
  68 .sp
  69 loglevels: LOG_SEVERE, LOG_ERROR, LOG_WARN, LOG_NOTE, LOG_INFO, LOG_DEBUG, LOG_DEBUG6, LOG_DEBUG7, LOG_DEBUG8, LOG_DEBUG9, LOG_MAXDEBUG
  70 .PP
  71 \fBExample.\ \&Useful default config\fR
  72 .sp
  73 .if n \{\
  74 .RS 4
  75 .\}
  76 .nf
  77 \-l log_info \-f /var/log/afpd\&.log
  78 .fi
  79 .if n \{\
  80 .RE
  81 .\}
  82 .PP
  83 \fBExample.\ \&Debugging config\fR
  84 .sp
  85 .if n \{\
  86 .RS 4
  87 .\}
  88 .nf
  89 \-l log_maxdebug \-f /var/log/afpd\&.log
  90 .fi
  91 .if n \{\
  92 .RE
  93 .\}
  94 .RE
  95 .PP
  96 \fB\-d\fR
  97 .RS 4
  98 \fBcnid_metad will remain in the foreground and\fR
  99 will also leave the standard input, standard output and standard error file descriptors open\&. Useful for debugging\&.
 100 .RE
 101 .PP
 102 \fB\-h\fR\fI hostname\fR
 103 .RS 4
 104 Use
 105 \fIhostname\fR
 106 as the network interface for requests as opposed to the default
 107 \fBlocalhost\fR\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.
 108 .RE
 109 .PP
 110 \fB\-p\fR\fI port\fR
 111 .RS 4
 112 Use
 113 \fIport\fR
 114 as the port number for reqests\&. Default is 4700\&.
 115 .RE
 116 .PP
 117 \fB\-u\fR\fI user\fR
 118 .RS 4
 119 Switch to the userid of
 120 \fIuser\fR
 121 before serving requests\&. This userid will be inherited by all
 122 \fBcnid_dbd\fR
 123 daemon processes started\&.
 124 .RE
 125 .PP
 126 \fB\-u\fR\fI group\fR
 127 .RS 4
 128 Switch to the groupid of
 129 \fIgroup\fR
 130 before serving requests\&. This groupid will be inherited by all
 131 \fBcnid_dbd\fR
 132 daemon processes started\&. Both
 133 \fIuser\fR
 134 and
 135 \fIgroup\fR
 136 must be specified as strings\&.
 137 .RE
 138 .PP
 139 \fB\-s\fR\fI cnid_dbd pathname\fR
 140 .RS 4
 141 Use
 142 \fIcnid_dbd pathname\fR
 143 as the pathname of the executeable of the
 144 \fBcnid_dbd\fR
 145 daemon\&. The default is
 146 \fI:SBINDIR:/cnid_dbd\&.\fR
 147 .RE
 148 .SH "CAVEATS"
 149 .PP
 150 The number of
 151 \fBcnid_dbd\fR
 152 subprocecesses is currently limited to 512\&.
 153 .PP
 154 \fBcnid_metad\fR
 155 does not block or catch any signals apart from SIGPIPE\&. It will therefore exit on most signals received\&. This will also cause all instances of
 156 \fBcnid_dbd\'s\fR
 157 started by that
 158 \fBcnid_metad\fR
 159 to exit gracefully\&. Since state about and IPC access to the subprocesses is only maintained in memory by
 160 \fBcnid_metad\fR
 161 this is desired behaviour\&. As soon as
 162 \fBcnid_metad\fR
 163 is restarted
 164 \fBafpd\fR
 165 processes will transparently reconnect\&.
 166 .SH "SEE ALSO"
 167 .PP
 168 \fBcnid_dbd\fR(8),
 169 \fBafpd\fR(8),
 170 \fBdbd\fR(1)