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.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 01 Jan 2012
   6 .\"    Manual: Netatalk 2.2
   7 .\"    Source: Netatalk 2.2
   8 .\"  Language: English
   9 .\"
  10 .TH "CNID_METAD" "8" "01 Jan 2012" "Netatalk 2.2" "Netatalk 2.2"
  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\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 .br
  27 \fBcnid_metad\fR\fB\fR \-v | \-V
  28 .SH "DESCRIPTION"
  29 .PP
  30 \fBcnid_metad\fR
  31 waits for requests from
  32 \fBafpd\fR
  33 to start up instances of the
  34 \fBcnid_dbd\fR
  35 daemon\&. It keeps track of the status of a
  36 \fBcnid_dbd\fR
  37 instance once started and will restart it if necessary\&.
  38 \fBcnid_metad\fR
  39 is normally started at boot time from
  40 /etc/rc
  41 or equivalent and runs until shutdown\&.
  42 \fBafpd\fR
  43 needs to be configured with the
  44 \fB\-cnidserver\fR
  45 option in
  46 \fBafpd\&.conf\fR
  47 in order to access
  48 \fBcnid_metad\&.\fR
  49 It is possible to run more than one instance of
  50 \fBcnid_metad\fR
  51 on the same machine if different values for the interface and/or port are specified with the
  52 \fB\-h\fR
  53 and
  54 \fB\-p\fR
  55 options\&.
  56 .SH "OPTIONS"
  57 .PP
  58 \fB\-l\fR\fI <loglevel> [\-f <filename>]\fR
  59 .RS 4
  60 Specify that any message of a loglevel up to the given
  61 \fBloglevel\fR
  62 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
  63 \fB"log_note\fR"\&.
  64 .sp
  65 \fBNote:\fR
  66 \fBcnid_metad\fR
  67 passes this to
  68 \fBcnid_dbd\fR
  69 which will in turn use this for its logging setup\&.
  70 .sp
  71 loglevels: LOG_SEVERE, LOG_ERROR, LOG_WARN, LOG_NOTE, LOG_INFO, LOG_DEBUG, LOG_DEBUG6, LOG_DEBUG7, LOG_DEBUG8, LOG_DEBUG9, LOG_MAXDEBUG
  72 .PP
  73 \fBExample.\ \&Useful default config\fR
  74 .sp
  75 .if n \{\
  76 .RS 4
  77 .\}
  78 .nf
  79 \-l log_info \-f /var/log/afpd\&.log
  80 .fi
  81 .if n \{\
  82 .RE
  83 .\}
  84 .PP
  85 \fBExample.\ \&Debugging config\fR
  86 .sp
  87 .if n \{\
  88 .RS 4
  89 .\}
  90 .nf
  91 \-l log_maxdebug \-f /var/log/afpd\&.log
  92 .fi
  93 .if n \{\
  94 .RE
  95 .\}
  96 .RE
  97 .PP
  98 \fB\-d\fR
  99 .RS 4
 100 \fBcnid_metad will remain in the foreground and\fR
 101 will also leave the standard input, standard output and standard error file descriptors open\&. Useful for debugging\&.
 102 .RE
 103 .PP
 104 \fB\-h\fR\fI hostname\fR
 105 .RS 4
 106 Use
 107 \fIhostname\fR
 108 as the network interface for requests as opposed to the default
 109 \fBlocalhost\fR\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.
 110 .RE
 111 .PP
 112 \fB\-p\fR\fI port\fR
 113 .RS 4
 114 Use
 115 \fIport\fR
 116 as the port number for reqests\&. Default is 4700\&.
 117 .RE
 118 .PP
 119 \fB\-u\fR\fI user\fR
 120 .RS 4
 121 Switch to the userid of
 122 \fIuser\fR
 123 before serving requests\&. This userid will be inherited by all
 124 \fBcnid_dbd\fR
 125 daemon processes started\&.
 126 .RE
 127 .PP
 128 \fB\-g\fR\fI group\fR
 129 .RS 4
 130 Switch to the groupid of
 131 \fIgroup\fR
 132 before serving requests\&. This groupid will be inherited by all
 133 \fBcnid_dbd\fR
 134 daemon processes started\&. Both
 135 \fIuser\fR
 136 and
 137 \fIgroup\fR
 138 must be specified as strings\&.
 139 .RE
 140 .PP
 141 \fB\-s\fR\fI cnid_dbd pathname\fR
 142 .RS 4
 143 Use
 144 \fIcnid_dbd pathname\fR
 145 as the pathname of the executeable of the
 146 \fBcnid_dbd\fR
 147 daemon\&. The default is
 148 \fI:SBINDIR:/cnid_dbd\&.\fR
 149 .RE
 150 .PP
 151 \fB\-v, \-V\fR
 152 .RS 4
 153 Show version and exit\&.
 154 .RE
 155 .SH "CAVEATS"
 156 .PP
 157 The number of
 158 \fBcnid_dbd\fR
 159 subprocecesses is currently limited to 512\&.
 160 .PP
 161 \fBcnid_metad\fR
 162 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
 163 \fBcnid_dbd\'s\fR
 164 started by that
 165 \fBcnid_metad\fR
 166 to exit gracefully\&. Since state about and IPC access to the subprocesses is only maintained in memory by
 167 \fBcnid_metad\fR
 168 this is desired behaviour\&. As soon as
 169 \fBcnid_metad\fR
 170 is restarted
 171 \fBafpd\fR
 172 processes will transparently reconnect\&.
 173 .SH "SEE ALSO"
 174 .PP
 175 \fBcnid_dbd\fR(8),
 176 \fBafpd\fR(8),
 177 \fBdbd\fR(1)