X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=man%2Fman8%2Fcnid_metad.8.tmpl;h=7d4b2cee64860ee7d86a1ffb619ab559e0d97922;hb=df66ec1b1bbfb22a1b93c8763fdc0e2660c2758e;hp=77761f8adf3953341e7afd79a0169a01b1c88173;hpb=ecfc96169ab669b578e53fa8e13592934fe37788;p=netatalk.git diff --git a/man/man8/cnid_metad.8.tmpl b/man/man8/cnid_metad.8.tmpl index 77761f8a..7d4b2cee 100644 --- a/man/man8/cnid_metad.8.tmpl +++ b/man/man8/cnid_metad.8.tmpl @@ -1,66 +1,177 @@ -.TH cnid_metad 8 "28 Nov 2003" 2.0.0 Netatalk -.SH NAME +'\" t +.\" Title: cnid_metad +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" Date: 01 Jan 2012 +.\" Manual: Netatalk 2.2 +.\" Source: Netatalk 2.2 +.\" Language: English +.\" +.TH "CNID_METAD" "8" "01 Jan 2012" "Netatalk 2.2" "Netatalk 2.2" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" cnid_metad \- start cnid_dbd daemons on request -.SH SYNOPSIS -\fBcnid_metad\fR [\-d] [ \-h \fBhostname\fR ] [ \-p \fBport\fR ] [ \-u \fBuser\fR ] [ \-g \fBgroup\fR ] [ \-s \fBcnid_dbdpathname\fR ] -.SH DESCRIPTION -cnid_metad waits for requests from \fIafpd\fR to start up instances of the \fIcnid_dbd\fR -daemon. It keeps track of the status of a \fIcnid_dbd\fR -instance once started and will restart it if necessary. -cnid_metad is normally started at boot time from -\fB/etc/rc\fR or equivalent and runs until shutdown. -\fIafpd\fR needs to be configured with the -\fB\-cnidserver\fR option in \fIafpd.conf\fR -in order to access \fIcnid_metad.\fR It is -possible to run more than one instance of cnid_metad on -the same machine if different values for the interface and/or port are -specified with the \fB\-h\fR and \fB\-p\fR options. -.SH OPTIONS -.TP +.SH "SYNOPSIS" +.HP \w'\fBcnid_metad\fR\fB\fR\fBcnid_metad\fR\fB\fR\ 'u +\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] +.br +\fBcnid_metad\fR\fB\fR \-v | \-V +.SH "DESCRIPTION" +.PP +\fBcnid_metad\fR +waits for requests from +\fBafpd\fR +to start up instances of the +\fBcnid_dbd\fR +daemon\&. It keeps track of the status of a +\fBcnid_dbd\fR +instance once started and will restart it if necessary\&. +\fBcnid_metad\fR +is normally started at boot time from +/etc/rc +or equivalent and runs until shutdown\&. +\fBafpd\fR +needs to be configured with the +\fB\-cnidserver\fR +option in +\fBafpd\&.conf\fR +in order to access +\fBcnid_metad\&.\fR +It is possible to run more than one instance of +\fBcnid_metad\fR +on the same machine if different values for the interface and/or port are specified with the +\fB\-h\fR +and +\fB\-p\fR +options\&. +.SH "OPTIONS" +.PP +\fB\-l\fR\fI [\-f ]\fR +.RS 4 +Specify that any message of a loglevel up to the given +\fBloglevel\fR +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 +\fB"log_note\fR"\&. +.sp +\fBNote:\fR +\fBcnid_metad\fR +passes this to +\fBcnid_dbd\fR +which will in turn use this for its logging setup\&. +.sp +loglevels: LOG_SEVERE, LOG_ERROR, LOG_WARN, LOG_NOTE, LOG_INFO, LOG_DEBUG, LOG_DEBUG6, LOG_DEBUG7, LOG_DEBUG8, LOG_DEBUG9, LOG_MAXDEBUG +.PP +\fBExample.\ \&Useful default config\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-l log_info \-f /var/log/afpd\&.log +.fi +.if n \{\ +.RE +.\} +.PP +\fBExample.\ \&Debugging config\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-l log_maxdebug \-f /var/log/afpd\&.log +.fi +.if n \{\ +.RE +.\} +.RE +.PP \fB\-d\fR -\fIcnid_metad will remain in the foreground -and\fR will also leave the standard input, standard output -and standard error file descriptors open. Useful for debugging. -.TP +.RS 4 +\fBcnid_metad will remain in the foreground and\fR +will also leave the standard input, standard output and standard error file descriptors open\&. Useful for debugging\&. +.RE +.PP \fB\-h\fR\fI hostname\fR -Use \fIhostname\fR as the network -interface for requests as opposed to the default \fIlocalhost -\fR\&. -.TP +.RS 4 +Use +\fIhostname\fR +as the network interface for requests as opposed to the default +\fBlocalhost\fR\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&. +.RE +.PP \fB\-p\fR\fI port\fR -Use \fIport\fR as the port number for -reqests. Default is 4700. -.TP +.RS 4 +Use +\fIport\fR +as the port number for reqests\&. Default is 4700\&. +.RE +.PP \fB\-u\fR\fI user\fR -Switch to the userid of \fIuser\fR -before serving requests. This userid will be inherited by all -\fIcnid_dbd\fR daemon processes started. -.TP -\fB\-u\fR\fI group\fR -Switch to the groupid of \fIgroup\fR -before serving requests. This groupid will be inherited by all -\fIcnid_dbd\fR daemon processes started. -Both \fIuser\fR and \fIgroup\fR -must be specified as strings. -.TP +.RS 4 +Switch to the userid of +\fIuser\fR +before serving requests\&. This userid will be inherited by all +\fBcnid_dbd\fR +daemon processes started\&. +.RE +.PP +\fB\-g\fR\fI group\fR +.RS 4 +Switch to the groupid of +\fIgroup\fR +before serving requests\&. This groupid will be inherited by all +\fBcnid_dbd\fR +daemon processes started\&. Both +\fIuser\fR +and +\fIgroup\fR +must be specified as strings\&. +.RE +.PP \fB\-s\fR\fI cnid_dbd pathname\fR -Use \fIcnid_dbd pathname\fR as the -pathname of the executeable of the \fIcnid_dbd\fR -daemon. The default is \fI:SBINDIR:/cnid_dbd.\fR -.SH CAVEATS -The number of \fIcnid_dbd\fR subprocecesses -is currently limited to 128. This restriction will be lifted in the -future. +.RS 4 +Use +\fIcnid_dbd pathname\fR +as the pathname of the executeable of the +\fBcnid_dbd\fR +daemon\&. The default is +\fI:SBINDIR:/cnid_dbd\&.\fR +.RE .PP -cnid_metad 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 \fIcnid_dbd's\fR -started by that cnid_metad to exit gracefully. Since -state about and IPC access to the subprocesses is only maintained in -memory by cnid_metad this is desired behaviour. As soon -as cnid_metad is restarted \fIafpd\fR -processes will transparently reconnect. +\fB\-v, \-V\fR +.RS 4 +Show version and exit\&. +.RE +.SH "CAVEATS" +.PP +The number of +\fBcnid_dbd\fR +subprocecesses is currently limited to 512\&. +.PP +\fBcnid_metad\fR +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 +\fBcnid_dbd\'s\fR +started by that +\fBcnid_metad\fR +to exit gracefully\&. Since state about and IPC access to the subprocesses is only maintained in memory by +\fBcnid_metad\fR +this is desired behaviour\&. As soon as +\fBcnid_metad\fR +is restarted +\fBafpd\fR +processes will transparently reconnect\&. .SH "SEE ALSO" +.PP \fBcnid_dbd\fR(8), -\fBafpd\fR(8) - +\fBafpd\fR(8), +\fBdbd\fR(1)