From: Frank Lahm Date: Wed, 21 Mar 2012 15:40:29 +0000 (+0100) Subject: Import manpages from XML X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=netatalk.git;a=commitdiff_plain;h=10e48480c42be4415898d951a47187214740664d Import manpages from XML --- diff --git a/man/man8/afpd.8.tmpl b/man/man8/afpd.8.tmpl index 6ce60fd4..e7c10259 100644 --- a/man/man8/afpd.8.tmpl +++ b/man/man8/afpd.8.tmpl @@ -2,12 +2,12 @@ .\" Title: afpd .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 08 Mar 2011 -.\" Manual: Netatalk 2.2 -.\" Source: Netatalk 2.2 +.\" Date: 21 Mar 2012 +.\" Manual: Netatalk 3.0 +.\" Source: Netatalk 3.0 .\" Language: English .\" -.TH "AFPD" "8" "08 Mar 2011" "Netatalk 2.2" "Netatalk 2.2" +.TH "AFPD" "8" "21 Mar 2012" "Netatalk 3.0" "Netatalk 3.0" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -22,7 +22,7 @@ afpd \- Apple Filing Protocol daemon .SH "SYNOPSIS" .HP \w'\fBafpd\fR\fB\fR\fBafpd\fR\fB\fR\ 'u -\fBafpd\fR\fB\fR [\-duptDTI] [\-f\ \fIdefaultvolumes\fR] [\-s\ \fIsystemvolumes\fR] [\-n\ \fInbpname\fR] [\-c\ \fImaxconnections\fR] [\-g\ \fIguest\fR] [\-P\ \fIpidfile\fR] [\-S\ \fIport\fR] [\-L\ \fImessage\fR] [\-F\ \fIconfigfile\fR] [\-U\ \fIuams\fR] [\-m\ \fIumask\fR] +\fBafpd\fR\fB\fR [\-d] [\-F\ \fIconfigfile\fR] .br \fBafpd\fR\fB\fR \-v | \-V | \-h .SH "DESCRIPTION" @@ -30,59 +30,15 @@ afpd \- Apple Filing Protocol daemon \fBafpd\fR provides an Apple Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time from /etc/rc\&. .PP -:ETCDIR:/afpd\&.conf +:ETCDIR:/afp\&.conf is the configuration file used by \fBafpd\fR to determine the behavior and configuration of the different virtual file servers that it provides\&. -.PP -The list of volumes offered to the user is generated from -:ETCDIR:/AppleVolumes\&.system -and one of -:ETCDIR:/AppleVolumes\&.default, -~/AppleVolumes, -~/\&.AppleVolumes, -~/applevolumes, or -~/\&.applevolumes\&. The -AppleVolumes -files is used to specify volumes to mount and file name extension mappings\&. -.PP .SH "OPTIONS" .PP \-d .RS 4 -Specifies that the daemon should not fork\&. If netatalk has been configured with -\fI\-\-enable\-debug1\fR, a trace of all AFP commands will be written to stdout\&. -.RE -.PP -\-p -.RS 4 -Prevents clients from saving their passwords\&. (Equivalent to \-\fBnosavepasswd\fR -in -afpd\&.conf\&.) -.RE -.PP -\-t -.RS 4 -Allows clients to change their passwords\&. (Equivalent to -\fB\-setpasswd\fR -in -afpd\&.conf\&.) -.RE -.PP -\-D -.RS 4 -Use DDP (AppleTalk) as transport protocol\&. (Equivalent to -\fB\-ddp\fR -in -afpd\&.cond\&.) -.RE -.PP -\-T -.RS 4 -Use TCP/IP as transport protocol\&. (Equivalent to -\fB\-tcp\fR -in -afpd\&.conf\&.) +Specifies that the daemon should not fork\&. .RE .PP \-v @@ -100,104 +56,10 @@ Print verbose information and exit\&. Print help and exit\&. .RE .PP -\-I -.RS 4 -Use a platform specific icon\&. (Equivalent to -\fB\-icon\fR -in -afpd\&.conf\&.) (Recent Mac OS don\'t display it\&.) -.RE -.PP -\-f \fIdefaultvolumes\fR -.RS 4 -Specifies that -\fIdefaultvolumes\fR -should be read for a list of default volumes to offer, instead of -:ETCDIR:/AppleVolumes\&.default\&. -.RE -.PP -\-s \fIsystemvolumes\fR -.RS 4 -Specifies that -\fIsystemvolumes\fR -should be read for a list of volume that all users will be offered, instead of -:ETCDIR:/AppleVolumes\&.system\&. -.RE -.PP -\-u -.RS 4 -Read the user\'s -AppleVolumes -file first\&. This option causes volume names in the user\'s -AppleVolumes -file to override volume names in the system\'s -AppleVolumes -file\&. The default is to read the system -AppleVolumes -file first\&. Note that this option doesn\'t effect the precendence of filename extension mappings: the user\'s -AppleVolumes -file always has precedence\&. -.RE -.PP -\-n \fInbpname\fR -.RS 4 -Specifies that -\fInbpname\fR -should be used for NBP registration, instead of the first component of the hostname in the local zone\&. -.RE -.PP -\-c \fImaxconnections\fR -.RS 4 -Specifies the maximum number of connections to allow for this -\fBafpd\fR\&. The default is 20\&. -.RE -.PP -\-g \fIguest\fR -.RS 4 -Specifies the name of the guest account\&. The default is \'\fInobody\fR\'\&. -.RE -.PP -\-P \fIpidfile\fR -.RS 4 -Specifies the file in which -\fBafpd\fR -stores its process id\&. -.RE -.PP -\-S \fIport\fR -.RS 4 -Specifies the port to register with when doing AFPoverTCP\&. Defaults to 548\&. (Equivalent to -\fB\-port \fRin -afpd\&.conf\&.) -.RE -.PP -\-L \fImessage\fR -.RS 4 -Specifies the login message that will be sent to clients\&. (Equivalent to -\fB\-loginmsg\fR -in -afpd\&.conf\&.) -.RE -.PP \-F \fIconfigfile\fR .RS 4 Specifies the configuration file to use\&. (Defaults to -:ETCDIR:/netatalk/afpd\&.conf\&.) -.RE -.PP -\-U \fIuams\fR -.RS 4 -Comma\-separated list of UAMs to use for the authentication process\&. (Equivalent to -\fB\-uamlist\fR -in -afpd\&.conf\&.) -.RE -.PP -\-m \fIumask\fR -.RS 4 -Use this -\fIumask\fR -for the creation of folders in Netatalk\&. +:ETCDIR:/netatalk/afp\&.conf\&.) .RE .SH "SIGNALS" .PP @@ -264,47 +126,25 @@ process will look in the message directory configured at build time for a file n .RE .SH "FILES" .PP -:ETCDIR:/afpd\&.conf +:ETCDIR:/afp\&.conf .RS 4 configuration file used by afpd .RE .PP -:ETCDIR:/AppleVolumes\&.default -.RS 4 -list of default volumes to mount -.RE -.PP -:ETCDIR:/AppleVolumes\&.system -.RS 4 -list of volumes to offer all users -.RE -.PP -~/AppleVolumes, ~/\&.AppleVolumes, ~/applevolumes, ~/\&.applevolumes -.RS 4 -user\'s list of volumes to mount -.RE -.PP -:ETCDIR:/afp_signature\&.conf +afp_signature\&.conf .RS 4 list of server signature .RE .PP -:ETCDIR:/afp_voluuid\&.conf +afp_voluuid\&.conf .RS 4 list of UUID for Time Machine volume .RE .PP -:ETCDIR:/afp_ldap\&.conf -.RS 4 -configuration file for LDAP and ACL support -.RE -.PP :ETCDIR:/msg/message\&.pid .RS 4 contains messages to be sent to users\&. .RE -.SH "BUGS" -.PP .SH "SEE ALSO" .PP \fBhosts_access\fR(5), diff --git a/man/man8/cnid_dbd.8.tmpl b/man/man8/cnid_dbd.8.tmpl index 5bd2dd36..347921ef 100644 --- a/man/man8/cnid_dbd.8.tmpl +++ b/man/man8/cnid_dbd.8.tmpl @@ -22,7 +22,7 @@ cnid_dbd \- implement access to CNID databases through a dedicated daemon process .SH "SYNOPSIS" .HP \w'\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR\fBcnid_dbd\fR\fB\fR\ 'u -\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR \fIvolpath\fR \fIctrlfd\fR \fIclntfd\fR \fIlogconfig_string\fR +\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR .br \fBcnid_dbd\fR\fB\fR \-v | \-V .SH "DESCRIPTION" @@ -80,13 +80,6 @@ via the filedescriptor \fIctrlfd\fR\&. .PP \fBcnid_dbd\fR -uses -\fBlogconfig_string\fR -which is passed from -\fBcnid_metad\fR -to configure its logging output\&. -.PP -\fBcnid_dbd\fR can be configured to run forever or to exit after a period of inactivity\&. If \fBcnid_dbd\fR receives a TERM or an INT signal it will exit cleanly after flushing dirty database buffers to disk and closing diff --git a/man/man8/cnid_metad.8.tmpl b/man/man8/cnid_metad.8.tmpl index 7aedd76f..64e5b3cc 100644 --- a/man/man8/cnid_metad.8.tmpl +++ b/man/man8/cnid_metad.8.tmpl @@ -2,12 +2,12 @@ .\" Title: cnid_metad .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 01 Jan 2012 +.\" Date: 21 Mar 2012 .\" Manual: Netatalk 3.0 .\" Source: Netatalk 3.0 .\" Language: English .\" -.TH "CNID_METAD" "8" "01 Jan 2012" "Netatalk 3.0" "Netatalk 3.0" +.TH "CNID_METAD" "8" "21 Mar 2012" "Netatalk 3.0" "Netatalk 3.0" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -22,7 +22,7 @@ cnid_metad \- start cnid_dbd daemons on request .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] +\fBcnid_metad\fR\fB\fR [\-d] [\-F\ \fIconfiguration\ file\fR] .br \fBcnid_metad\fR\fB\fR \-v | \-V .SH "DESCRIPTION" @@ -39,113 +39,20 @@ instance once started and will restart it if necessary\&. 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 .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 -.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 -.RS 4 -Use -\fIport\fR -as the port number for reqests\&. Default is 4700\&. -.RE -.PP -\fB\-u\fR\fI user\fR -.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 +\fB\-F\fR \fIconfiguration file\fR .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 +\fIconfiguration file\fR +as the configuration file\&. The default is +\fI:ETCDIR:/afp\&.conf\fR\&. .RE .PP \fB\-v, \-V\fR @@ -154,10 +61,6 @@ 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