]> arthur.barton.de Git - netatalk.git/commitdiff
Import generated manpages from XML files
authorfranklahm <franklahm>
Fri, 24 Apr 2009 14:19:55 +0000 (14:19 +0000)
committerfranklahm <franklahm>
Fri, 24 Apr 2009 14:19:55 +0000 (14:19 +0000)
33 files changed:
man/man1/achfile.1
man/man1/acleandir.1
man/man1/aecho.1
man/man1/afile.1
man/man1/afppasswd.1
man/man1/apple_cp.1.tmpl
man/man1/apple_mv.1.tmpl
man/man1/apple_rm.1.tmpl
man/man1/asip-status.pl.1.tmpl
man/man1/cnid_index.1
man/man1/getzones.1
man/man1/megatron.1
man/man1/nbp.1
man/man1/netatalk-config.1
man/man1/pap.1
man/man1/psorder.1
man/man1/uniconv.1.tmpl
man/man3/atalk_aton.3
man/man3/nbp_name.3
man/man4/atalk.4
man/man5/AppleVolumes.default.5.tmpl
man/man5/afpd.conf.5.tmpl
man/man5/atalkd.conf.5.tmpl
man/man5/netatalk.conf.5.tmpl
man/man5/papd.conf.5.tmpl
man/man8/afpd.8.tmpl
man/man8/atalkd.8.tmpl
man/man8/cnid_dbd.8.tmpl
man/man8/cnid_metad.8.tmpl
man/man8/papd.8.tmpl
man/man8/papstatus.8.tmpl
man/man8/psf.8.tmpl
man/man8/timelord.8

index 72792325aefa9ab0575ba78a766a6ac6e580ecad..6e9a2bff5635052801b42a5c4ab4285461ac6e11 100644 (file)
@@ -1,20 +1,47 @@
-.TH achfile 1 "26 Feb 1998" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: achfile
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 26 Feb 1998
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "ACHFILE" "1" "26 Feb 1998" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 achfile \- change type and/or creator of Apple Macintosh files (netatalk format)
-.SH SYNOPSIS
-\fBachfile\fR [ \-t \fBtype\fR ] [ \-c \fBcreator\fR ] \fBfile\fR \&...
-.SH DESCRIPTION
-achfile changes the Macintosh type and/or creator
-of the \fIfile\fR arguments which have a
-corresponding .AppleDouble file.
-.SH OPTIONS
-\fB\-t\fR \fItype\fR change the type.
+.SH "SYNOPSIS"
+.HP \w'\fBachfile\fR\fB\fR\ 'u
+\fBachfile\fR\fB\fR [\-t\ \fItype\fR] [\-c\ \fIcreator\fR] \fIfile\fR...
+.SH "DESCRIPTION"
+.PP
+\fBachfile\fR
+changes the Macintosh type and/or creator of the
+\fIfile\fR
+arguments which have a corresponding \&.AppleDouble file\&.
+.SH "OPTIONS"
+.PP
+\fB\-t\fR
+\fItype\fR
+change the type\&.
+.PP
+\fB\-c\fR
+\fIcreator\fR
+change the creator\&.
+.SH "DIAGNOSTICS"
 .PP
-\fB\-c\fR \fIcreator\fR change the
-creator.
-.SH DIAGNOSTICS
 returns exit status 0 if all files changed successfully
 .SH "SEE ALSO"
+.PP
 \fBafile\fR(1),
 \fBafpd\fR(8)
-
index da81e9ce7f52e4f6e9f04cd4dc87e101fb5e6122..fd825d5008a56425295b3a7266ae288116bfbfb0 100644 (file)
@@ -1,49 +1,75 @@
-.TH acleandir 1 "26 Feb 1998" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: acleandir
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 26 Feb 1998
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "ACLEANDIR" "1" "26 Feb 1998" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 acleandir \- clean up a directory containing netatalk Apple Macintosh files
-.SH SYNOPSIS
-\fBacleandir\fR [\-rnvi] \fBdirname\fR 
-.sp 1
-.SH DESCRIPTION
-acleandir cleans up the directory \fIdirname.\fR By default it simply removes
-"orphan" AppleDouble files, i.e. those which do not have a
-corresponding data file.
-.SH OPTIONS
-.TP 
+.SH "SYNOPSIS"
+.HP \w'\fBacleandir\fR\fB\fR\ 'u
+\fBacleandir\fR\fB\fR [\-rnvi] \fIdirname\fR
+.br
+
+.SH "DESCRIPTION"
+.PP
+\fBacleandir\fR
+cleans up the directory
+\fIdirname\&.\fR
+By default it simply removes "orphan" AppleDouble files, i\&.e\&. those which do not have a corresponding data file\&.
+.SH "OPTIONS"
+.PP
 \fB\-d\fR
-Also remove the .AppleDouble directory if it contains no
-AppleDouble files after "orphan" removal. This will result
-in the finder location of \fIdirname\fR
-within its parent being lost.
-.TP 
+.RS 4
+Also remove the \&.AppleDouble directory if it contains no AppleDouble files after "orphan" removal\&. This will result in the finder location of
+\fIdirname\fR
+within its parent being lost\&.
+.RE
+.PP
 \fB\-r\fR, \fB\-R\fR
-Recursive. Clean up directories recursively.
-.TP 
+.RS 4
+Recursive\&. Clean up directories recursively\&.
+.RE
+.PP
 \fB\-n\fR
-Display the filenames of "orphans" but don't
-remove any. Display size if "orphan" appears to contain a
-resource fork.
-.TP 
+.RS 4
+Display the filenames of "orphans" but don\'t remove any\&. Display size if "orphan" appears to contain a resource fork\&.
+.RE
+.PP
 \fB\-i\fR
-Interactive. Prompt for confirmation before a removal. A y in
-answer confirms that the removal should proceed.
-.TP 
+.RS 4
+Interactive\&. Prompt for confirmation before a removal\&. A y in answer confirms that the removal should proceed\&.
+.RE
+.PP
 \fB\-v\fR
-Verbose. Display the names of all "orphans" and
-\&.AppleDouble directories removed. Reports the size if the
-"orphan" appears to contain a resource fork.
-.TP 
+.RS 4
+Verbose\&. Display the names of all "orphans" and \&.AppleDouble directories removed\&. Reports the size if the "orphan" appears to contain a resource fork\&.
+.RE
+.PP
 \fB\-a\fR
-Aggressive. Remove all AppleDouble files, not just
-"orphans". Also remove the .AppleDesktop directory if
-present. Impies \fB\-d\fR option. Use with caution as the
-Macintosh type/creator and finder location of all files will be lost
-and the content of some documents, such as Symantec Projects, will
-be destroyed.
-.SH DIAGNOSTICS
-returns exit status 0 unless bad options are provided or a directory
-is not given on the command line.
+.RS 4
+Aggressive\&. Remove all AppleDouble files, not just "orphans"\&. Also remove the \&.AppleDesktop directory if present\&. Impies
+\fB\-d\fR
+option\&. Use with caution as the Macintosh type/creator and finder location of all files will be lost and the content of some documents, such as Symantec Projects, will be destroyed\&.
+.RE
+.SH "DIAGNOSTICS"
+.PP
+returns exit status 0 unless bad options are provided or a directory is not given on the command line\&.
 .SH "SEE ALSO"
+.PP
 \fBafile\fR(1),
 \fBafpd\fR(8)
-
index d2386927dd84edd75107ff302041a3dccddc1c1a..d5828a8d6e223c139cabe603e103a2c67aede6af 100644 (file)
@@ -1,50 +1,90 @@
-.TH aecho 1 "17 Dec 1991" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: aecho
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 17 Dec 1991
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "AECHO" "1" "17 Dec 1991" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 aecho \- send AppleTalk Echo Protocol packets to network hosts
-.SH SYNOPSIS
-aecho [ \fB\-c\fR\fI count\fR
-] ( address | nbpname )
-.SH DESCRIPTION
-aecho repeatedly sends an Apple Echo Protocol
-(AEP) packet to the host specified by the given AppleTalk
-address or nbpname and reports
-whether a reply was received. Requests are sent at the rate of one per
-second.
+.SH "SYNOPSIS"
 .PP
-address is parsed by
-\fBatalk_aton\fR(3).
-nbpname is parsed by \fBnbp_name\fR(3).
-The nbp type defaults to `\fIWorkstation\fR'.
+\fBaecho\fR\fB\fR\fB\fR
+[
+\fB\-c\fR\fI count\fR
+] (
+\fBaddress\fR
+|
+\fBnbpname\fR
+)
+.SH "DESCRIPTION"
+.PP
+\fBaecho\fR
+repeatedly sends an Apple Echo Protocol (AEP) packet to the host specified by the given AppleTalk
+\fBaddress\fR
+or
+\fBnbpname\fR
+and reports whether a reply was received\&. Requests are sent at the rate of one per second\&.
+.PP
+\fBaddress\fR
+is parsed by
+\fBatalk_aton\fR(3)\&.
+\fBnbpname\fR
+is parsed by
+\fBnbp_name\fR(3)\&. The nbp type defaults to `\fBWorkstation\fR\'\&.
 .PP
-When aecho is terminated, it reports the number
-of packets sent, the number of responses received, and the percentage of
-packets lost. If any responses were received, the minimum, average, and
-maximum round trip times are reported.
-.SH EXAMPLE
-Check to see if a particular host is up and responding to AEP
-packets:
+When
+\fBaecho\fR
+is terminated, it reports the number of packets sent, the number of responses received, and the percentage of packets lost\&. If any responses were received, the minimum, average, and maximum round trip times are reported\&.
+.SH "EXAMPLE"
 .PP
+Check to see if a particular host is up and responding to AEP packets:
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 example% \fBaecho bloodsport
-11 bytes from 8195.13: aep_seq=0. time=10. ms
-11 bytes from 8195.13: aep_seq=1. time=10. ms
-11 bytes from 8195.13: aep_seq=2. time=10. ms
-11 bytes from 8195.13: aep_seq=3. time=10. ms
-11 bytes from 8195.13: aep_seq=4. time=10. ms
-11 bytes from 8195.13: aep_seq=5. time=9. ms
-^C
-\-\-\-\-8195.13 AEP Statistics\-\-\-\-
+\fR\fB11 bytes from 8195\&.13: aep_seq=0\&. time=10\&. ms
+11 bytes from 8195\&.13: aep_seq=1\&. time=10\&. ms
+11 bytes from 8195\&.13: aep_seq=2\&. time=10\&. ms
+11 bytes from 8195\&.13: aep_seq=3\&. time=10\&. ms
+11 bytes from 8195\&.13: aep_seq=4\&. time=10\&. ms
+11 bytes from 8195\&.13: aep_seq=5\&. time=9\&. ms\fR\fB
+\fR\fB\fB^C\fR\fR\fB
+\fR\fB\-\-\-\-8195\&.13 AEP Statistics\-\-\-\-
 6 packets sent, 6 packets received, 0% packet loss
 round\-trip (ms)  min/avg/max = 9/9/10
-\fR.fi
-.SH OPTIONS
-.TP 
+\fR
+.fi
+.if n \{\
+.RE
+.\}
+.SH "OPTIONS"
+.PP
 \fB\-c\fR\fI count\fR
-Stop after \fIcount\fR packets.
+.RS 4
+Stop after
+\fIcount\fR
+packets\&.
+.RE
 .SH "SEE ALSO"
+.PP
 \fBping\fR(1),
 \fBatalk_aton\fR(3),
 \fBnbp_name\fR(3),
 \fBaep\fR(4),
-\fBatalkd\fR(8).
-
+\fBatalkd\fR(8)\&.
index e69e9867e16644ffe6edd1884563369cd551ad95..53634a9d834dcaa122ef04699e104b417b697f7b 100644 (file)
@@ -1,31 +1,50 @@
-.TH afile 1 "26 Feb 1998" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: afile
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 26 Feb 1998
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "AFILE" "1" "26 Feb 1998" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 afile \- display type and creator of Apple Macintosh files (netatalk format)
-.SH SYNOPSIS
-\fBafile\fR [\-a] \fBfile\fR \&...
-.sp 1
-.SH DESCRIPTION
-afile displays the name and Macintosh type and
-creator of the \fIfile\fR arguments. Tests
-whether the file is an AppleDouble header, in which case it checks the
-corresponding data fork exists, or assumes it is a data fork in which case
-it looks for the corresponding AppleDouble to find the type/creator
-information.
-.PP
-afile does not look at any of the extension
-mapping files such as AppleVolumes.system.
-.SH OPTIONS
-.TP 
+.SH "SYNOPSIS"
+.HP \w'\fBafile\fR\fB\fR\ 'u
+\fBafile\fR\fB\fR [\-a] \fIfile\fR...
+.br
+
+.SH "DESCRIPTION"
+.PP
+\fBafile\fR
+displays the name and Macintosh type and creator of the
+\fIfile\fR
+arguments\&. Tests whether the file is an AppleDouble header, in which case it checks the corresponding data fork exists, or assumes it is a data fork in which case it looks for the corresponding AppleDouble to find the type/creator information\&.
+.PP
+\fBafile\fR
+does not look at any of the extension mapping files such as AppleVolumes\&.system\&.
+.SH "OPTIONS"
+.PP
 \fB\-a\fR
-Include directories and data files of unknown type (i.e.
-without corresponding AppleDouble) in output.
-.SH DIAGNOSTICS
-returns exit status 0 if all files have a corresponding valid
-\&.AppleDouble header or data fork, or 99 for bad command line options.
-Otherwise it returns the following error code relating to the last invalid
-file.
+.RS 4
+Include directories and data files of unknown type (i\&.e\&. without corresponding AppleDouble) in output\&.
+.RE
+.SH "DIAGNOSTICS"
 .PP
-1 file doesn't exist
+returns exit status 0 if all files have a corresponding valid \&.AppleDouble header or data fork, or 99 for bad command line options\&. Otherwise it returns the following error code relating to the last invalid file\&.
+.PP
+1 file doesn\'t exist
 .PP
 2 file is unreadable
 .PP
@@ -43,6 +62,6 @@ file.
 .PP
 9 bad magic in AppleDouble
 .SH "SEE ALSO"
+.PP
 \fBachfile\fR(1),
 \fBafpd\fR(8)
-
index 8fd151513286b6a91e5a495fddff20f6339fe985..60ca2b90436ae89268368e35705e6c865e23971c 100644 (file)
-.TH afppasswd 1 "22 Aug 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: afppasswd
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 22 Aug 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "AFPPASSWD" "1" "22 Aug 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 afppasswd \- netatalk password maintenance utility
-.SH SYNOPSIS
-\fBafppasswd\fR [\-acfn] [ \-p
-\fBpasswd\fR \fBfile\fR ] [ \-u
-\fBminimum\fR \fBuid\fR ]
-.SH DESCRIPTION
-afppasswd allows the maintenance of afppasswd
-files created by netatalk for use by the uams_randnum.so UAM (providing
-the "Randnum exchange" and "2\-Way Randnum exchange" User Authentication
-Modules).
-.PP
-afppasswd can either be called by root with
-parameters, or can be called by local system users with no parameters to
-change their AFP passwords.
-.RS 
+.SH "SYNOPSIS"
+.HP \w'\fBafppasswd\fR\fB\fR\fB\fR\ 'u
+\fBafppasswd\fR\fB\fR\fB\fR [\-acfn] [\-p\ \fIpasswd\fR\ \fIfile\fR] [\-u\ \fIminimum\fR\ \fIuid\fR]
+.SH "DESCRIPTION"
+.PP
+\fBafppasswd\fR
+allows the maintenance of afppasswd files created by netatalk for use by the uams_randnum\&.so UAM (providing the "Randnum exchange" and "2\-Way Randnum exchange" User Authentication Modules)\&.
+.PP
+\fBafppasswd\fR
+can either be called by root with parameters, or can be called by local system users with no parameters to change their AFP passwords\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBNote\fR
+.ps -1
+.br
 .PP
-With this utility you can only change the passwords used by two
-specific UAMs. As they provide only weak password encryption, the use of
-the "Randnum exchange" and "2\-Way Randnum exchange" UAMs is deprecated
-unless one has to support very old AFP clients, that can not deal with
-the more secure "DHCAST128" UAM instead. Please compare with the [Cross reference to non\-existant ID \(lqauthentication\(rq] inside Netatalk's
-documentation.
+With this utility you can only change the passwords used by two specific UAMs\&. As they provide only weak password encryption, the use of the "Randnum exchange" and "2\-Way Randnum exchange" UAMs is deprecated unless one has to support very old AFP clients, that can not deal with the more secure "DHCAST128" UAM instead\&. Please compare with the
+Authentication chapter
+inside Netatalk\'s documentation\&.
+.sp .5v
 .RE
-.SH EXAMPLE
-Local user changing their own password:
+.SH "EXAMPLE"
 .PP
+Local user changing their own password:
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 example% \fBafppasswd\fR
 Enter NEW AFP password: \fB(hidden)\fR
 Enter NEW AFP password again: \fB(hidden)\fR
-afppasswd: updated password.
+afppasswd: updated password\&.
 .fi
-.SH OPTIONS
-.TP 
+.if n \{\
+.RE
+.\}
+.SH "OPTIONS"
+.PP
 \fB\-a\fR
-Add a new user to the afppasswd
-file.
-.TP 
+.RS 4
+Add a new user to the
+\fBafppasswd\fR
+file\&.
+.RE
+.PP
 \fB\-c\fR
-Create and/or initialize afppasswd file or
-specific user.
-.TP 
+.RS 4
+Create and/or initialize
+\fBafppasswd\fR
+file or specific user\&.
+.RE
+.PP
 \fB\-f\fR
-Force the current action.
-.TP 
+.RS 4
+Force the current action\&.
+.RE
+.PP
 \fB\-p\fR\fI path\fR
-Path to afppasswd file.
-.TP 
+.RS 4
+Path to
+\fBafppasswd\fR
+file\&.
+.RE
+.PP
 \fB\-n\fR
-If cracklib support is built into \fInetatalk\fR this option will cause cracklib
-checking to be disabled, if the superuser does not want to have the
-password run against the cracklib dictionary.
-.TP 
+.RS 4
+If cracklib support is built into
+\fBnetatalk\fR
+this option will cause cracklib checking to be disabled, if the superuser does not want to have the password run against the cracklib dictionary\&.
+.RE
+.PP
 \fB\-u\fR\fI minimum uid\fR
-This is the minimum \fIuser id\fR
-(uid) that afppasswd will use when creating
-users.
+.RS 4
+This is the minimum
+\fIuser id\fR
+(uid) that
+\fBafppasswd\fR
+will use when creating users\&.
+.RE
 .SH "SEE ALSO"
-\fBafpd\fR(8), \fBatalkd\fR(8).
-
+.PP
+\fBafpd\fR(8),
+\fBatalkd\fR(8)\&.
index 46ab6200361e7572822dc0ed4b937b9d4eceacb6..b4bf3eb9e6626e1eda48b6ad53572d19a45d3020 100644 (file)
@@ -1,28 +1,50 @@
-.TH apple_cp 1 "22 Aug 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: apple_cp
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 22 Aug 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "APPLE_CP" "1" "22 Aug 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 apple_cp \- Do an apple copy, copying file metadata and the resource fork as well
-.SH SYNOPSIS
-\fI:BINDIR:/apple_cp\fR \fISOURCE
-DEST\fR \fI:BINDIR:/apple_cp\fR \fISOURCE\fR... \fIDIRECTORY\fR
-.SH DESCRIPTION
-\fIapple_cp\fR is a perl script to copy
-SOURCE to DEST or multiple SOURCE(s) to DIRECTORY. It also copies the file 
-specific metadata (including resource forks) to the .AppleDouble directory
-for DEST or DIRECTORY. If the .AppleDouble directory doesn't exist for 
-DEST or DIRECTORY it will create it.
-.SH EXAMPLES
-\fI:BINDIR:/apple_cp\fR test.text
-/target/directory/
+.SH "SYNOPSIS"
 .PP
-\fI:BINDIR:/apple_cp\fR test.text
-/target/directory/test2.text
+\fB:BINDIR:/apple_cp\fR\fB\fR
+\fISOURCE DEST\fR
+\fB:BINDIR:/apple_cp\fR
+\fISOURCE\fR\&.\&.\&.
+\fIDIRECTORY\fR
+.SH "DESCRIPTION"
 .PP
-\fI:BINDIR:/apple_cp\fR test.text
-testing.text /target/directory/
+\fBapple_cp\fR
+is a perl script to copy SOURCE to DEST or multiple SOURCE(s) to DIRECTORY\&. It also copies the file specific metadata (including resource forks) to the \&.AppleDouble directory for DEST or DIRECTORY\&. If the \&.AppleDouble directory doesn\'t exist for DEST or DIRECTORY it will create it\&.
+.SH "EXAMPLES"
+.PP
+\fB:BINDIR:/apple_cp\fR
+test\&.text /target/directory/
+.PP
+\fB:BINDIR:/apple_cp\fR
+test\&.text /target/directory/test2\&.text
+.PP
+\fB:BINDIR:/apple_cp\fR
+test\&.text testing\&.text /target/directory/
 .SH "REPORTING BUGS"
-Report bugs to the Netatalk\-devel list
-<netatalk\-devel@lists.sourceforge.net>.
+.PP
+Report bugs to the Netatalk\-devel list <netatalk\-devel@lists\&.sourceforge\&.net>\&.
 .SH "SEE ALSO"
+.PP
 \fBapple_mv\fR(1),
-\fBapple_rm\fR(1).
-
+\fBapple_rm\fR(1)\&.
index 9790209e97ebfd8063a6aa46f0087d03038c1bc5..1cb18b995a03774da8b4af97a850e79466106ee2 100644 (file)
@@ -1,28 +1,50 @@
-.TH apple_mv 1 "22 Aug 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: apple_mv
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 22 Aug 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "APPLE_MV" "1" "22 Aug 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 apple_mv \- Do an apple move, moving metadata and the resource fork as well
-.SH SYNOPSIS
-\fI:BINDIR:/apple_mv\fR \fISOURCE
-DEST\fR \fI:BINDIR:/apple_mv\fR \fISOURCE\fR... \fIDIRECTORY\fR
-.SH DESCRIPTION
-\fIapple_mv\fR is a perl script to move
-SOURCE to DEST or multiple SOURCE(s) to DIRECTORY. It also moves the file 
-specific metadata (including resource forks) to the .AppleDouble directory
-for DEST or DIRECTORY. If the .AppleDouble directory doesn't exist for 
-DEST or DIRECTORY it will create it.
-.SH EXAMPLES
-\fI:BINDIR:/apple_mv\fR test.text
-/target/directory/
+.SH "SYNOPSIS"
 .PP
-\fI:BINDIR:/apple_mv\fR test.text
-/target/directory/test2.text
+\fB:BINDIR:/apple_mv\fR\fB\fR
+\fISOURCE DEST\fR
+\fB:BINDIR:/apple_mv\fR
+\fISOURCE\fR\&.\&.\&.
+\fIDIRECTORY\fR
+.SH "DESCRIPTION"
 .PP
-\fI:BINDIR:/apple_mv\fR test.text
-testing.text /target/directory/
+\fBapple_mv\fR
+is a perl script to move SOURCE to DEST or multiple SOURCE(s) to DIRECTORY\&. It also moves the file specific metadata (including resource forks) to the \&.AppleDouble directory for DEST or DIRECTORY\&. If the \&.AppleDouble directory doesn\'t exist for DEST or DIRECTORY it will create it\&.
+.SH "EXAMPLES"
+.PP
+\fB:BINDIR:/apple_mv\fR
+test\&.text /target/directory/
+.PP
+\fB:BINDIR:/apple_mv\fR
+test\&.text /target/directory/test2\&.text
+.PP
+\fB:BINDIR:/apple_mv\fR
+test\&.text testing\&.text /target/directory/
 .SH "REPORTING BUGS"
-Report bugs to the Netatalk\-devel list
-<netatalk\-devel@lists.sourceforge.net>.
+.PP
+Report bugs to the Netatalk\-devel list <netatalk\-devel@lists\&.sourceforge\&.net>\&.
 .SH "SEE ALSO"
+.PP
 \fBapple_cp\fR(1),
-\fBapple_rm\fR(1).
-
+\fBapple_rm\fR(1)\&.
index 185f707fd6bd4ef2a466acadc2efe129b20a24bf..60e554ca73544a9e2346ebb95cb58be1ee098cc0 100644 (file)
@@ -1,21 +1,46 @@
-.TH apple_rm 1 "22 Aug 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: apple_rm
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 22 Aug 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "APPLE_RM" "1" "22 Aug 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 apple_rm \- Do an apple remove, remove metadata and resource fork as well
-.SH SYNOPSIS
-\fI:BINDIR:/apple_rm\fR \fIFILE\fR...
-.SH DESCRIPTION
-\fIapple_rm\fR is a perl script that
-removes FILE(s) as well as the .AppleDouble metadata file(s) that
-corresponds to FILE(s). These AppleDouble header files eventually also
-contain the resource fork if the files had one. \fIapple_rm\fR does not delete directories.
-.SH EXAMPLES
-\fI:BINDIR:/apple_rm\fR test.text
+.SH "SYNOPSIS"
 .PP
-\fI:BINDIR:/apple_rm\fR test.text
-testing.text
+\fB:BINDIR:/apple_rm\fR\fB\fR
+\fIFILE\fR\&.\&.\&.
+.SH "DESCRIPTION"
+.PP
+\fBapple_rm\fR
+is a perl script that removes FILE(s) as well as the \&.AppleDouble metadata file(s) that corresponds to FILE(s)\&. These AppleDouble header files eventually also contain the resource fork if the files had one\&.
+\fBapple_rm\fR
+does not delete directories\&.
+.SH "EXAMPLES"
+.PP
+\fB:BINDIR:/apple_rm\fR
+test\&.text
+.PP
+\fB:BINDIR:/apple_rm\fR
+test\&.text testing\&.text
 .SH "REPORTING BUGS"
-Report bugs to the Netatalk\-devel list
-<netatalk\-devel@lists.sourceforge.net>.
+.PP
+Report bugs to the Netatalk\-devel list <netatalk\-devel@lists\&.sourceforge\&.net>\&.
 .SH "SEE ALSO"
-\fBapple_cp\fR(1), \fBapple_mv\fR(1).
-
+.PP
+\fBapple_cp\fR(1),
+\fBapple_mv\fR(1)\&.
index 9bf4e5ab21c5f14516ee9e9d4fcde63c26aa926e..0ca60573a4b4c7822ba15dac3181d9a89eee1213 100644 (file)
@@ -1,59 +1,89 @@
-.TH asip\-status.pl 1 "22 Aug 2004" 2.0.3 Netatalk 
-.SH NAME
-asip\-status.pl \- Queries AFP servers for their capabilities
-.SH SYNOPSIS
-\fI:BINDIR:/asip\-status.pl\fR ADDRESS\fI:PORT\fR...
-.SH DESCRIPTION
-\fIasip\-status.pl\fR is a perl script that
-sends a FPGetSrvrInfo request to an AFP server at ADDRESS:PORT and
-displays the results, namely "Machine type", the server's name, supported
-AFP versions, UAMs and AFP flags, the "server signature" and the network
-addresses, the server provides AFP services on.
+'\" t
+.\"     Title: asip-status.pl
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 22 Aug 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "ASIP\-STATUS\&.PL" "1" "22 Aug 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+asip-status.pl \- Queries AFP servers for their capabilities
+.SH "SYNOPSIS"
 .PP
-When you don't supply :PORT, then the default AFP port, 548, will be
-used.
-.SH EXAMPLES
+\fB:BINDIR:/asip\-status\&.pl\fR\fB\fR
+ADDRESS\fI:PORT\fR\&.\&.\&.
+.SH "DESCRIPTION"
+.PP
+\fBasip\-status\&.pl\fR
+is a perl script that sends a FPGetSrvrInfo request to an AFP server at ADDRESS:PORT and displays the results, namely "Machine type", the server\'s name, supported AFP versions, UAMs and AFP flags, the "server signature" and the network addresses, the server provides AFP services on\&.
+.PP
+When you don\'t supply :PORT, then the default AFP port, 548, will be used\&.
+.SH "EXAMPLES"
+.PP
+.if n \{\
+.RS 4
+.\}
 .nf
-\fI:BINDIR:/asip\-status.pl\fR 192.168.21.2
-AFP reply from 192.168.21.2:548
+\fB:BINDIR:/asip\-status\&.pl\fR 192\&.168\&.21\&.2
+AFP reply from 192\&.168\&.21\&.2:548
 Flags: 1  Cmd: 3  ID: 57005
 Reply: DSIGetStatus
 Request ID: 57005
 Machine type: Macintosh
-AFP versions: AFPVersion 1.1,AFPVersion 2.0,AFPVersion 2.1,AFP2.2
+AFP versions: AFPVersion 1\&.1,AFPVersion 2\&.0,AFPVersion 2\&.1,AFP2\&.2
 UAMs: Cleartxt passwrd,Randnum exchange,2\-Way Randnum exchange
 Flags: SupportsCopyFile,SupportsChgPwd,SupportsServerMessages,
 SupportsServerSignature,SupportsTCP/IP,SupportsSuperClient
 Server name: PowerMac 9600/200
 Signature:
-04 c1 6e 59 04 c1 6e 59 04 c1 6e 59 04 c1 6e 59  ..nY..nY..nY..nY
+04 c1 6e 59 04 c1 6e 59 04 c1 6e 59 04 c1 6e 59  \&.\&.nY\&.\&.nY\&.\&.nY\&.\&.nY
                                                   
-Network address: 192.168.21.2:548 (tcp/ip address and port)
-Network address: 10.20 (ddp address)
+Network address: 192\&.168\&.21\&.2:548 (tcp/ip address and port)
+Network address: 10\&.20 (ddp address)
 .fi
+.if n \{\
+.RE
+.\}
 .PP
+.if n \{\
+.RS 4
+.\}
 .nf
-\fI:BINDIR:/asip\-status.pl\fR 192.168.21.1:10548
-AFP reply from 192.168.21.1:10548
+\fB:BINDIR:/asip\-status\&.pl\fR 192\&.168\&.21\&.1:10548
+AFP reply from 192\&.168\&.21\&.1:10548
 Flags: 1  Cmd: 3  ID: 57005
 Reply: DSIGetStatus
 Request ID: 57005
 Machine type: Netatalk
-AFP versions: AFPVersion 1.1,AFPVersion 2.0,AFPVersion 2.1,AFP2.2,AFPX03,
-AFP3.1
+AFP versions: AFPVersion 1\&.1,AFPVersion 2\&.0,AFPVersion 2\&.1,AFP2\&.2,AFPX03,
+AFP3\&.1
 UAMs: Cleartxt passwrd,Randnum exchange,2\-Way Randnum exchange,DHCAST128
 Flags: SupportsCopyFile,SupportsServerMessages,SupportsServerSignature,
 SupportsTCP/IP,SupportsSrvrNotifications,SupportsOpenDirectory,
 SupportsUTF8Servername,SupportsSuperClient
 Server name: Fire V480
 Signature:
-83 29 cc 60 83 29 cc 60 83 29 cc 60 83 29 cc 60  .).`.).`.).`.).`
+83 29 cc 60 83 29 cc 60 83 29 cc 60 83 29 cc 60  \&.)\&.`\&.)\&.`\&.)\&.`\&.)\&.`
                                                   
-Network address: 192.168.21.1:10548 (TCP/IP address and port)
-Network address: 65282.142 (ddp address)
+Network address: 192\&.168\&.21\&.1:10548 (TCP/IP address and port)
+Network address: 65282\&.142 (ddp address)
 UTF8 Servername: Fire V480
 .fi
+.if n \{\
+.RE
+.\}
 .SH "REPORTING BUGS"
-Report bugs to the Netatalk\-devel list
-<netatalk\-devel@lists.sourceforge.net>.
-
+.PP
+Report bugs to the Netatalk\-devel list <netatalk\-devel@lists\&.sourceforge\&.net>\&.
index 32d168746e208125b80fb8accd1528fc059d49f6..5e301c3b1947e69c413430c6a34278aa655c6ec8 100644 (file)
@@ -1,23 +1,58 @@
-.TH cnid_index 1 "3 Jan 2005" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: cnid_index
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 3 Jan 2005
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "CNID_INDEX" "1" "3 Jan 2005" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 cnid_index \- check and repair Netatalk CNID database indexes
-.SH SYNOPSIS
-\fBcnid_index\fR \fBdbdir\fR 
-.SH DESCRIPTION
-cnid_index is a utility to check CNID databases
-for consistency. If needed, the indexes are repaired. It works for 
-databases created by the cdb and dbd backends.
+.SH "SYNOPSIS"
+.HP \w'\fBcnid_index\fR\fB\fR\fB\fR\ 'u
+\fBcnid_index\fR\fB\fR\fB\fR \fIdbdir\fR
+.SH "DESCRIPTION"
 .PP
-Volumes usind the dbd CNID scheme can also be checked automatically, 
-for further information please see the \fBcnid_dbd\fR(8) man page.
-.RS 
+\fBcnid_index\fR
+is a utility to check CNID databases for consistency\&. If needed, the indexes are repaired\&. It works for databases created by the cdb and dbd backends\&.
+.PP
+Volumes usind the dbd CNID scheme can also be checked automatically, for further information please see the
+\fBcnid_dbd\fR(8)
+man page\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBWarning\fR
+.ps -1
+.br
 .PP
-When using cnid_index on cdb handled databases, 
-cnid_index cannot check if another process (afpd) accesses
-the CNID databases. In this case, you have to manually ensure no other process 
-accesses the database when running cnid_index.
+When using
+\fBcnid_index\fR
+on cdb handled databases,
+\fBcnid_index\fR
+cannot check if another process (afpd) accesses the CNID databases\&. In this case, you have to manually ensure no other process accesses the database when running
+\fBcnid_index\fR\&.
+.sp .5v
 .RE
 .SH "SEE ALSO"
-\fBcnid_dbd\fR(8), \fBafpd\fR(8)
-
+.PP
+\fBcnid_dbd\fR(8),
+\fBafpd\fR(8)
index 1d0ccefe33835f10ebad3be6f3e2724ece52b4f4..7af0723df1abcc73d47ae6c215cb7e217e34ae51 100644 (file)
@@ -1,28 +1,54 @@
-.TH getzones 1 "17 Dec 1991" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: getzones
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 17 Dec 1991
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "GETZONES" "1" "17 Dec 1991" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 getzones \- list AppleTalk zone names
-.SH SYNOPSIS
-\fBgetzones\fR [\-m | \-l] [\fBaddress\fR]
-.SH DESCRIPTION
-\fIGetzones\fR is used to obtain a list of
-AppleTalk zone names using the Zone Information Protocol (ZIP). It sends a
-GetZoneList request to an AppleTalk router. By default, it sends the
-request to the locally running \fBatalkd\fR(8).
-.SH OPTIONS
-.TP 
+.SH "SYNOPSIS"
+.HP \w'\fBgetzones\fR\fB\fR\ 'u
+\fBgetzones\fR\fB\fR [\-m | \-l] [\fIaddress\fR]
+.SH "DESCRIPTION"
+.PP
+\fBGetzones\fR
+is used to obtain a list of AppleTalk zone names using the Zone Information Protocol (ZIP)\&. It sends a GetZoneList request to an AppleTalk router\&. By default, it sends the request to the locally running
+\fBatalkd\fR(8)\&.
+.SH "OPTIONS"
+.PP
 \fB\-m\fR
-List the name of the local zone only; this is accomplished by
-sending a ZIP GetMyZone request.
-.TP 
+.RS 4
+List the name of the local zone only; this is accomplished by sending a ZIP GetMyZone request\&.
+.RE
+.PP
 \fB\-l\fR
-List the local zones; this is accomplished by sending a
-GetLocalZones request.
-.TP 
+.RS 4
+List the local zones; this is accomplished by sending a GetLocalZones request\&.
+.RE
+.PP
 \fIaddress\fR
-Contact the AppleTalk router at \fIaddress.\fR
-\fIaddress\fR is parsed by
-\fBatalk_aton\fR(3).
+.RS 4
+Contact the AppleTalk router at
+\fIaddress\&.\fR
+\fIaddress\fR
+is parsed by
+\fBatalk_aton\fR(3)\&.
+.RE
 .SH "SEE ALSO"
+.PP
 \fBatalk_aton\fR(3),
-\fBatalkd\fR(8).
-
+\fBatalkd\fR(8)\&.
index 34253a1b42c9fcb84050dc534c65ccbffddfd769..ea819a11b9b507fc125fe413804911c50ba4c79b 100644 (file)
@@ -1,63 +1,87 @@
-.TH megatron 1 "8 Jan 1992" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: megatron
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 8 Jan 1992
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "MEGATRON" "1" "8 Jan 1992" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 megatron, unhex, unbin, unsingle, hqx2bin, single2bin, macbinary \- Macintosh file format transformer
-.SH SYNOPSIS
-\fBmegatron\fR [\fBsourcefile\fR]\&...
-.sp 1
-\fBunbin\fR [\fBsourcefile\fR]\&...
-.sp 1
-\fBunhex\fR [\fBsourcefile\fR]\&...
-.sp 1
-\fBunsingle\fR [\fBsourcefile\fR]\&...
-.sp 1
-\fBhqx2bin\fR [\fBsourcefile\fR]\&...
-.sp 1
-\fBsingle2bin\fR [\fBsourcefile\fR]\&...
-.sp 1
-\fBmacbinary\fR [\fBsourcefile\fR]\&...
-.SH DESCRIPTION
-megatron is used to transform files from BinHex,
-MacBinary, AppleSingle, or \fBnetatalk\fR style
-AppleDouble formats into MacBinary or \fInetatalk\fR
-style AppleDouble formats. The \fInetatalk\fR
-style AppleDouble format is the file format used by \fIafpd,\fR
-the \fInetatalk\fR Apple Filing Protocol
-(AppleShare) server. BinHex, MacBinary, and AppleSingle are commonly used
-formats for transferring Macintosh files between machines via email or
-file transfer protocols. megatron uses its name to
-determine what type of tranformation is being asked of it.
+.SH "SYNOPSIS"
+.HP \w'\fBmegatron\fR\fB\fR\fBunbin\fR\fB\fR\fBunhex\fR\fB\fR\fBunsingle\fR\fB\fR\fBhqx2bin\fR\fB\fR\fBsingle2bin\fR\fB\fR\fBmacbinary\fR\fB\fR\ 'u
+\fBmegatron\fR\fB\fR [\fIsourcefile\fR...]
+.br
+\fBunbin\fR\fB\fR [\fIsourcefile\fR...]
+.br
+\fBunhex\fR\fB\fR [\fIsourcefile\fR...]
+.br
+\fBunsingle\fR\fB\fR [\fIsourcefile\fR...]
+.br
+\fBhqx2bin\fR\fB\fR [\fIsourcefile\fR...]
+.br
+\fBsingle2bin\fR\fB\fR [\fIsourcefile\fR...]
+.br
+\fBmacbinary\fR\fB\fR [\fIsourcefile\fR...]
+.SH "DESCRIPTION"
 .PP
-If megatron is called as unhex
-, unbin or unsingle, it tries to
-convert file(s) from BinHex, MacBinary, or AppleSingle into AppleDouble
-format. BinHex is the format most often used to send Macintosh files by
-e\-mail. Usually these files have an extension of ".hqx". MacBinary
-is the format most often used by terminal emulators "on the fly"
-when transferring Macintosh files in binary mode. MacBinary files often
-have an extension of ".bin". Some Macintosh LAN\-based email
-packages use uuencoded AppleSingle format to "attach" or
-"enclose" files in email. AppleSingle files don't have a
-standard filename extension.
+\fBmegatron\fR
+is used to transform files from BinHex, MacBinary, AppleSingle, or
+\fBnetatalk\fR
+style AppleDouble formats into MacBinary or
+\fBnetatalk\fR
+style AppleDouble formats\&. The
+\fBnetatalk\fR
+style AppleDouble format is the file format used by
+\fBafpd,\fR
+the
+\fBnetatalk\fR
+Apple Filing Protocol (AppleShare) server\&. BinHex, MacBinary, and AppleSingle are commonly used formats for transferring Macintosh files between machines via email or file transfer protocols\&.
+\fBmegatron\fR
+uses its name to determine what type of tranformation is being asked of it\&.
 .PP
-If megatron is called as hqx2bin,
-single2bin, or macbinary, it will
-try to convert the file(s) from BinHex, AppleSingle, or AppleDouble into
-MacBinary. This last translation may be useful in moving Macintosh files
-from your afpd server to some other machine when you
-can't copy them from the server using a Macintosh for some reason.
+If
+\fBmegatron\fR
+is called as
+\fBunhex\fR
+,
+\fBunbin\fR
+or
+\fBunsingle\fR, it tries to convert file(s) from BinHex, MacBinary, or AppleSingle into AppleDouble format\&. BinHex is the format most often used to send Macintosh files by e\-mail\&. Usually these files have an extension of "\&.hqx"\&. MacBinary is the format most often used by terminal emulators "on the fly" when transferring Macintosh files in binary mode\&. MacBinary files often have an extension of "\&.bin"\&. Some Macintosh LAN\-based email packages use uuencoded AppleSingle format to "attach" or "enclose" files in email\&. AppleSingle files don\'t have a standard filename extension\&.
 .PP
-If megatron is called with any other name, it
-uses the default translation, namely unhex.
+If
+\fBmegatron\fR
+is called as
+\fBhqx2bin\fR,
+\fBsingle2bin\fR, or
+\fBmacbinary\fR, it will try to convert the file(s) from BinHex, AppleSingle, or AppleDouble into MacBinary\&. This last translation may be useful in moving Macintosh files from your
+\fBafpd\fR
+server to some other machine when you can\'t copy them from the server using a Macintosh for some reason\&.
 .PP
-If no source file is given, or if \fIsourcefile\fR
-is `\fB\-\fR', and if the
-conversion is from a BinHex or MacBinary file, megatron
-will read from standard input.
+If
+\fBmegatron\fR
+is called with any other name, it uses the default translation, namely
+\fBunhex\fR\&.
 .PP
-The filename used to store any output file is the filename that is
-encoded in the source file. MacBinary files are created with a
-".bin" extension. In the case of conflicts, the old file is
-overwritten!
+If no source file is given, or if
+\fIsourcefile\fR
+is `\fB\-\fR\', and if the conversion is from a BinHex or MacBinary file,
+\fBmegatron\fR
+will read from standard input\&.
+.PP
+The filename used to store any output file is the filename that is encoded in the source file\&. MacBinary files are created with a "\&.bin" extension\&. In the case of conflicts, the old file is overwritten!
 .SH "SEE ALSO"
+.PP
 \fBafpd\fR(8)
-
index a152602a234f0900c5f0f57632b3ec172323850f..7ea7d531e623d2da4dd351645ec97cf866430add 100644 (file)
-.TH nbp 1 "24 June 2004" 2.0.3 Netatalk 
-.SH NAME
-nbplkup, nbprgstr, nbpunrgstr \- access NBP database
-.SH SYNOPSIS
-\fBnbplkup \fR[\-r \fBmaxresponses\fR] [\-A \fBaddress\fR] [\-m \fBmaccodepage\fR] \fBnbpname\fR 
+'\" t
+.\"     Title: nbp
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 24 June 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "NBP" "1" "24 June 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+nbp, nbplkup, nbprgstr, nbpunrgstr \- access NBP database
+.SH "SYNOPSIS"
+.HP \w'\fBnbplkup\fR\fB\fR\fB\fR\fB\ \fR\ 'u
+\fBnbplkup\fR\fB\fR\fB\fR\fB \fR [\-r\ \fImaxresponses\fR] [\-A\ \fIaddress\fR] [\-m\ \fImaccodepage\fR] \fInbpname\fR
+.HP \w'\fBnbprgstr\fR\fB\fR\fB\ \fR\ 'u
+\fBnbprgstr\fR\fB\fR\fB \fR [\-A\ \fIaddress\fR] [\-p\ \fIport\fR] [\-m\ \fImaccodepage\fR] \fInbpname\fR
+.HP \w'\fBnbpunrgstr\fR\fB\fR\fB\ \fR\ 'u
+\fBnbpunrgstr\fR\fB\fR\fB \fR [\-A\ \fIaddress\fR] [\-m\ \fImaccodepage\fR] \fInbpname\fR
+.SH "DESCRIPTION"
 .PP
-\fBnbprgstr \fR[\-A \fBaddress\fR] [\-p \fBport\fR] [\-m \fBmaccodepage\fR] \fBnbpname\fR 
+\fBnbprgstr\fR
+registers
+\fInbpname\fR
+with
+\fBatalkd\fR(8), at the given
+\fIport\fR\&.
+\fBnbpunrgstr\fR
+informs
+\fBatalkd\fR
+that
+\fInbpname\fR
+is no longer to be advertised\&.
 .PP
-\fBnbpunrgstr \fR[\-A \fBaddress\fR] [\-m \fBmaccodepage\fR] \fBnbpname\fR 
-.SH DESCRIPTION
-nbprgstr registers \fInbpname\fR
-with \fBatalkd\fR(8),
-at the given \fIport\fR. nbpunrgstr
-informs \fIatalkd\fR that
-\fInbpname\fR is no longer to be advertised.
-.PP
-nbplkup displays up to
-\fImaxresponses\fR (default 1000) entities registered
-on the AppleTalk internet. \fInbpname\fR
-is parsed by \fBnbp_name\fR(3).
-An `\fI=\fR' for the \fIobject\fR
-or \fItype\fR matches anything, and an `\fI*\fR' for \fIzone\fR means
-the local zone. The default values are taken from the \fINBPLKUP\fR
-environment variable, parsed as an \fInbpname\fR.
+\fBnbplkup\fR
+displays up to
+\fImaxresponses\fR
+(default 1000) entities registered on the AppleTalk internet\&.
+\fI\fInbpname\fR\fR
+is parsed by
+\fBnbp_name\fR(3)\&. An `\fB=\fR\' for the
+\fIobject\fR
+or
+\fItype\fR
+matches anything, and an `\fB*\fR\' for
+\fIzone\fR
+means the local zone\&. The default values are taken from the
+\fBNBPLKUP\fR
+environment variable, parsed as an
+\fInbpname\fR\&.
 .SH "ENVIRONMENT VARIABLES"
-.TP 
+.PP
 NBPLKUP
+.RS 4
 default nbpname for nbplkup
-.TP 
+.RE
+.PP
 ATALK_MAC_CHARSET
+.RS 4
 the codepage used by the clients on the Appletalk network
-.TP 
+.RE
+.PP
 ATALK_UNIX_CHARSET
-the codepage used to display extended characters on this
-shell.
-.SH EXAMPLE
-Find all devices of type \fILaserWriter\fR
-in the local zone.
+.RS 4
+the codepage used to display extended characters on this shell\&.
+.RE
+.SH "EXAMPLE"
 .PP
+Find all devices of type
+\fBLaserWriter\fR
+in the local zone\&.
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 example% \fBnbplkup :LaserWriter\fR
-               Petoskey:LaserWriter        7942.129:218
-             Gloucester:LaserWriter        8200.188:186
-                 Rahway:LaserWriter        7942.2:138
-             517 Center:LaserWriter        7942.2:132
-                  ionia:LaserWriter        7942.2:136
-     Evil DEC from Hell:LaserWriter        7942.2:130
-              Hamtramck:LaserWriter        7942.2:134
-         Iron Mountain :LaserWriter        7942.128:250
+               Petoskey:LaserWriter        7942\&.129:218
+             Gloucester:LaserWriter        8200\&.188:186
+                 Rahway:LaserWriter        7942\&.2:138
+             517 Center:LaserWriter        7942\&.2:132
+                  ionia:LaserWriter        7942\&.2:136
+     Evil DEC from Hell:LaserWriter        7942\&.2:130
+              Hamtramck:LaserWriter        7942\&.2:134
+         Iron Mountain :LaserWriter        7942\&.128:250
 example%
 .fi
+.if n \{\
+.RE
+.\}
 .SH "SEE ALSO"
+.PP
 \fBnbp_name\fR(3),
-\fBatalkd\fR(8).
-
+\fBatalkd\fR(8)\&.
index 5dad3ac54a6e2ad70af6dfdbbb67166d9724ec06..c2927b3334d3c6000485c6c481addd549543d266 100644 (file)
-.TH netatalk\-config 1 "09 June 2001" 2.0.3 Netatalk 
-.SH NAME
-netatalk\-config \- script to get information about the installed version of netatalk
-.SH SYNOPSIS
-\fBnetatalk\-config\fR [ \-\-prefix [\fB=DIR\fR]] [ \-\-exec_prefix [\fB=DIR\fR]] [\-\-help] [\-\-version] [\-\-libs] [\-\-libs\-dirs] [\-\-libs\-names] [\-\-cflags] [\-\-macros]
-.SH DESCRIPTION
-netatalk\-config is a tool that is used to
-determine the compiler and linker flags that should be used
-to compile and link programs that use the \fInetatalk\fR
-run\-time libraries.
-.SH OPTIONS
-netatalk\-config accepts the following options:
-.TP 
+'\" t
+.\"     Title: netatalk-config
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 09 June 2001
+.\"    Manual: The Netatalk Project
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "NETATALK\-CONFIG" "1" "09 June 2001" "Netatalk 2\&.0\&.4" "The Netatalk Project"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+netatalk-config \- script to get information about the installed version of netatalk
+.SH "SYNOPSIS"
+.HP \w'\fBnetatalk\-config\fR\fB\fR\ 'u
+\fBnetatalk\-config\fR\fB\fR [\-\-prefix\ [\fI=DIR\fR]] [\-\-exec_prefix\ [\fI=DIR\fR]] [\-\-help] [\-\-version] [\-\-libs] [\-\-libs\-dirs] [\-\-libs\-names] [\-\-cflags] [\-\-macros]
+.SH "DESCRIPTION"
+.PP
+\fBnetatalk\-config\fR
+is a tool that is used to determine the compiler and linker flags that should be used to compile and link programs that use the
+\fInetatalk\fR
+run\-time libraries\&.
+.SH "OPTIONS"
+.PP
+\fBnetatalk\-config\fR
+accepts the following options:
+.PP
 \fB\-\-help\fR
-Print a short help for this command and exit.
-.TP 
+.RS 4
+Print a short help for this command and exit\&.
+.RE
+.PP
 \fB\-\-version\fR
-Print the currently installed version of \fInetatalk\fR
-on the standard output.
-.TP 
+.RS 4
+Print the currently installed version of
+\fInetatalk\fR
+on the standard output\&.
+.RE
+.PP
 \fB\-\-libs\fR
+.RS 4
 Print the linker flags that are necessary to link against the
-\fInetatalk\fR run\-time libraries.
-.TP 
+\fInetatalk\fR
+run\-time libraries\&.
+.RE
+.PP
 \fB\-\-libs\-dirs\fR
-Print only the \-l/\-R part of \-\-libs.
-.TP 
+.RS 4
+Print only the \-l/\-R part of \-\-libs\&.
+.RE
+.PP
 \fB\-\-libs\-names\fR
-Print only the \-l part of \-\-libs.
-.TP 
+.RS 4
+Print only the \-l part of \-\-libs\&.
+.RE
+.PP
 \fB\-\-cflags\fR
-Print the compiler flags that are necessary to compile a
-program linked against the \fInetatalk\fR
-run\-time libraries.
-.TP 
+.RS 4
+Print the compiler flags that are necessary to compile a program linked against the
+\fInetatalk\fR
+run\-time libraries\&.
+.RE
+.PP
 \fB\-\-macros\fR
-Print the \fInetatalk\fR m4
-directory.
-.TP 
+.RS 4
+Print the
+\fInetatalk\fR
+m4 directory\&.
+.RE
+.PP
 \fB\-\-prefix=PREFIX\fR
-If specified, use PREFIX instead of the installation prefix
-that \fInetatalk\fR was built with when
-computing the output for the \-\-cflags and \-\-libs options. This
-option is also used for the exec prefix if \-\-exec\-prefix was not
-specified. This option must be specified before any \-\-libs or
-\-\-cflags options.
-.TP 
-\fB\-\-exec\\_prefix=PREFIX\fR
-If specified, use PREFIX instead of the installation exec
-prefix that \fInetatalk\fR was built with
-when computing the output for the \-\-cflags and \-\-libs options. This
-option must be specified before any \-\-libs or \-\-cflags options.
-.SH COPYRIGHT
+.RS 4
+If specified, use PREFIX instead of the installation prefix that
+\fInetatalk\fR
+was built with when computing the output for the \-\-cflags and \-\-libs options\&. This option is also used for the exec prefix if \-\-exec\-prefix was not specified\&. This option must be specified before any \-\-libs or \-\-cflags options\&.
+.RE
+.PP
+\fB\-\-exec\e_prefix=PREFIX\fR
+.RS 4
+If specified, use PREFIX instead of the installation exec prefix that
+\fInetatalk\fR
+was built with when computing the output for the \-\-cflags and \-\-libs options\&. This option must be specified before any \-\-libs or \-\-cflags options\&.
+.RE
+.SH "COPYRIGHT"
+.PP
 Copyright \(co 1998 Owen Taylor
 .PP
-Permission to use, copy, modify, and distribute this software and
-its documentation for any purpose and without fee is hereby granted,
-provided that the above copyright notice appear in all copies and that
-both that copyright notice and this permission notice appear in supporting
-documentation.
+Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation\&.
 .PP
-Man page adapted for netatalk\-config by Sebastian
-Rittau in 2001.
-
+Man page adapted for
+\fBnetatalk\-config\fR
+by Sebastian Rittau in 2001\&.
index f4e62f2952d7e73d5bc0cacec077a75ba5302b12..3b3028aa8b2d9da8f24f8d52eda669ce26a752e7 100644 (file)
-.TH pap 1 "6 May 2002" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: pap
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 6 May 2002
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "PAP" "1" "6 May 2002" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 pap \- client interface to remote printers using Printer Access Protocol
-.SH SYNOPSIS
-\fBpap\fR [ \-A \fBaddress\fR ] [\-c] [\-d] [\-e] [\-E] [ \-p \fBnbpname\fR ] [ \-s \fBstatusfile\fR ] [\-w] [\-W] [\fBFILES\fR]
-.SH DESCRIPTION
-pap is used to connect and send files to an
-AppleTalk connected printer using the Apple Printer Access Protocol (PAP).
-When pap starts execution, it tries to open a session
-with the printer using PAP, and then downloads the \fIfiles\fR
-to the printer.
+.SH "SYNOPSIS"
+.HP \w'\fBpap\fR\fB\fR\ 'u
+\fBpap\fR\fB\fR [\-A\ \fIaddress\fR] [\-c] [\-d] [\-e] [\-E] [\-p\ \fInbpname\fR] [\-s\ \fIstatusfile\fR] [\-w] [\-W] [\fIFILES\fR]
+.SH "DESCRIPTION"
 .PP
-If no \fIfiles\fR are given on the command
-line, pap begins reading from standard input.
+\fBpap\fR
+is used to connect and send files to an AppleTalk connected printer using the Apple Printer Access Protocol (PAP)\&. When
+\fBpap\fR
+starts execution, it tries to open a session with the printer using PAP, and then downloads the
+\fIfiles\fR
+to the printer\&.
 .PP
-If no printer is specified on the command line, pap
-looks for a file called .paprc in the current working
-directory and reads it to obtain the \fInbpname\fR
-of a printer. Blank lines and lines that begin with a `\fI#\fR'
-are ignored. \fItype\fR and \fIzone\fR
-default to \fILaserWriter\fR and the zone of the
-local host, respectively.
+If no
+\fIfiles\fR
+are given on the command line,
+\fBpap\fR
+begins reading from standard input\&.
 .PP
-Note that pap is designed to be useful as a
-communication filter for sending \fBlpd\fR(8)
-spooled print jobs to AppleTalk connected printers. See
+If no printer is specified on the command line,
+\fBpap\fR
+looks for a file called
+\fB\&.paprc\fR
+in the current working directory and reads it to obtain the
+\fInbpname\fR
+of a printer\&. Blank lines and lines that begin with a `\fB#\fR\' are ignored\&.
+\fItype\fR
+and
+\fIzone\fR
+default to
+\fBLaserWriter\fR
+and the zone of the local host, respectively\&.
+.PP
+Note that
+\fBpap\fR
+is designed to be useful as a communication filter for sending
+\fBlpd\fR(8)
+spooled print jobs to AppleTalk connected printers\&. See
 \fBpsf\fR(8)
-for hints on how to use it this way.
-.SH OPTIONS
-.TP 
+for hints on how to use it this way\&.
+.SH "OPTIONS"
+.PP
 \fB\-A \fR\fIaddress\fR
-Connect to the printer with Appletalk address \fIaddress\fR and do not consult the
-\&.paprc file to find a printer name. See
+.RS 4
+Connect to the printer with Appletalk address
+\fIaddress\fR
+and do not consult the
+\fB\&.paprc\fR
+file to find a printer name\&. See
 \fBatalk_aton\fR(3)
-for the syntax of \fIaddress\fR.
-.TP 
+for the syntax of
+\fIaddress\fR\&.
+.RE
+.PP
 \fB\-c\fR
-Take cuts. The PAP protocol specified a simple queuing
-procedure, such that the clients tell the printer how long they have
-been waiting to print. This option causes pap to
-lie about how long it has been waiting.
-.TP 
+.RS 4
+Take cuts\&. The PAP protocol specified a simple queuing procedure, such that the clients tell the printer how long they have been waiting to print\&. This option causes
+\fBpap\fR
+to lie about how long it has been waiting\&.
+.RE
+.PP
 \fB\-d\fR
-Enable debug output.
-.TP 
+.RS 4
+Enable debug output\&.
+.RE
+.PP
 \fB\-e\fR
-Send any message from the printer to stderr instead of stdout.
+.RS 4
+Send any message from the printer to stderr instead of stdout\&.
 \fBpsf\fR(8)
-invokes pap with this option.
-.TP 
+invokes
+\fBpap\fR
+with this option\&.
+.RE
+.PP
 \fB\-E\fR
-Don't wait for EOF from the printer. This option is useful
-for printers which don't implement PAP correctly. In a correct
-implementation, the client side should wait for the printer to
-return EOF before closing the connection. Some clients don't
-wait, and hence some printers have related bugs in their
-implementation.
-.TP 
+.RS 4
+Don\'t wait for EOF from the printer\&. This option is useful for printers which don\'t implement PAP correctly\&. In a correct implementation, the client side should wait for the printer to return EOF before closing the connection\&. Some clients don\'t wait, and hence some printers have related bugs in their implementation\&.
+.RE
+.PP
 \fB\-p\fR \fInbpname\fR
-Connect to the printer named \fInbpname\fR
-and do not consult the .paprc file to find a
-printer name. See \fBnbp_name\fR(3)
-for the syntax of \fInbpname\fR.
-.TP 
+.RS 4
+Connect to the printer named
+\fInbpname\fR
+and do not consult the
+\fB\&.paprc\fR
+file to find a printer name\&. See
+\fBnbp_name\fR(3)
+for the syntax of
+\fInbpname\fR\&.
+.RE
+.PP
 \fB\-s\fR \fIstatusfile\fR
-Update the file called \fIstatusfile\fR
-to contain the most recent status message from the printer.
-pap gets the status from the printer when it is
-waiting for the printer to process input. The \fIstatusfile\fR
-will contain a single line terminated with a newline. This is useful
-when pap is invoked by
+.RS 4
+Update the file called
+\fIstatusfile\fR
+to contain the most recent status message from the printer\&.
+\fBpap\fR
+gets the status from the printer when it is waiting for the printer to process input\&. The
+\fIstatusfile\fR
+will contain a single line terminated with a newline\&. This is useful when
+\fBpap\fR
+is invoked by
 \fBpsf\fR(8)
-within \fIlpd\fR's spool directory.
-.TP 
+within
+\fBlpd\fR\'s spool directory\&.
+.RE
+.PP
 \fB\-w\fR
-Wait for the printer status to contain the word
-"waiting" before sending the job. This is to defeat
-printer\-side spool available on HP IV and V printers.
-.TP 
+.RS 4
+Wait for the printer status to contain the word "waiting" before sending the job\&. This is to defeat printer\-side spool available on HP IV and V printers\&.
+.RE
+.PP
 \fB\-W\fR
-Wait for the printer status to contain the word "idle"
-before sending the job. This is to defeat printer\-side spool
-available on HP IV and V printers.
-.SH FILES
-.TP 
-\&.paprc
-file read to obtain printer name if not specified on command
-line
+.RS 4
+Wait for the printer status to contain the word "idle" before sending the job\&. This is to defeat printer\-side spool available on HP IV and V printers\&.
+.RE
+.SH "FILES"
+.PP
+\fB\&.paprc\fR
+.RS 4
+file read to obtain printer name if not specified on command line
+.RE
 .SH "SEE ALSO"
+.PP
 \fBnbp_name\fR(3),
 \fBatalk_aton\fR(3),
 \fBlpd\fR(8),
-\fBpsf\fR(8).
-
+\fBpsf\fR(8)\&.
index bd03bcf4c78c68b16efe0348730d1181580a3fe1..9cfd6a2608884c0fcadca15ad8272441aba15e15 100644 (file)
@@ -1,38 +1,59 @@
-.TH psorder 1 "17 Dec 1991" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: psorder
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 17 Dec 1991
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "PSORDER" "1" "17 Dec 1991" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 psorder \- PostScript pageorder filter
-.SH SYNOPSIS
-\fBpsorder\fR [\-duf] \fBsourcefile\fR 
-.SH DESCRIPTION
-psorder is a filter that re\-orders the pages of a
-PostScript document. The result is written to the standard output. By
-default, documents are processed into ascending order (the lowest numbered
-page is printed first). Some PostScript documents specify that the order
-of their pages should never be changed; the default action of
-psorder is to follow this specification.
+.SH "SYNOPSIS"
+.HP \w'\fBpsorder\fR\fB\fR\ 'u
+\fBpsorder\fR\fB\fR [\-duf] \fIsourcefile\fR
+.SH "DESCRIPTION"
+.PP
+\fBpsorder\fR
+is a filter that re\-orders the pages of a PostScript document\&. The result is written to the standard output\&. By default, documents are processed into ascending order (the lowest numbered page is printed first)\&. Some PostScript documents specify that the order of their pages should never be changed; the default action of
+\fBpsorder\fR
+is to follow this specification\&.
+.PP
+If no source file is given, or if
+\fIsourcefile\fR
+is `\fB\-\fR\',
+\fBpsorder\fR
+reads from the standard input file\&.
+.SH "OPTIONS"
 .PP
-If no source file is given, or if \fIsourcefile\fR
-is `\fI\-\fR', psorder
-reads from the standard input file.
-.SH OPTIONS
-.TP 
 \fB\-d\fR
-Re\-order the pages of the document in downward or descending
-order. This is typically used to change the order of a document to
-be printed by a printer that stacks pages face\-up, such as an Apple
-LaserWriter or LaserWriter Plus.
-.TP 
+.RS 4
+Re\-order the pages of the document in downward or descending order\&. This is typically used to change the order of a document to be printed by a printer that stacks pages face\-up, such as an Apple LaserWriter or LaserWriter Plus\&.
+.RE
+.PP
 \fB\-u\fR
-Specifies forward order, and is the default. It is used to try
-and ensure the correct ordering when a document will be printed by a
-printer that stacks the pages face\-down.
-.TP 
+.RS 4
+Specifies forward order, and is the default\&. It is used to try and ensure the correct ordering when a document will be printed by a printer that stacks the pages face\-down\&.
+.RE
+.PP
 \fB\-f\fR
-Force psorder to re\-order the pages, even
-if the document claims that its page order is not to be trifled
-with. This option should only be used experimentally, as it may
-cause documents to print incorrectly.
+.RS 4
+Force
+\fBpsorder\fR
+to re\-order the pages, even if the document claims that its page order is not to be trifled with\&. This option should only be used experimentally, as it may cause documents to print incorrectly\&.
+.RE
 .SH "SEE ALSO"
+.PP
 \fBpsf\fR(8),
-\fBlpr\fR(1).
-
+\fBlpr\fR(1)\&.
index b924d04d46a45b95df28bce8680fa70ba739b5ab..65b0ccb6137319cf2533f402a839e1076f86f419 100644 (file)
-.TH uniconv 1 "24 Jun 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: uniconv
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 24 Jun 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "UNICONV" "1" "24 Jun 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 uniconv \- convert Netatalk volume encoding
-.SH SYNOPSIS
-\fBuniconv\fR [\-ndv] \-c \fBcnidbackend\fR \-f \fBfromcode\fR \-t \fBtocode\fR [\-m \fBmaccode\fR] \fBvolumepath\fR 
-.SH DESCRIPTION
-uniconv converts the volume encoding of
-\fIvolumepath\fR from the \fIfromcode\fR
-to the \fItocode\fR encoding.
-.SH OPTIONS
-.TP 
+.SH "SYNOPSIS"
+.HP \w'\fBuniconv\fR\fB\fR\ 'u
+\fBuniconv\fR\fB\fR [\-ndv] \-c\ \fIcnidbackend\fR \-f\ \fIfromcode\fR \-t\ \fItocode\fR [\-m\ \fImaccode\fR] \fIvolumepath\fR
+.SH "DESCRIPTION"
+.PP
+\fBuniconv\fR
+converts the volume encoding of
+\fIvolumepath\fR
+from the
+\fIfromcode\fR
+to the
+\fItocode\fR
+encoding\&.
+.SH "OPTIONS"
+.PP
 \-c
-CNID backend used on this volume, usually cdb or dbd. Should
-match the backend selected with afpd for this volume. If not
-specified, the default CNID backend `:DEFAULT_CNID_SCHEME:' is
-used
-.TP 
+.RS 4
+CNID backend used on this volume, usually cdb or dbd\&. Should match the backend selected with afpd for this volume\&. If not specified, the default CNID backend `:DEFAULT_CNID_SCHEME:\' is used
+.RE
+.PP
 \-d
-don't CAP encode leading dots (:2e), equivalent to
-\fBusedots\fR in \fBAppleVolumes.default\fR(5)
-.TP 
+.RS 4
+don\'t CAP encode leading dots (:2e), equivalent to
+\fBusedots\fR
+in
+\fBAppleVolumes.default\fR(5)
+.RE
+.PP
 \-f
+.RS 4
 encoding to convert from, use ASCII for CAP encoded volumes
-.TP 
+.RE
+.PP
 \-h
+.RS 4
 display help
-.TP 
+.RE
+.PP
 \-m
-Macintosh client codepage, required for CAP encoded volumes.
-Defaults to `MAC_ROMAN'
-.TP 
+.RS 4
+Macintosh client codepage, required for CAP encoded volumes\&. Defaults to `MAC_ROMAN\'
+.RE
+.PP
 \-n
-`dry run', don't do any real changes
-.TP 
+.RS 4
+`dry run\', don\'t do any real changes
+.RE
+.PP
 \-t
-volume encoding to convert to, e.g. UTF8
-.TP 
+.RS 4
+volume encoding to convert to, e\&.g\&. UTF8
+.RE
+.PP
 \-v
-verbose output, use twice for maximum logging.
-.TP 
+.RS 4
+verbose output, use twice for maximum logging\&.
+.RE
+.PP
 \-V
+.RS 4
 print version and exit
+.RE
+.PP
+.SH "WARNING"
 .PP
-.SH WARNING
-Setting the wrong options might render your data unusable!!! Make
-sure you know what you are doing. Always backup your data first.
+Setting the wrong options might render your data unusable!!! Make sure you know what you are doing\&. Always backup your data first\&.
 .PP
-It is \fB*strongly*\fR recommended to do
-a `dry run' first and to check the output for conversion errors.
+It is
+\fB*strongly*\fR
+recommended to do a `dry run\' first and to check the output for conversion errors\&.
 .PP
 \fBafpd\fR(8)
-should \fInot\fR be running while you change the volume
-encoding. Remember to change \fBvolcodepage\fR in
+should
+\fInot\fR
+be running while you change the volume encoding\&. Remember to change
+\fBvolcodepage\fR
+in
 \fBAppleVolumes.default\fR(5)
-to the new codepage, before restarting afpd.
+to the new codepage, before restarting afpd\&.
 .PP
 \fBUSE AT YOUR OWN RISK!!!\fR
 .SH "SELECTABLE CHARSETS"
-Netatalk provides internal support for UTF\-8 (pre\- and decomposed)
-and CAP. If you want to use other charsets, they must be provided by
+.PP
+Netatalk provides internal support for UTF\-8 (pre\- and decomposed) and CAP\&. If you want to use other charsets, they must be provided by
 \fBiconv\fR(1)
 .PP
-uniconv also knows iso\-8859.adapted, an old style
-1.x NLS widely used. This is only intended for upgrading old volumes,
+\fBuniconv\fR
+also knows iso\-8859\&.adapted, an old style 1\&.x NLS widely used\&. This is only intended for upgrading old volumes,
 \fBafpd\fR(8)
-cannot handle iso\-8859.adapted anymore.
+cannot handle iso\-8859\&.adapted anymore\&.
 .SH "CNID BACKGROUND"
-The CNID backends maintains name to ID mappings. If you change a
-filename outside afpd(8) (shell, samba), the CNID db, i.e. the DIDNAME
-index, gets inconsistent. Netatalk tries to recover from such
-inconsistencies as gracefully as possible. The mechanisms to resolve such
-inconsistencies may fail sometimes, though, as this is not an easy task to
-accomplish. I.e. if several names in the path to the file or directory
-have changed, things may go wrong.
-.PP
-If you change a lot of filenames at once, chances are higher that
-the afpds fallback mechanisms fail, i.e. files will be assigned new IDs,
-even though the file hasn't changed. uniconv
-therefore updates the CNID entry for each file/directory directly after it
-changes the name to avoid inconsistencies. The two supported backends for
-volumes, dbd and cdb, use the same CNID db format. Therefore, you
-\fIcould\fR use uniconv with cdb and
-afpd with dbd later.
-.PP
-\fBWarning\fR: There must not be two
-processes opening the CNID database using different backends at once! If a
-volume is still opened with dbd (cnid_metad/cnid_dbd) and you start
-uniconv with cdb, the result will be a corrupted CNID
-database, as the two backends use different locking schemes. You might run
-into additional problems, e.g. if dbd is compiled with transactions, cdb
-will not update the transaction logs.
+.PP
+The CNID backends maintains name to ID mappings\&. If you change a filename outside afpd(8) (shell, samba), the CNID db, i\&.e\&. the DIDNAME index, gets inconsistent\&. Netatalk tries to recover from such inconsistencies as gracefully as possible\&. The mechanisms to resolve such inconsistencies may fail sometimes, though, as this is not an easy task to accomplish\&. I\&.e\&. if several names in the path to the file or directory have changed, things may go wrong\&.
+.PP
+If you change a lot of filenames at once, chances are higher that the afpds fallback mechanisms fail, i\&.e\&. files will be assigned new IDs, even though the file hasn\'t changed\&.
+\fBuniconv\fR
+therefore updates the CNID entry for each file/directory directly after it changes the name to avoid inconsistencies\&. The two supported backends for volumes, dbd and cdb, use the same CNID db format\&. Therefore, you
+\fIcould\fR
+use
+\fBuniconv\fR
+with cdb and
+\fBafpd\fR
+with dbd later\&.
+.PP
+\fBWarning\fR: There must not be two processes opening the CNID database using different backends at once! If a volume is still opened with dbd (cnid_metad/cnid_dbd) and you start
+\fBuniconv\fR
+with cdb, the result will be a corrupted CNID database, as the two backends use different locking schemes\&. You might run into additional problems, e\&.g\&. if dbd is compiled with transactions, cdb will not update the transaction logs\&.
 .PP
 In general, it is recommended to use the same backend for
-uniconv you are using with
-\fBafpd\fR(8).
-.SH EXAMPLES
-convert 1.x CAP encoded volume to UTF\-8, clients used MacRoman
-codepage, cnidscheme is dbd:
+\fBuniconv\fR
+you are using with
+\fBafpd\fR(8)\&.
+.SH "EXAMPLES"
 .PP
+convert 1\&.x CAP encoded volume to UTF\-8, clients used MacRoman codepage, cnidscheme is dbd:
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 example%\fB uniconv \-c dbd \-f ASCII \-t UTF8 \-m MAC_ROMAN /path/to/share\fR
 .fi
+.if n \{\
+.RE
+.\}
 .PP
 convert iso8859\-1 volume to UTF\-8, cnidscheme is cdb:
-.PP
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 example%\fB uniconv \-c cdb \-f ISO\-8859\-1 \-t UTF8 \-m MAC_ROMAN /path/to/share\fR
 .fi
+.if n \{\
+.RE
+.\}
 .PP
-convert 1.x volume using iso8859\-1 adapted NLS to CAP encoding:
-.PP
+convert 1\&.x volume using iso8859\-1 adapted NLS to CAP encoding:
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 example%\fB uniconv \-f ISO\-8859\-ADAPTED \-t ASCII \-m MAC_ROMAN/path/to/share\fR
 .fi
+.if n \{\
+.RE
+.\}
 .PP
 convert UTF\-8 volume to CAP, for MacCyrillic clients:
-.PP
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 example%\fB uniconv \-f UTF8 \-t ASCII \-m MAC_CYRILLIC /path/to/share\fR
 .fi
+.if n \{\
+.RE
+.\}
 .SH "SEE ALSO"
+.PP
 \fBAppleVolumes.default\fR(5),\fBafpd\fR(8),\fBiconv\fR(1),\fBcnid_metad\fR(8),\fBcnid_dbd\fR(8)
-
index 3e55adedc5ceda4b0811a16cc2261169b340f02c..f6180f1d2c1eba7cdfbfa590a57f2b3312fd5f23 100644 (file)
@@ -1,23 +1,40 @@
-.TH atalk_aton 3 "12 Jan 1994" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: atalk_aton
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 12 Jan 1994
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "ATALK_ATON" "3" "12 Jan 1994" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 atalk_aton \- AppleTalk address parsing
-.SH SYNOPSIS
+.SH "SYNOPSIS"
+.sp
+.ft B
 .nf
-#include <sys/types.h>
-#include <netatalk/at.h>
+#include <sys/types\&.h>
+#include <netatalk/at\&.h>
 .fi
-.sp 1
+.ft
+.HP \w'atalk_aton('u
+.BI "atalk_aton(char\ *\ " "cp" ", struct\ at_addr\ *\ " "ata" ");"
+.SH "DESCRIPTION"
 .PP
-\fIatalk_aton\fR(char * \fIcp\fR, struct at_addr * \fIata\fR);
-.SH DESCRIPTION
-The atalk_aton() routine converts an ASCII
-representation of an AppleTalk address to a format appropriate for system
-calls. Acceptable ASCII representations include both hex and base 10, in
-triples or doubles. For instance, the address `0x1f6b.77' has a
-network part of `8043' and a node part of `119'. This same address
-could be written `8043.119', `31.107.119', or `0x1f.6b.77'. If
-the address is in hex and the first digit is one of `A\-F', a leading
-`0x' is redundant.
+The
+\fBatalk_aton()\fR
+routine converts an ASCII representation of an AppleTalk address to a format appropriate for system calls\&. Acceptable ASCII representations include both hex and base 10, in triples or doubles\&. For instance, the address `0x1f6b\&.77\' has a network part of `8043\' and a node part of `119\'\&. This same address could be written `8043\&.119\', `31\&.107\&.119\', or `0x1f\&.6b\&.77\'\&. If the address is in hex and the first digit is one of `A\-F\', a leading `0x\' is redundant\&.
 .SH "SEE ALSO"
-\fBatalk\fR(4).
-
+.PP
+\fBatalk\fR(4)\&.
index 1ab1929ce636e4bfced8b2741db185ce024aede7..5fa376e896ee150dcebff383ddd47da6e3d24734 100644 (file)
@@ -1,40 +1,88 @@
-.TH nbp_name 3 "12 Jan 1994" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: nbp_name
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 12 Jan 1994
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "NBP_NAME" "3" "12 Jan 1994" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 nbp_name \- NBP name parsing
-.SH SYNOPSIS
-int \fInbp_name\fR(char *\fIname\fR, char **\fIobj\fR, char **\fItype\fR, char **\fIzone\fR);
-.SH DESCRIPTION
-nbp_name() parses user supplied names into
-their component object, type, and zone. \fIobj\fR,
-\fItype\fR, and zone
-should be passed by reference, and should point to the caller's
-default values. nbp_name() will change the pointers
-to the parsed\-out values. \fIname\fR is of the
-form \fIobject\fR\fI:\fR\fI\fR\fItype\fR\fI@\fR\fI\fRzone, where each of \fIobject\fR,
-\fI:\fR\fItype\fR\fI,\fR and \fI@\fRzone replace \fIobj\fR,
-\fItype\fR, and \fIzone,\fR
-respectively. \fItype\fR must be proceeded by `\fI:\fR', and zone
-must be preceded by `\fI@\fR'.
-.SH EXAMPLE
-The argument of \fBafpd\fR(8)'s
-\fB\-n\fR option is parsed with nbp_name().
-The default value of \fIobj\fR is the first
-component of the machine's hostname (as returned by
-\fBgethostbyname\fR(3)).
-The default value of \fItype\fR is
-``AFPServer'', and of zone is
-``*'', the default zone. To cause \fIafpd\fR
-to register itself in some zone other than the default, one would invoke
-it as
+.SH "SYNOPSIS"
+.HP \w'int\ nbp_name('u
+.BI "int nbp_name(char\ *" "name" ", char\ **" "obj" ", char\ **" "type" ", char\ **" "zone" ");"
+.SH "DESCRIPTION"
 .PP
+\fBnbp_name()\fR
+parses user supplied names into their component object, type, and zone\&.
+\fBobj\fR,
+\fBtype\fR, and
+\fIzone\fR
+should be passed by reference, and should point to the caller\'s default values\&.
+\fBnbp_name()\fR
+will change the pointers to the parsed\-out values\&.
+\fBname\fR
+is of the form
+\fIobject\fR\fB:\fR\fItype\fR\fB@\fR\fIzone\fR, where each of
+\fIobject\fR,
+\fB:\fR\fItype\fR\fB,\fR
+and
+\fB@\fR\fIzone\fR
+replace
+\fBobj\fR,
+\fBtype\fR, and
+\fBzone,\fR
+respectively\&.
+\fItype\fR
+must be proceeded by `\fB:\fR\', and
+\fIzone\fR
+must be preceded by `\fB@\fR\'\&.
+.SH "EXAMPLE"
+.PP
+The argument of
+\fBafpd\fR(8)\'s
+\fB\-n\fR
+option is parsed with
+\fBnbp_name()\fR\&. The default value of
+\fBobj\fR
+is the first component of the machine\'s hostname (as returned by
+\fBgethostbyname\fR(3))\&. The default value of
+\fBtype\fR
+is ``AFPServer\'\', and of
+\fIzone\fR
+is ``*\'\', the default zone\&. To cause
+\fBafpd\fR
+to register itself in some zone other than the default, one would invoke it as
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 afpd \-n @some\-other\-zone
 .fi
+.if n \{\
+.RE
+.\}
+.PP
+\fBobj\fR
+and
+\fBtype\fR
+would retain their default values\&.
+.SH "BUGS"
 .PP
-\fIobj\fR and \fItype\fR
-would retain their default values.
-.SH BUGS
-\fIobj\fR, \fItype\fR,
-and zone return pointers into static
-area which may be over\-written on each call.
-
+\fBobj\fR,
+\fBtype\fR, and
+\fIzone\fR
+return pointers into static area which may be over\-written on each call\&.
index da2547eb251bbd350cc681986c66233783ea1dad..1681b32494f8fa1e40ee2eda0a7eba94d48513a1 100644 (file)
@@ -1,27 +1,45 @@
-.TH atalk 4 "17 Dec 1991" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: atalk
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 17 Dec 1991
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "ATALK" "4" "17 Dec 1991" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 atalk \- AppleTalk protocol family
-.SH SYNOPSIS
+.SH "SYNOPSIS"
+.sp
+.ft B
 .nf
-#include <sys/types.h>
-#include <netatalk/at.h>
+#include <sys/types\&.h>
+#include <netatalk/at\&.h>
 .fi
-.sp 1
-.SH DESCRIPTION
-The AppleTalk protocol family is a collection of protocols layered
-above the Datagram Delivery Protocol (DDP), and using AppleTalk address
-format. The AppleTalk family may provide SOCK_STREAM (ADSP), SOCK_DGRAM
-(DDP), SOCK_RDM (ATP), and SOCK_SEQPACKET (ASP). Currently, only DDP is
-implemented in the kernel; ATP and ASP are implemented in user level
-libraries; and ADSP is planned.
-.SH ADDRESSING
-AppleTalk addresses are three byte quantities, stored in network
-byte order. The include file <\fInetatalk/at.h\fR>
-defines the AppleTalk address format.
+.ft
+.SH "DESCRIPTION"
 .PP
-Sockets in the AppleTalk protocol family use the following address
-structure:
+The AppleTalk protocol family is a collection of protocols layered above the Datagram Delivery Protocol (DDP), and using AppleTalk address format\&. The AppleTalk family may provide SOCK_STREAM (ADSP), SOCK_DGRAM (DDP), SOCK_RDM (ATP), and SOCK_SEQPACKET (ASP)\&. Currently, only DDP is implemented in the kernel; ATP and ASP are implemented in user level libraries; and ADSP is planned\&.
+.SH "ADDRESSING"
 .PP
+AppleTalk addresses are three byte quantities, stored in network byte order\&. The include file <\fBnetatalk/at\&.h\fR> defines the AppleTalk address format\&.
+.PP
+Sockets in the AppleTalk protocol family use the following address structure:
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 struct sockaddr_at {
     short sat_family;
@@ -30,20 +48,29 @@ struct sockaddr_at {
     char sat_zero[ 8 ];
 };
 .fi
+.if n \{\
+.RE
+.\}
 .PP
-The port of a socket may be set with \fBbind\fR(2).
-The node for \fIbind\fR must always be \fIATADDR_ANYNODE\fR: ``this node.'' The net may be
-\fIATADDR_ANYNET\fR or \fIATADDR_LATENET\fR.
-\fIATADDR_ANYNET\fR coresponds to the
-machine's ``primary'' address (the first configured).
-\fIATADDR_LATENET\fR causes the address in
-outgoing packets to be determined when a packet is sent, i.e. determined
-late. \fIATADDR_LATENET\fR is equivalent to
-opening one socket for each network interface. The port of a socket and
-either the primary address or \fIATADDR_LATENET\fR
-are returned with \fBgetsockname\fR(2).
+The port of a socket may be set with
+\fBbind\fR(2)\&. The node for
+\fBbind\fR
+must always be
+\fBATADDR_ANYNODE\fR: ``this node\&.\'\' The net may be
+\fBATADDR_ANYNET\fR
+or
+\fBATADDR_LATENET\fR\&.
+\fBATADDR_ANYNET\fR
+coresponds to the machine\'s ``primary\'\' address (the first configured)\&.
+\fBATADDR_LATENET\fR
+causes the address in outgoing packets to be determined when a packet is sent, i\&.e\&. determined late\&.
+\fBATADDR_LATENET\fR
+is equivalent to opening one socket for each network interface\&. The port of a socket and either the primary address or
+\fBATADDR_LATENET\fR
+are returned with
+\fBgetsockname\fR(2)\&.
 .SH "SEE ALSO"
+.PP
 \fBbind\fR(2),
 \fBgetsockname\fR(2),
-\fBatalkd\fR(8).
-
+\fBatalkd\fR(8)\&.
index a533b1675e6335a13761f9312bac2d37452732f1..62488e0210cea5d7772af767468c7b7b8aa58fb3 100644 (file)
-.TH AppleVolumes.default 5 "03 January 2005" 2.0.3 Netatalk 
-.SH NAME
-AppleVolumes.default \- Configuration file used by afpd(8) to determine the shares made available through Appletalk
-.SH DESCRIPTION
-\fB:ETCDIR:/AppleVolumes.default\fR is the
-configuration file used by afpd to determine what
-portions of the file system will be shared via Apple Filing Protocol, as
-well as their behaviour. Any line not prefixed with # is interpreted. The
-configuration lines are composed like:
-.PP
-\fBpath\fR \fI[ volume name ] [ options
-]\fR
-.PP
-The path name must be a fully qualified path name, or a path name
-using either the ~ shell shorthand or any of the substitution variables,
-which are listed below.
-.PP
-The volume name is the name that appears in the Chooser ot the
-"connect to server" dialog on Macintoshes to represent the appropriate
-share. If there are spaces in the name, it should be in quotes (i.e. "File
-Share"). The volume name may not exceed 27 characters in length, and
-cannot contain the \fB':'\fR character.
-.RS 
+'\" t
+.\"     Title: AppleVolumes.default
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 30 January 2009
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "APPLEVOLUMES\&.DEFAU" "5" "30 January 2009" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+AppleVolumes.default \- Configuration file used by \fBafpd\fR(8) to determine the shares made available through Appletalk
+.SH "DESCRIPTION"
+.PP
+:ETCDIR:/AppleVolumes\&.default
+is the configuration file used by
+\fBafpd\fR
+to determine what portions of the file system will be shared via Apple Filing Protocol, as well as their behaviour\&. Any line not prefixed with # is interpreted\&. Newline escaping is supported\&. The configuration lines are composed like:
+.PP
+path
+\fI[ volume name ] [ options ]\fR
+.PP
+The path name must be a fully qualified path name, or a path name using either the ~ shell shorthand or any of the substitution variables, which are listed below\&.
+.PP
+The volume name is the name that appears in the Chooser ot the "connect to server" dialog on Macintoshes to represent the appropriate share\&. If there are spaces in the name, it should be in quotes (i\&.e\&. "File Share")\&. The volume name may not exceed 27 characters in length, and cannot contain the
+\':\'
+character\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBNote\fR
+.ps -1
+.br
 .PP
-Each volume has to be configured on a \fBsingle\fR line.
+Each volume has to be configured on a
+\fBsingle\fR
+line\&. Though newline escaping is supported\&.
+.sp .5v
 .RE
 .PP
 The possible options and their meanings are:
-.TP 
+.PP
 adouble:\fI[v1|v2|osx]\fR
-specify the format of the metadata files, which are used for
-saving Mac resource fork as well. Earlier versions used AppleDouble
-V1, the new default format is V2. Starting with Netatalk 2.0, the
-scheme MacOS X uses currently (10.3.x), is also supported
-.RS 
+.RS 4
+specify the format of the metadata files, which are used for saving Mac resource fork as well\&. Earlier versions used AppleDouble V1, the new default format is V2\&. Starting with Netatalk 2\&.0, the scheme MacOS X uses currently (10\&.3\&.x), is also supported
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBNote\fR
-
-Using \fBadouble:osx\fR is \fBnot\fR recommended for production use. Its
-only aim is to temporarely share eg. FAT32 formatted FireWire
-harddrives written on a Macintosh with afpd. Apple's metadata
-scheme lacks several essential features, so using it on the
-server's side will break both CNIDs and MacOS 9
-compatibility
-.RE
-.TP 
+.ps -1
+.br
+Using
+\fBadouble:osx\fR
+is
+\fBnot\fR
+recommended for production use\&. Its only aim is to temporarely share eg\&. FAT32 formatted FireWire harddrives written on a Macintosh with afpd\&. Apple\'s metadata scheme lacks several essential features, so using it on the server\'s side will break both CNIDs and MacOS 9 compatibility
+.sp .5v
+.RE
+.RE
+.PP
 allow:\fI[users/groups]\fR
-The allow option allows the users and groups that access a
-share to be specified. Users and groups are specified, delimited by
-commas. Groups are designated by a @ prefix. Example:
-allow:user1,user2,@group
-.TP 
+.RS 4
+The allow option allows the users and groups that access a share to be specified\&. Users and groups are specified, delimited by commas\&. Groups are designated by a @ prefix\&. Example: allow:user1,user2,@group
+.RE
+.PP
 deny:\fI[users/groups]\fR
-The deny option specifies users and groups who are not allowed
-access to the share. It follows the same format as the allow
-option.
-.TP 
+.RS 4
+The deny option specifies users and groups who are not allowed access to the share\&. It follows the same format as the allow option\&.
+.RE
+.PP
+allowed_hosts:\fI[IPv4 host address/IPv4 netmask bits[, \&.\&.\&. ]]\fR
+.RS 4
+Only listed hosts and networks are allowed, all others are rejected\&. Example: allowed_hosts:10\&.1\&.0\&.0/16,10\&.2\&.1\&.100
+.RE
+.PP
+denied_hosts:\fI[IPv4 host address/IPv4 netmask bits[, \&.\&.\&.]]\fR
+.RS 4
+Listed hosts and nets are rejected, all others are allowed\&. Example: denied_hosts: 192\&.168\&.100/24,10\&.1\&.1\&.1
+.RE
+.PP
 cnidscheme:\fI[backend]\fR
-set the CNID backend to be used for the volume, default is
-[:DEFAULT_CNID_SCHEME:] available schemes:
-[:COMPILED_BACKENDS:]
-.TP 
+.RS 4
+set the CNID backend to be used for the volume, default is [:DEFAULT_CNID_SCHEME:] available schemes: [:COMPILED_BACKENDS:]
+.RE
+.PP
 dbpath:\fI[path]\fR
-Sets the database information to be stored in path. You have
-to specifiy a writable location, even if the volume is read
-only.
-.TP 
+.RS 4
+Sets the database information to be stored in path\&. You have to specifiy a writable location, even if the volume is read only\&.
+.RE
+.PP
 maccharset:\fI[charset]\fR
-specifies the mac client codepage for this Volume, e.g.
-"MAC_ROMAN", "MAC_CYRILLIC". If not specified the setting from
-\fBafpd.conf\fR is inherited. This setting is only
-required if you need volumes, where the mac codepage differs from
-the one globally set in \fBafpd.conf\fR.
-.TP 
+.RS 4
+specifies the mac client codepage for this Volume, e\&.g\&. "MAC_ROMAN", "MAC_CYRILLIC"\&. If not specified the setting from
+afpd\&.conf
+is inherited\&. This setting is only required if you need volumes, where the mac codepage differs from the one globally set in
+afpd\&.conf\&.
+.RE
+.PP
 options:\fI[option]\fR
-This allows multiple options to be specified in a comma
-delimited format. The available options are:
-.RS 
-.TP 
+.RS 4
+This allows multiple options to be specified in a comma delimited format\&. The available options are:
+.PP
+invisibledots
+.RS 4
+Use with
+\fBusedots\fR: make dot files invisible\&.
+.RE
+.PP
 limitsize
-Limit disk size reporting to 2GB. This can be used for
-older Macintoshes using newer Appleshare clients.
-.TP 
+.RS 4
+Limit disk size reporting to 2GB\&. This can be used for older Macintoshes using newer Appleshare clients\&.
+.RE
+.PP
+preexec_close
+.RS 4
+a non\-zero return code from preexec close the volume being immediately, preventing clients to mount/see the volume in question\&.
+.RE
+.PP
 ro
-Specifies the share as being read only for all users.
-The .AppleDB directory has to be writeable, you can use the
-\fB\-dbpath\fR option to relocate it.
-.TP 
-usedots
-Don't do :hex translation for dot files. note: when this
-option gets set, certain file names become illegal. These are
-\&.Parent and anything that starts with .Apple. Also, dot files
-created on the unix side are marked invisible.
-.TP 
+.RS 4
+Specifies the share as being read only for all users\&. The \&.AppleDB directory has to be writeable, you can use the
+\fB\-dbpath\fR
+option to relocate it\&.
+.RE
+.PP
 root_preexec_close
-a non\-zero return code from root_preexec closes the
-volume immediately, preventing clients to mount/see the volume
-in question.
-.TP 
-preexec_close
-a non\-zero return code from preexec close the volume
-being immediately, preventing clients to mount/see the volume
-in question.
+.RS 4
+a non\-zero return code from root_preexec closes the volume immediately, preventing clients to mount/see the volume in question\&.
 .RE
-.TP 
+.PP
+upriv
+.RS 4
+use AFP3 unix privileges\&. Become familiar with the new "unix privileges" AFP permissions concepts in MacOS X before using this option\&. See also:
+\fBperm|fperm|dperm\fR\&.
+.RE
+.PP
+usedots
+.RS 4
+Don\'t do :hex translation for dot files\&. note: when this option gets set, certain file names become illegal\&. These are \&.Parent and anything that starts with \&.Apple\&. See also
+\fBinvisibledots\fR\&.
+.RE
+.RE
+.PP
 password:\fI[password]\fR
-This option allows you to set a volume password, which can be
-a maximum of 8 characters long (using ASCII strongly recommended at
-the time of this writing).
-.TP 
+.RS 4
+This option allows you to set a volume password, which can be a maximum of 8 characters long (using ASCII strongly recommended at the time of this writing)\&.
+.RE
+.PP
+perm|fperm|dperm:[mode]
+.RS 4
+Add(or) with the client requested permissions:
+\fBperm\fR
+affects files and directories,
+\fBfperm\fR
+is for files only,
+\fBdperm\fR
+is for directories only\&. Use with
+\fBoptions:upriv\fR\&.
+.PP
+\fBExample.\ \&Volume for a collaborative workgroup\fR
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+/path/to/volume "Workgroup" options:upriv dperm:0770 fperm:0660
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
 preexec:\fI[command]\fR
-command to be run when the volume is mounted, ignored for user
-defined volumes
-.TP 
+.RS 4
+command to be run when the volume is mounted, ignored for user defined volumes
+.RE
+.PP
 postexec:\fI[command]\fR
-command to be run when the volume is closed, ignored for user
-defined volumes
-.TP 
+.RS 4
+command to be run when the volume is closed, ignored for user defined volumes
+.RE
+.PP
 root_preexec:\fI[command]\fR
-command to be run as root when the volume is mounted, ignored
-for user defined volumes
-.TP 
+.RS 4
+command to be run as root when the volume is mounted, ignored for user defined volumes
+.RE
+.PP
 root_postexec:\fI[command]\fR
-command to be run as root when the volume is closed, ignored
-for user defined volumes
-.TP 
+.RS 4
+command to be run as root when the volume is closed, ignored for user defined volumes
+.RE
+.PP
 rolist:[\fBusers/groups\fR]
-Allows certain users and groups to have read\-only access to a
-share. This follows the allow option format.
-.TP 
+.RS 4
+Allows certain users and groups to have read\-only access to a share\&. This follows the allow option format\&.
+.RE
+.PP
 rwlist:\fI[users/groups]\fR
-Allows certain users and groups to have read/write access to a
-share. This follows the allow option format.
-.TP 
+.RS 4
+Allows certain users and groups to have read/write access to a share\&. This follows the allow option format\&.
+.RE
+.PP
 veto:\fI[vetoed name]\fR
-hide files and directories,where the path matches one of the
-\&'/' delimited vetoed names. Matches are partial, e.g. path is
-\fB/abc/def/file\fR and veto:/abc/ will hide the
-file.
-.TP 
+.RS 4
+hide files and directories,where the path matches one of the \'/\' delimited vetoed names\&. Matches are partial, e\&.g\&. path is
+/abc/def/file
+and veto:/abc/ will hide the file\&.
+.RE
+.PP
 volcharset:\fI[charset]\fR
-specifies the volume codepage, e.g. "UTF8", "UTF8\-MAC",
-"ISO\-8859\-15". Defaults to "UTF8".
+.RS 4
+specifies the volume codepage, e\&.g\&. "UTF8", "UTF8\-MAC", "ISO\-8859\-15"\&. Defaults to "UTF8"\&.
+.RE
 .SH "VARIABLE SUBSTITUTIONS"
-You can use variables in both volume path and volume name.
-.TP 
-1.
-if you specify an unknown variable, it will not get
-converted.
-.TP 
-2.
-if you specify a known variable, but that variable doesn't have
-a value, it will get ignored.
+.PP
+You can use variables in both volume path and volume name\&.
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 1.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "  1." 4.2
+.\}
+if you specify an unknown variable, it will not get converted\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 2.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "  2." 4.2
+.\}
+if you specify a known variable, but that variable doesn\'t have a value, it will get ignored\&.
+.RE
 .PP
 The variables which can be used for substitutions are:
-.TP 
+.PP
 $b
+.RS 4
 basename
-.TP 
+.RE
+.PP
 $c
-client's ip or appletalk address
-.TP 
+.RS 4
+client\'s ip or appletalk address
+.RE
+.PP
 $d
+.RS 4
 volume pathname on server
-.TP 
+.RE
+.PP
 $f
-full name (contents of the gecos field in the passwd
-file)
-.TP 
+.RS 4
+full name (contents of the gecos field in the passwd file)
+.RE
+.PP
 $g
+.RS 4
 group name
-.TP 
+.RE
+.PP
 $h
+.RS 4
 hostname
-.TP 
+.RE
+.PP
 $i
-client's ip, without port
-.TP 
+.RS 4
+client\'s ip, without port
+.RE
+.PP
 $s
+.RS 4
 server name (this can be the hostname)
-.TP 
+.RE
+.PP
 $u
-user name (if guest, it is the user that guest is running
-as)
-.TP 
+.RS 4
+user name (if guest, it is the user that guest is running as)
+.RE
+.PP
 $v
+.RS 4
 volume name (either ADEID_NAME or basename of path)
-.TP 
+.RE
+.PP
 $z
+.RS 4
 appletalk zone (may not exist)
-.TP 
+.RE
+.PP
 $$
+.RS 4
 prints dollar sign ($)
+.RE
 .PP
-When using variable substitution in the volume name, always keep in
-mind, not to exceed the 27 characters limit
+When using variable substitution in the volume name, always keep in mind, not to exceed the 27 characters limit
 .PP
-\fBUsing variable substitution when defining volumes\fR
+\fBExample.\ \&Using variable substitution when defining volumes\fR
 .PP
+.if n \{\
+.RS 4
+.\}
 .nf
 /home/groups/$g "Groupdir for $g"
 ~ "$f is the best one"
 .fi
-
-We define "groupdirs" for each primary
-group and use a personalized server name for homedir shares.
+.if n \{\
+.RE
+.\}
+.sp
+We define "groupdirs" for each primary group and use a personalized server name for homedir shares\&.
 .SH "CNID BACKENDS"
-The AFP protocol mostly refers to files and directories by ID and
-not by name. Netatalk needs a way to store these ID's in a persistent way,
-to achieve this several different CNID backends are available. The CNID
-Databases are by default located in the \fB.AppleDB\fR
-folder in the volume root.
-.TP 
+.PP
+The AFP protocol mostly refers to files and directories by ID and not by name\&. Netatalk needs a way to store these ID\'s in a persistent way, to achieve this several different CNID backends are available\&. The CNID Databases are by default located in the
+\&.AppleDB
+folder in the volume root\&.
+.PP
 cdb
-"Concurrent database", backend is based on Sleepycat's Berkely
-DB. With this backend several afpd deamons access
-the CNID database directly. Berkeley DB locking is used to
-synchronize access, if more than one afpd process
-is active for a volume. The drawback is, that the crash of a single
-afpd process might corrupt the database.
-.TP 
+.RS 4
+"Concurrent database", backend is based on Sleepycat\'s Berkely DB\&. With this backend several
+\fBafpd\fR
+deamons access the CNID database directly\&. Berkeley DB locking is used to synchronize access, if more than one
+\fBafpd\fR
+process is active for a volume\&. The drawback is, that the crash of a single
+\fBafpd\fR
+process might corrupt the database\&.
+.RE
+.PP
 dbd
+.RS 4
 Access to the CNID database is restricted to the
-cnid_metad daemon process.
-afpd processes communicate with the daemon for
-database reads and updates. If built with Berkeley DB transactions
-the probability for database corruption is practically zero, but
-performance can be slower than with \fBcdb\fR
-.TP 
+\fBcnid_metad\fR
+daemon process\&.
+\fBafpd\fR
+processes communicate with the daemon for database reads and updates\&. If built with Berkeley DB transactions the probability for database corruption is practically zero, but performance can be slower than with
+\fBcdb\fR
+.RE
+.PP
 last
-This backend is an exception, in terms of ID persistency. ID's
-are only valid for the current session. This is basically what
-afpd did in the 1.5 (and 1.6) versions. This
-backend is still available, as it is useful for e.g. sharing
-cdroms.
-
+.RS 4
+This backend is an exception, in terms of ID persistency\&. ID\'s are only valid for the current session\&. This is basically what
+\fBafpd\fR
+did in the 1\&.5 (and 1\&.6) versions\&. This backend is still available, as it is useful for e\&.g\&. sharing cdroms\&.
+.sp
 \fBWarning\fR: It is
-\fINOT\fR recommended to use this backend for volumes
-anymore, as afpd now relies heavily on a
-persistent ID database. Aliases will likely not work and filename
-mangling is not supported.
-.PP
-Even though ./configure \-\-help might show that
-there are other CNID backends available, be warned those are likely broken
-or mainly used for testing. Don't use them unless you know what you're
-doing, they may be removed without further notice from future
-versions.
+\fINOT\fR
+recommended to use this backend for volumes anymore, as
+\fBafpd\fR
+now relies heavily on a persistent ID database\&. Aliases will likely not work and filename mangling is not supported\&.
+.RE
+.PP
+Even though
+\fB\&./configure \-\-help\fR
+might show that there are other CNID backends available, be warned those are likely broken or mainly used for testing\&. Don\'t use them unless you know what you\'re doing, they may be removed without further notice from future versions\&.
 .SH "CHARSET OPTIONS"
-With OS X Apple introduced the AFP3 protocol. One of the most
-important changes was that AFP3 uses unicode names encoded as UTF\-8
-decomposed. Previous AFP/OS versions used codepages, like MacRoman,
-MacCentralEurope, etc.
-.PP
-afpd needs a way to preserve extended macintosh
-characters, or characters illegal in unix filenames, when saving files on
-a unix filesystem. Earlier versions used the the so called CAP encoding.
-An extended character (>0x7F) would be converted to a :xx sequence,
-e.g. the Apple Logo (MacRoman: 0XF0) was saved as \fB:f0\fR.
-Some special characters will be converted as to :xx notation as well.
-\&'\fB/\fR' will be encoded to \fB:2f\fR, if
-\fB\-usedots\fR is not specified, a leading dot
-\&'\fB.\fR' will be encoded as \fB:2e\fR.
-.PP
-This version now uses UTF\-8 as the default encoding for names.
-Special characters, like '\fB/\fR' and a leading
-\&'\fB.\fR' will still be CAP style encoded .
-.PP
-The \fB\-volcharset\fR option will allow you to select
-another volume encoding. E.g. for western users another useful setting
-could be \-volcharset ISO\-8859\-15. apfd will accept any
-\fBiconv\fR(1) provided charset. If a character cannot be converted
-from the mac codepage to the selected volcharset, afpd will save it as a
-CAP encoded character. For AFP3 clients, afpd will
-convert the UTF\-8 character to \fB\-maccharset\fR first. If this
-conversion fails, you'll receive a \-50 error on the mac.
-.PP
-\fINote\fR: Whenever you can, please stick with the
-default UTF\-8 volume format.
+.PP
+With OS X Apple introduced the AFP3 protocol\&. One of the most important changes was that AFP3 uses unicode names encoded as UTF\-8 decomposed\&. Previous AFP/OS versions used codepages, like MacRoman, MacCentralEurope, etc\&.
+.PP
+\fBafpd\fR
+needs a way to preserve extended macintosh characters, or characters illegal in unix filenames, when saving files on a unix filesystem\&. Earlier versions used the the so called CAP encoding\&. An extended character (>0x7F) would be converted to a :xx sequence, e\&.g\&. the Apple Logo (MacRoman: 0XF0) was saved as
+:f0\&. Some special characters will be converted as to :xx notation as well\&. \'/\' will be encoded to
+:2f, if
+\fB\-usedots\fR
+is not specified, a leading dot \'\&.\' will be encoded as
+:2e\&.
+.PP
+This version now uses UTF\-8 as the default encoding for names\&. Special characters, like \'/\' and a leading \'\&.\' will still be CAP style encoded \&.
+.PP
+The
+\fB\-volcharset\fR
+option will allow you to select another volume encoding\&. E\&.g\&. for western users another useful setting could be \-volcharset ISO\-8859\-15\&.
+\fBapfd\fR
+will accept any
+\fBiconv\fR(1)
+provided charset\&. If a character cannot be converted from the mac codepage to the selected volcharset, afpd will save it as a CAP encoded character\&. For AFP3 clients,
+\fBafpd\fR
+will convert the UTF\-8
+character to
+\fB\-maccharset\fR
+first\&. If this conversion fails, you\'ll receive a \-50 error on the mac\&.
+.PP
+\fINote\fR: Whenever you can, please stick with the default UTF\-8 volume format\&.
 .SH "COMPATIBILITY WITH EARLIER VERSIONS"
-To use a volume created with an earlier afpd
-version, you'll have to specify the following options:
 .PP
-\fBuse a 1.x style volume\fR
+To use a volume created with an earlier
+\fBafpd\fR
+version, you\'ll have to specify the following options:
 .PP
+\fBExample.\ \&use a 1.x style volume\fR
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 /path/to/volume "Volname" adouble:v1 volcharset:ASCII
 .fi
+.if n \{\
+.RE
+.\}
 .PP
-In case you used an NLS you could try using a compatible iconv
-charset for \fB\-volcharset\fR.
-.PP
-\fBuse a 1.x style volume, created with maccode.iso8859\-1\fR
+In case you used an NLS you could try using a compatible iconv charset for
+\fB\-volcharset\fR\&.
 .PP
+\fBExample.\ \&use a 1.x style volume, created with maccode.iso8859-1\fR
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 /path/to/volume "Volname" adouble:v1 volcharset:ISO\-8859\-1
 .fi
+.if n \{\
+.RE
+.\}
 .PP
-You should consider converting old style volumes to the new
-UTF\-8/AD2 format. The safest way to do this, is to create a new volume
-with the default options and copy the files between this volumes with a
-mac.
+You should consider converting old style volumes to the new UTF\-8/AD2 format\&. The safest way to do this, is to create a new volume with the default options and copy the files between this volumes with a mac\&.
 .PP
-\fINote\fR: Using above example options will allow
-you to downgrade to 1.x netatalk again.
+\fINote\fR: Using above example options will allow you to downgrade to 1\&.x netatalk again\&.
 .PP
-\fINote\fR: Some 1.x NLS files used non standard
-mappings, e.g. \fBmaccode.iso8859\-1.adapted\fR. This is not
-supported anymore. You'll have to copy the contents of those volumes files
-to a Mac and then back to the netatalk server, preferably to an UTF\-8
-volume.
+\fINote\fR: Some 1\&.x NLS files used non standard mappings, e\&.g\&.
+maccode\&.iso8859\-1\&.adapted\&. This is not supported anymore\&. You\'ll have to copy the contents of those volumes files to a Mac and then back to the netatalk server, preferably to an UTF\-8 volume\&.
 .SH "ADVANCED OPTIONS"
-The following options should only be used after serious
-consideration. Be sure you fully understood the, sometimes complex,
-consequences, before using them.
-.TP 
+.PP
+The following options should only be used after serious consideration\&. Be sure you fully understood the, sometimes complex, consequences, before using them\&.
+.PP
 casefold:\fB[option]\fR
-The casefold option handles, if the case of filenames should
-be changed. The available options are:
-
-\fBtolower\fR \- Lowercases names in both
-directions.
-
-\fBtoupper\fR \- Uppercases names in both
-directions.
-
-\fBxlatelower\fR \- Client sees lowercase, server
-sees uppercase.
-
-\fBxlateupper\fR \- Client sees uppercase, server
-sees lowercase.
-.TP 
+.RS 4
+The casefold option handles, if the case of filenames should be changed\&. The available options are:
+.sp
+\fBtolower\fR
+\- Lowercases names in both directions\&.
+.sp
+\fBtoupper\fR
+\- Uppercases names in both directions\&.
+.sp
+\fBxlatelower\fR
+\- Client sees lowercase, server sees uppercase\&.
+.sp
+\fBxlateupper\fR
+\- Client sees uppercase, server sees lowercase\&.
+.RE
+.PP
 options:[\fBoption\fR]
-This allows multiple options to be specified in a comma
-delimited format. The available options are:
-.RS 
-.TP 
+.RS 4
+This allows multiple options to be specified in a comma delimited format\&. The available options are:
+.PP
 cachecnid
-If set afpd uses the ID information
-stored in AppleDouble V2 header files to reduce database 
-load. Don't set this option if the volume is modified by non
-AFP clients (NFS/SMB/local). Defaults to off.
-.TP 
+.RS 4
+If set
+\fBafpd\fR
+uses the ID information stored in AppleDouble V2 header files to reduce database load\&. Don\'t set this option if the volume is modified by non AFP clients (NFS/SMB/local)\&. Defaults to off\&.
+.RE
+.PP
 crlf
-Enables crlf translation for TEXT files, automatically
-converting macintosh line breaks into Unix ones. Use of this
-option might be dangerous since some older programs store
-binary data files as type "TEXT" when saving and switch the
-filetype in a second step. Afpd will
-potentially destroy such files when "erroneously" changing
-bytes in order to do line break translation.
-.TP 
+.RS 4
+Enables crlf translation for TEXT files, automatically converting macintosh line breaks into Unix ones\&. Use of this option might be dangerous since some older programs store binary data files as type "TEXT" when saving and switch the filetype in a second step\&.
+\fBAfpd\fR
+will potentially destroy such files when "erroneously" changing bytes in order to do line break translation\&.
+.RE
+.PP
 dropbox
-Allows a volume to be declared as being a "dropbox."
-Note that netatalk must be compiled with dropkludge support
-for this to function. \fIWarning\fR: This
-option is deprecated and might not work as expected.
-.TP 
+.RS 4
+Allows a volume to be declared as being a "dropbox\&." Note that netatalk must be compiled with dropkludge support for this to function\&.
+\fIWarning\fR: This option is deprecated and might not work as expected\&.
+.RE
+.PP
 mswindows
-Forces filename restrictions imposed by MS WinXX.
-\fIWarning\fR: This is \fINOT\fR
-recommened for volumes mainly used by Macs. Please make sure
-you fully understand this option before using it.
-.RS 
+.RS 4
+Forces filename restrictions imposed by MS WinXX\&.
+\fIWarning\fR: This is
+\fINOT\fR
+recommened for volumes mainly used by Macs\&. Please make sure you fully understand this option before using it\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBWarning\fR
-
-This option breaks direct saving to netatalk volumes from
-some applications, i.e. OfficeX.
+.ps -1
+.br
+This option breaks direct saving to netatalk volumes from some applications, i\&.e\&. OfficeX\&.
+.sp .5v
 .RE
-.TP 
+.RE
+.PP
 noadouble
-Forces afpd to not create
-\&.AppleDouble directories unless macintosh metadata needs to be
-written. This option is only useful if you want to share files
-mostly used NOT by macs, causing afpd to
-not automatically create .AppleDouble subdirs containing AD
-header files in every directory it enters (which will it do by
-default).
-
-In case, you save or change files from mac clients, AD
-metadata files have to be written even in case you set this
-option. So you can't avoid the creation of .AppleDouble
-directories and its contents when you give macs write access
-to a share and they make use of it.
-
-Try to avoid \fBnoadouble\fR whenever
-possible.
-.TP 
+.RS 4
+Forces
+\fBafpd\fR
+to not create \&.AppleDouble directories unless macintosh metadata needs to be written\&. This option is only useful if you want to share files mostly used NOT by macs, causing
+\fBafpd\fR
+to not automatically create \&.AppleDouble subdirs containing AD header files in every directory it enters (which will it do by default)\&.
+.sp
+In case, you save or change files from mac clients, AD metadata files have to be written even in case you set this option\&. So you can\'t avoid the creation of \&.AppleDouble directories and its contents when you give macs write access to a share and they make use of it\&.
+.sp
+Try to avoid
+\fBnoadouble\fR
+whenever possible\&.
+.RE
+.PP
 nodev
-always use 0 for device number, helps when the device
-number is not constant across a reboot, cluster, ...
-.TP 
+.RS 4
+always use 0 for device number, helps when the device number is not constant across a reboot, cluster, \&.\&.\&.
+.RE
+.PP
 nofileid
-don't advertise createfileid, resolveid, deleteid
-calls.
-.TP 
+.RS 4
+don\'t advertise createfileid, resolveid, deleteid calls\&.
+.RE
+.PP
 nohex
-Disables :hex translations for anything except dot
-files. This option makes the \fB'/\fR' character
-illegal.
-.TP 
-prodos
-Provides compatibility with Apple II clients.
-.TP 
+.RS 4
+Disables :hex translations for anything except dot files\&. This option makes the
+\'/\' character illegal\&.
+.RE
+.PP
 nostat
-don't stat volume path when enumerating volumes list,
-useful for automounting or volumes created by a preexec
-script.
-.TP 
-upriv
-use AFP3 unix privileges. Become familiar with the new
-"unix privileges" AFP permissions concepts in MacOS X before
-using this option.
+.RS 4
+don\'t stat volume path when enumerating volumes list, useful for automounting or volumes created by a preexec script\&.
+.RE
+.PP
+prodos
+.RS 4
+Provides compatibility with Apple II clients\&.
+.RE
 .RE
 .SH "SEE ALSO"
-\fBafpd.conf\fR(5), \fBafpd\fR(8)
-
+.PP
+\fBafpd.conf\fR(5),
+\fBafpd\fR(8)
index bf6bc8611ba603d6088fdd0fe3a3ee594c84f99c..a749d86ae9813cca2f1958dcf2363f74cf407bc3 100644 (file)
-.TH afpd.conf 5 "24 September 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: afpd.conf
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 1 Feb 2009
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "AFPD\&.CONF" "5" "1 Feb 2009" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 afpd.conf \- Configuration file used by afpd(8) to determine the setup of its file sharing services
-.SH DESCRIPTION
-\fB:ETCDIR:/afpd.conf\fR is the configuration file
-used by afpd to determine the behavior and
-configuration of the different virtual file servers that it
-provides.
-.PP
-Any line not prefixed with # is interpreted. The configuration lines
-are composed like: server name [ options ] If a \fB\-\fR is used
-instead of a server name, the default server is specified. Server names
-must be quoted if they contain spaces. They must not contain ":" or "@".
-The path name must be a fully qualified path name, or a path name using
-either the ~ shell shorthand or any of the substitution variables, which
-are listed below.
-.PP
-.RS 
+.SH "DESCRIPTION"
+.PP
+:ETCDIR:/afpd\&.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
+Any line not prefixed with # is interpreted\&. The configuration lines are composed like: server name [ options ] If a
+\fB\-\fR
+is used instead of a server name, the default server is specified\&. Server names must be quoted if they contain spaces\&. They must not contain ":" or "@"\&. The path name must be a fully qualified path name, or a path name using either the ~ shell shorthand or any of the substitution variables, which are listed below\&.
+.PP
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBNote\fR
+.ps -1
+.br
 .PP
-Each server has to be configured on a \fBsingle\fR line.
+Each server has to be configured on a
+\fBsingle\fR
+line\&. Though newline escaping is supported\&.
+.sp .5v
 .RE
-
 The possible options and their meanings are:
 .SH "APPLEVOLUMES FILES"
-.TP 
+.PP
 \-defaultvol \fI[path]\fR
-Specifies path to AppleVolumes.default file (default is
-\fB:ETCDIR:/AppleVolumes.default\fR).
-.TP 
+.RS 4
+Specifies path to AppleVolumes\&.default file (default is
+:ETCDIR:/AppleVolumes\&.default)\&.
+.RE
+.PP
 \-systemvol \fI[path]\fR
-Specifies path to AppleVolumes.system file (default is
-\fB:ETCDIR:/AppleVolumes.system\fR).
-.TP 
+.RS 4
+Specifies path to AppleVolumes\&.system file (default is
+:ETCDIR:/AppleVolumes\&.system)\&.
+.RE
+.PP
 \-[no]uservol
-Enables or disables reading of the users' individual volumes
-file entirely.
-.TP 
+.RS 4
+Enables or disables reading of the users\' individual volumes file entirely\&.
+.RE
+.PP
 \-[no]uservolfirst
-Enables or disables reading of the users' individual volumes
-file before processing the global
-\fBAppleVolumes.default\fR file.
+.RS 4
+Enables or disables reading of the users\' individual volumes file before processing the global
+AppleVolumes\&.default
+file\&.
+.RE
 .SH "AUTHENTICATION METHODS"
-.TP 
+.PP
 \-uamlist \fI[uams list]\fR
-Comma separated list of UAMs. (The default is
-uams_clrtxt.so,uams_dhx.so).
-
+.RS 4
+Comma separated list of UAMs\&. (The default is uams_clrtxt\&.so,uams_dhx\&.so)\&.
+.sp
 The most commonly used UAMs are:
-.RS 
-.TP 
-uams_guest.so
+.PP
+uams_guest\&.so
+.RS 4
 allows guest logins
-.TP 
-uams_clrtxt.so
-(uams_pam.so or uams_passwd.so) Allow logins with
-passwords transmitted in the clear.
-.TP 
-uams_randum.so
-allows Random Number and Two\-Way Random Number Exchange
-for authentication (requires a separate file containing the
-passwords, either :ETCDIR:/afppasswd file or the one specified
-via \fB\-passwdfile\fR. See \fBafppasswd\fR(1) for details
-.TP 
-uams_dhx.so
-(uams_dhx_pam.so or uams_dhx_passwd.so) Allow
-Diffie\-Hellman eXchange (DHX) for authentication.
-.TP 
-uam_gss.so
+.RE
+.PP
+uams_clrtxt\&.so
+.RS 4
+(uams_pam\&.so or uams_passwd\&.so) Allow logins with passwords transmitted in the clear\&.
+.RE
+.PP
+uams_randum\&.so
+.RS 4
+allows Random Number and Two\-Way Random Number Exchange for authentication (requires a separate file containing the passwords, either :ETCDIR:/afppasswd file or the one specified via
+\fB\-passwdfile\fR\&. See
+\fBafppasswd\fR(1)
+for details
+.RE
+.PP
+uams_dhx\&.so
+.RS 4
+(uams_dhx_pam\&.so or uams_dhx_passwd\&.so) Allow Diffie\-Hellman eXchange (DHX) for authentication\&.
+.RE
+.PP
+uam_gss\&.so
+.RS 4
 Allow Kerberos V for authentication (optional)
 .RE
-.TP 
+.RE
+.PP
 \-uampath \fI[path]\fR
-Sets the default path for UAMs for this server (default is
-:ETCDIR:/uams).
-.TP 
+.RS 4
+Sets the default path for UAMs for this server (default is :ETCDIR:/uams)\&.
+.RE
+.PP
 \-k5keytab \fI[path]\fR, \-k5service \fI[service]\fR, \-k5realm \fI[realm]\fR
-These are required if the server supports the Kerberos 5
-authentication UAM.
+.RS 4
+These are required if the server supports the Kerberos 5 authentication UAM\&.
+.RE
 .SH "CODEPAGE OPTIONS"
-With OS X Apple introduced the AFP3 protocol. One of the big changes
-was, that AFP3 uses Unicode names encoded as UTF\-8 decomposed. Previous
-AFP/OS versions used codepages like MacRoman, MacCentralEurope,
-etc.
+.PP
+With OS X Apple introduced the AFP3 protocol\&. One of the big changes was, that AFP3 uses Unicode names encoded as UTF\-8 decomposed\&. Previous AFP/OS versions used codepages like MacRoman, MacCentralEurope, etc\&.
 .PP
 To be able to serve AFP3 and older clients at the same time,
-afpd needs to be able to convert between UTF\-8 and Mac
-codepages. Even OS X clients partly still rely on codepages. As there's no
-way, afpd can detect the codepage a pre AFP3 client
-uses, you have to specify it using the \fB\-maccodepage\fR
-option. The default is MacRoman, which should be fine for most western
-users.
-.PP
-As afpd needs to interact with unix operating
-system as well, it need's to be able to convert from UTF\-8/MacCodepage to
-the unix codepage. By default afpd uses the systems
-LOCALE, or ASCII if your system doesn't support locales. You can set the
-unix codepage using the \fB\-unixcodepage\fR option. If you're
-using extended characters in the configuration files for
-afpd, make sure your terminal matches the
-\fB\-unixcodepage\fR.
-.TP 
-\-unixcodepage [CODEPAGE]
-Specifies the servers unix codepage, e.g. "ISO\-8859\-15" or
-"UTF8". This is used to convert strings to/from the systems locale,
-e.g. for authenthication, server messages and volume names. Defaults
-to LOCALE if your system supports it, otherwise ASCII will be
-used.
-.TP 
-\-maccodepage [CODEPAGE]
-Specifies the mac clients codepage, e.g. "MAC_ROMAN". This is
-used to convert strings and filenames to the clients codepage for
-OS9 and Classic, i.e. for authentication and AFP messages (SIGUSR2
-messaging). This will also be the default for the volumes
-maccharset. Defaults to MAC_ROMAN.
+\fBafpd\fR
+needs to be able to convert between UTF\-8 and Mac codepages\&. Even OS X clients partly still rely on codepages\&. As there\'s no way,
+\fBafpd\fR
+can detect the codepage a pre AFP3 client uses, you have to specify it using the
+\fB\-maccodepage\fR
+option\&. The default is MacRoman, which should be fine for most western users\&.
+.PP
+As
+\fBafpd\fR
+needs to interact with unix operating system as well, it need\'s to be able to convert from UTF\-8/MacCodepage to the unix codepage\&. By default
+\fBafpd\fR
+uses the systems LOCALE, or ASCII if your system doesn\'t support locales\&. You can set the unix codepage using the
+\fB\-unixcodepage\fR
+option\&. If you\'re using extended characters in the configuration files for
+\fBafpd\fR, make sure your terminal matches the
+\fB\-unixcodepage\fR\&.
+.PP
+\-unixcodepage [\fICODEPAGE\fR]
+.RS 4
+Specifies the servers unix codepage, e\&.g\&. "ISO\-8859\-15" or "UTF8"\&. This is used to convert strings to/from the systems locale, e\&.g\&. for authenthication, server messages and volume names\&. Defaults to LOCALE if your system supports it, otherwise ASCII will be used\&.
+.RE
+.PP
+\-maccodepage [\fICODEPAGE\fR]
+.RS 4
+Specifies the mac clients codepage, e\&.g\&. "MAC_ROMAN"\&. This is used to convert strings and filenames to the clients codepage for OS9 and Classic, i\&.e\&. for authentication and AFP messages (SIGUSR2 messaging)\&. This will also be the default for the volumes maccharset\&. Defaults to MAC_ROMAN\&.
+.RE
 .SH "PASSWORD OPTIONS"
-.TP 
-\-loginmaxfail [number]
-Sets the maximum number of failed logins, if supported by the
-UAM (currently none)
-.TP 
-\-passwdfile [path]
-Sets the path to the Randnum UAM passwd file for this server
-(default is :ETCDIR:/afppasswd).
-.TP 
-\-passwdminlen [number]
-Sets the minimum password length, if supported by the
-UAM
-.TP 
+.PP
+\-loginmaxfail [\fInumber\fR]
+.RS 4
+Sets the maximum number of failed logins, if supported by the UAM (currently none)
+.RE
+.PP
+\-passwdfile [\fIpath\fR]
+.RS 4
+Sets the path to the Randnum UAM passwd file for this server (default is :ETCDIR:/afppasswd)\&.
+.RE
+.PP
+\-passwdminlen [\fInumber\fR]
+.RS 4
+Sets the minimum password length, if supported by the UAM
+.RE
+.PP
 \-[no]savepassword
-Enables or disables the ability of clients to save passwords
-locally
-.TP 
+.RS 4
+Enables or disables the ability of clients to save passwords locally
+.RE
+.PP
 \-[no]setpassword
-Enables or disables the ability of clients to change their
-passwords via chooser or the "connect to server" dialog
+.RS 4
+Enables or disables the ability of clients to change their passwords via chooser or the "connect to server" dialog
+.RE
 .SH "TRANSPORT PROTOCOLS"
-.TP 
+.PP
 \-[no]ddp
-Enables or disables AFP\-over\-Appletalk. If
-\fB\-proxy\fR is specified, you must instead use
-\fB\-uamlist ""\fR to prevent DDP connections from
-working.
-.TP 
+.RS 4
+Enables or disables AFP\-over\-Appletalk\&. If
+\fB\-proxy\fR
+is specified, you must instead use
+\fB\-uamlist ""\fR
+to prevent DDP connections from working\&.
+.RE
+.PP
 \-[no]tcp
+.RS 4
 Enables or disables AFP\-over\-TCP
-.TP 
+.RE
+.PP
 \-transall
+.RS 4
 Make both available (default)
+.RE
 .SH "TRANSPORT OPTIONS"
-.TP 
+.PP
 \-advertise_ssh
-Allows Mac OS X clients (10.3.3 or above) to automagically
-establish a tunneled AFP connection through SSH. If this option is
-set, the server's answers to client's FPGetSrvrInfo requests contain
-an additional entry. It depends on both client's settings and a
-correctly configured and running \fBsshd\fR(8) on the server to let things work.
-.RS 
+.RS 4
+Allows Mac OS X clients (10\&.3\&.3 or above) to automagically establish a tunneled AFP connection through SSH\&. If this option is set, the server\'s answers to client\'s FPGetSrvrInfo requests contain an additional entry\&. It depends on both client\'s settings and a correctly configured and running
+\fBsshd\fR(8)
+on the server to let things work\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBNote\fR
-
-Setting this option is not recommended since globally
-encrypting AFP connections via SSH will increase the server's load
-significantly. On the other hand, Apple's client side
-implementation of this feature in MacOS X versions prior to 10.3.4
-contained a security flaw.
+.ps -1
+.br
+Setting this option is not recommended since globally encrypting AFP connections via SSH will increase the server\'s load significantly\&. On the other hand, Apple\'s client side implementation of this feature in MacOS X versions prior to 10\&.3\&.4 contained a security flaw\&.
+.sp .5v
+.RE
 .RE
-.TP 
+.PP
 \-ddpaddr \fI[ddp address]\fR
-Specifies the DDP address of the server. The default is to
-auto\-assign an address (0.0). This is only useful if you are running
-AppleTalk on more than one interface.
-.TP 
+.RS 4
+Specifies the DDP address of the server\&. The default is to auto\-assign an address (0\&.0)\&. This is only useful if you are running AppleTalk on more than one interface\&.
+.RE
+.PP
 \-fqdn \fI[name:port]\fR
-Specifies a fully\-qualified domain name, with an optional
-port. This is discarded if the server cannot resolve it. This option
-is not honored by AppleShare clients <= 3.8.3. This option is
-disabled by default. Use with caution as this will involve a second
-name resolution step on the client side. Also note that afpd will
-advertise this name:port combination but not automatically listen to
-it.
-.TP 
+.RS 4
+Specifies a fully\-qualified domain name, with an optional port\&. This is discarded if the server cannot resolve it\&. This option is not honored by AppleShare clients <= 3\&.8\&.3\&. This option is disabled by default\&. Use with caution as this will involve a second name resolution step on the client side\&. Also note that afpd will advertise this name:port combination but not automatically listen to it\&.
+.RE
+.PP
 \-ipaddr \fI[ip address]\fR
+.RS 4
 Specifies the IP address that the server should advertise
-\fBand\fR listens to (the default is the
-first IP address of the system). This option also allows to use one
-machine to advertise the AFP\-over\-TCP/IP settings of another machine
-via NBP when used together with the \fB\-proxy\fR
-option.
-.TP 
+\fBand\fR
+listens to (the default is the first IP address of the system)\&. This option also allows to use one machine to advertise the AFP\-over\-TCP/IP settings of another machine via NBP
+when used together with the
+\fB\-proxy\fR
+option\&.
+.RE
+.PP
 \-port \fI[port number]\fR
-Allows a different TCP port to be used for AFP\-over\-TCP. The
-default is 548.
-.TP 
+.RS 4
+Allows a different TCP port to be used for AFP\-over\-TCP\&. The default is 548\&.
+.RE
+.PP
 \-proxy
-Runs an AppleTalk proxy server for the specified AFP\-over\-TCP
-server. If the address and port aren't given, then the first IP
-address of the system and port 548 will be used. If you don't want
-the proxy server to act as a DDP server as well, set \fB\-uamlist
-""\fR.
-.TP 
+.RS 4
+Runs an AppleTalk proxy server for the specified AFP\-over\-TCP server\&. If the address and port aren\'t given, then the first IP address of the system and port 548 will be used\&. If you don\'t want the proxy server to act as a DDP
+server as well, set
+\fB\-uamlist ""\fR\&.
+.RE
+.PP
 \-server_quantum \fI[number]\fR
-This specifies the DSI server quantum. The minimum value is
-303840 (0x4A2E0). The maximum value is 0xFFFFFFFFF. If you specify a
-value that is out of range, the default value will be set (which is
-the minimum). Do not change this value unless you're absolutely
-sure, what you're doing
-.TP 
+.RS 4
+This specifies the DSI server quantum\&. The minimum value is 303840 (0x4A2E0)\&. The maximum value is 0xFFFFFFFFF\&. If you specify a value that is out of range, the default value will be set (which is the minimum)\&. Do not change this value unless you\'re absolutely sure, what you\'re doing
+.RE
+.PP
 \-noslp
-Do not register this server using the Service Location
-Protocol (if SLP support was compiled in). This is useful if you are
-running multiple servers and want one to be hidden, perhaps because
-it is advertised elsewhere, ie. by a SLP Directory Agent.
+.RS 4
+Do not register this server using the Service Location Protocol (if SLP
+support was compiled in)\&. This is useful if you are running multiple servers and want one to be hidden, perhaps because it is advertised elsewhere, ie\&. by a SLP Directory Agent\&.
+.RE
 .SH "MISCELLANEOUS OPTIONS"
-.TP 
+.PP
 \-admingroup \fI[group]\fR
-Allows users of a certain group to be seen as the superuser
-when they log in. This option is disabled by default.
-.TP 
+.RS 4
+Allows users of a certain group to be seen as the superuser when they log in\&. This option is disabled by default\&.
+.RE
+.PP
 \-authprintdir \fI[path]\fR
-Specifies the path to be used (per server) to store the files
-required to do CAP\-style print authentication which papd will
-examine to determine if a print job should be allowed. These files
-are created at login and if they are to be properly removed, this
-directory probably needs to be umode 1777.
-.RS 
+.RS 4
+Specifies the path to be used (per server) to store the files required to do CAP\-style print authentication which papd will examine to determine if a print job should be allowed\&. These files are created at login and if they are to be properly removed, this directory probably needs to be umode 1777\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBNote\fR
-
-\fB\-authprintdir\fR will only work for clients
-connecting via DDP. Almost all modern Clients will use TCP.
+.ps -1
+.br
+\fB\-authprintdir\fR
+will only work for clients connecting via DDP\&. Almost all modern Clients will use TCP\&.
+.sp .5v
+.RE
 .RE
-.TP 
+.PP
 \-client_polling
-With this switch enabled, afpd won't advertise that it is
-capable of server notifications, so that connected clients poll the
-server every 10 seconds to detect changes in opened server windows.
-\fINote\fR: Depending on the number of simultaneously
-connected clients and the network's speed, this can lead to a
-significant higher load on your network!
-.RS 
+.RS 4
+With this switch enabled, afpd won\'t advertise that it is capable of server notifications, so that connected clients poll the server every 10 seconds to detect changes in opened server windows\&.
+\fINote\fR: Depending on the number of simultaneously connected clients and the network\'s speed, this can lead to a significant higher load on your network!
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBNote\fR
-
-Do not use this option any longer as Netatalk 2.0 correctly
-supports server notifications, allowing connected clients to
-update folder listings in case another client changed the
-contents.
+.ps -1
+.br
+Do not use this option any longer as Netatalk 2\&.0 correctly supports server notifications, allowing connected clients to update folder listings in case another client changed the contents\&.
+.sp .5v
+.RE
 .RE
-.TP 
+.PP
 \-cnidserver \fI[ipaddress:port]\fR
-Specifies the IP address and port of a cnid_metad server,
-required for CNID dbd backend. Defaults to localhost:4700.
-.TP 
+.RS 4
+Specifies the IP address and port of a cnid_metad server, required for CNID dbd backend\&. Defaults to localhost:4700\&.
+.RE
+.PP
 \-guestname \fI[name]\fR
-Specifies the user that guests should use (default is
-"nobody"). The name should be quoted.
-.TP 
+.RS 4
+Specifies the user that guests should use (default is "nobody")\&. The name should be quoted\&.
+.RE
+.PP
 \-icon
+.RS 4
 Use the platform\-specific icon
-.TP 
+.RE
+.PP
 \-loginmesg \fI[message]\fR
-Sets a message to be displayed when clients logon to the
-server. The message should be in \fBunixcodepage\fR and
-should be quoted. Extended characters are allowed.
-.TP 
+.RS 4
+Sets a message to be displayed when clients logon to the server\&. The message should be in
+\fBunixcodepage\fR
+and should be quoted\&. Extended characters are allowed\&.
+.RE
+.PP
 \-nodebug
-Disables debugging.
-.TP 
+.RS 4
+Disables debugging\&.
+.RE
+.PP
 \-sleep \fI[number]\fR
-AFP 3.x waits number hours before
-disconnecting clients in sleep mode. Default is 10 hours.
-.TP 
+.RS 4
+AFP 3\&.x waits
+\fInumber\fR
+hours before disconnecting clients in sleep mode\&. Default is 10 hours\&.
+.RE
+.PP
 \-signature { user:<text> | host }
-Specify a server signature. This option is useful while
-running multiple independent instances of afpd on one machine (eg.
-in clustered environments, to provide fault isolation etc.). "host"
-signature type allows afpd generating signature automatically (based
-on machine primary IP address). "user" signature type allows
-administrator to set up a signature string manually. The maximum
-length is 16 characters
-
-\fBThree server definitions using 2 different server
-signatures\fR
-
+.RS 4
+Specify a server signature\&. This option is useful while running multiple independent instances of afpd on one machine (eg\&. in clustered environments, to provide fault isolation etc\&.)\&. "host" signature type allows afpd generating signature automatically (based on machine primary IP address)\&. "user" signature type allows administrator to set up a signature string manually\&. The maximum length is 16 characters
+.PP
+\fBExample.\ \&Three server definitions using 2 different server signatures\fR
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 first \-signature user:USERS 
 second \-signature user:USERS 
 third \-signature user:ADMINS
 .fi
+.if n \{\
+.RE
+.\}
 
-First two servers will appear as one logical AFP service to
-the clients \- if user logs in to first one and then connects to
-second one, session will be automatically redirected to the first
-one. But if client connects to first and then to third, will be
-asked for password twice and will see resources of both servers.
-Traditional method of signature generation causes two independent
-afpd instances to have the same signature and thus cause clients to
-be redirected automatically to server (s)he logged in first.
+
+First two servers will appear as one logical AFP service to the clients \- if user logs in to first one and then connects to second one, session will be automatically redirected to the first one\&. But if client connects to first and then to third, will be asked for password twice and will see resources of both servers\&. Traditional method of signature generation causes two independent afpd instances to have the same signature and thus cause clients to be redirected automatically to server (s)he logged in first\&.
+.RE
 .SH "LOGGING OPTIONS"
-.RS 
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBNote\fR
+.ps -1
+.br
 .PP
-Extended logging capabilities are only available if Netatalk was
-built using \-\-with\-logfile. As of Netatalk 2.0, the
-default is \-\-without\-logfile since the logger code is
-partially broken and needs a complete rewrite (the
-\fB\-setuplog\fR option might not work as expected). If
-Netatalk was built without logger support then the daemons log to
-syslog.
-.RE
-.TP 
-\-[un]setuplog "<logtype> <loglevel> [<filename>]"
-Specify that the given loglevel should be applied to log
-messages of the given logtype and that these messages should be
-logged to the given file. If the filename is ommited the loglevel
-applies to messages passed to syslog. Each logtype may have a
-loglevel applied to syslog and a loglevel applied to a single file.
-Latter \fB\-setuplog\fR settings will override earlier
-ones of the same logtype (file or syslog).
-
+Extended logging capabilities are only available if Netatalk was built using
+\fB\-\-with\-logfile\fR\&. As of Netatalk 2\&.0, the default is
+\fB\-\-without\-logfile\fR
+since the logger code is partially broken and needs a complete rewrite (the
+\fB\-setuplog\fR
+option might not work as expected)\&. If Netatalk was built without logger support then the daemons log to syslog\&.
+.sp .5v
+.RE
+.PP
+\-[un]setuplog "\fI<logtype> <loglevel> [<filename>]\fR"
+.RS 4
+Specify that the given loglevel should be applied to log messages of the given logtype and that these messages should be logged to the given file\&. If the filename is ommited the loglevel applies to messages passed to syslog\&. Each logtype may have a loglevel applied to syslog and a loglevel applied to a single file\&. Latter
+\fB\-setuplog\fR
+settings will override earlier ones of the same logtype (file or syslog)\&.
+.sp
 logtypes: Default, Core, Logger, CNID, AFP
-
-Daemon loglevels: LOG_SEVERE, LOG_ERROR, LOG_WARN, LOG_NOTE,
-LOG_INFO, LOG_DEBUG, LOG_DEBUG6, LOG_DEBUG7, LOG_DEBUG8, LOG_DEBUG9,
-LOG_MAXDEBUG
-
-\fBSome ways to change afpd's logging behaviour via
-\-[un]setuplog\fR
-
-Example: 
-
+.sp
+Daemon 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.\ \&Some ways to change afpd's logging behaviour via -[un]setuplog\fR
+Example:
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
-\-setuplog "logger log_maxdebug /var/log/netatalk\-logger.log" 
-\-setuplog "afpdaemon log_maxdebug /var/log/netatalk\-afp.log" 
+\-setuplog "logger log_maxdebug /var/log/netatalk\-logger\&.log" 
+\-setuplog "afpdaemon log_maxdebug /var/log/netatalk\-afp\&.log" 
 \-unsetuplog "default level file" 
 \-setuplog "default log_maxdebug"
 .fi
+.if n \{\
+.RE
+.\}
+
+.RE
 .SH "DEBUG OPTIONS"
-These options are useful for debugging only.
-.TP 
+.PP
+These options are useful for debugging only\&.
+.PP
 \-tickleval \fI[number]\fR
-Sets the tickle timeout interval (in seconds). Defaults to
-30.
-.TP 
+.RS 4
+Sets the tickle timeout interval (in seconds)\&. Defaults to 30\&.
+.RE
+.PP
 \-timeout \fI[number]\fR
-Specify the number of tickles to send before timing out a
-connection. The default is 4, therefore a connection will timeout
-after 2 minutes.
-.SH EXAMPLES
-\fBafpd.conf default configuration\fR
+.RS 4
+Specify the number of tickles to send before timing out a connection\&. The default is 4, therefore a connection will timeout after 2 minutes\&.
+.RE
+.SH "EXAMPLES"
 .PP
+\fBExample.\ \&afpd.conf default configuration\fR
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
-\- \-transall \-uamlist uams_clrtxt.so,uams_dhx.so
+\- \-transall \-uamlist uams_clrtxt\&.so,uams_dhx\&.so
 .fi
+.if n \{\
+.RE
+.\}
 .PP
-\fBafpd.conf MacCyrillic setup / UTF8 unix locale\fR
-.PP
+\fBExample.\ \&afpd.conf MacCyrillic setup / UTF8 unix locale\fR
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 \- \-transall \-maccodepage mac_cyrillic \-unixcodepage utf8
 .fi
+.if n \{\
+.RE
+.\}
 .PP
-\fBafpd.conf setup for Kerberos V auth\fR
-.PP
+\fBExample.\ \&afpd.conf setup for Kerberos V auth with newline escaping\fR
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
-\- \-transall \-uamlist uams_clrtxt.so,uams_dhx.so,uams_guest.so,uams_gss.so \\ 
-\-k5service afpserver \-k5keytab /path/to/afpserver.keytab \\ 
-\-k5realm YOUR.REALM \-fqdn your.fqdn.namel:548
+\- \-transall \-uamlist uams_clrtxt\&.so,uams_dhx\&.so,uams_guest\&.so,uams_gss\&.so \e 
+\-k5service afpserver \-k5keytab /path/to/afpserver\&.keytab \e 
+\-k5realm YOUR\&.REALM \-fqdn your\&.fqdn\&.namel:548
 .fi
+.if n \{\
+.RE
+.\}
 .PP
-\fBafpd.conf letting afpd appear as three servers on the net\fR
-.PP
+\fBExample.\ \&afpd.conf letting afpd appear as three servers on the net\fR
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
-"Guest Server" \-uamlist uams_guest.so \-loginmesg "Welcome guest!"
-"User Server" \-uamlist uams_dhx.so \-port 12000
+"Guest Server" \-uamlist uams_guest\&.so \-loginmesg "Welcome guest!"
+"User Server" \-uamlist uams_dhx\&.so \-port 12000
 "special" \-notcp \-defaultvol <path> \-systemvol <path>
 .fi
+.if n \{\
+.RE
+.\}
 .SH "SEE ALSO"
-\fBafpd\fR(8), \fBafppasswd\fR(1), \fBAppleVolumes.default\fR(5)
-
+.PP
+\fBafpd\fR(8),
+\fBafppasswd\fR(1),
+\fBAppleVolumes.default\fR(5)
index ae5400e4c6f22841a474ba074f718144759b671b..6e20d1be6f91063694026caedc751930015d4e15 100644 (file)
@@ -1,65 +1,93 @@
-.TH atalkd.conf 5 "22 September 2000" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: atalkd.conf
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 22 September 2000
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "ATALKD\&.CONF" "5" "22 September 2000" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 atalkd.conf \- Configuration file used by atalkd(8) to determine the interfaces used by the master Netatalk daemon
-.SH DESCRIPTION
-\fI:ETCDIR:/atalkd.conf\fR is the
-configuration file used by atalkd to configure the Appletalk interfaces
-and their behavior
+.SH "DESCRIPTION"
 .PP
-Any line not prefixed with \fI#\fR is
-interpreted. The configuration lines are composed like:
+\fB:ETCDIR:/atalkd\&.conf\fR
+is the configuration file used by atalkd to configure the Appletalk interfaces and their behavior
 .PP
-\fIInterface\fR \fI[\fR \fIoptions\fR \fI]\fR
+Any line not prefixed with
+\fB#\fR
+is interpreted\&. The configuration lines are composed like:
 .PP
-The simplest case is to have either no atalkd.conf, or to have one
-that has no active lines. In this case, atalkd should auto\-discover the
-local interfaces on the machine. Please note that you cannot split
-lines.
+\fIInterface\fR
+\fB[\fR
+\fIoptions\fR
+\fB]\fR
 .PP
-The interface is the network interface that this to work over, such
-as \fIeth0\fR for Linux, or \fIle0\fR for Sun.
+The simplest case is to have either no atalkd\&.conf, or to have one that has no active lines\&. In this case, atalkd should auto\-discover the local interfaces on the machine\&. Please note that you cannot split lines\&.
+.PP
+The interface is the network interface that this to work over, such as
+\fBeth0\fR
+for Linux, or
+\fBle0\fR
+for Sun\&.
 .PP
 The possible options and their meanings are:
-.TP 
-\fB\-addr \fInet.node\fB\fR
-Allows specification of the net and node numbers for this
-interface, specified in Appletalk numbering format (example:
-\fB\-addr 66.6\fR).
-.TP 
+.PP
+\fB\-addr \fR\fB\fInet\&.node\fR\fR
+.RS 4
+Allows specification of the net and node numbers for this interface, specified in Appletalk numbering format (example:
+\fB\-addr 66\&.6\fR)\&.
+.RE
+.PP
 \fB\-dontroute\fR
-Disables Appletalk routing. It is the opposite of
-\fB\-router\fR.
-.TP 
+.RS 4
+Disables Appletalk routing\&. It is the opposite of
+\fB\-router\fR\&.
+.RE
+.PP
 \fB\-net first[\-last]\fR
-Allows the available net to be set, optionally as a
-range.
-.TP 
+.RS 4
+Allows the available net to be set, optionally as a range\&.
+.RE
+.PP
 \fB\-noallmulti\fR (linux only)
-On linux the interfaces, atalkd uses, are set to
-ALLMULTI by default caused by countless NICs having problems
-without being forced into this mode (some even don't work with
-allmulti set). In case, you've a NIC known to support multicasts
-properly, you might want to set this option causing less packets to
-be processed
-.TP 
+.RS 4
+On linux the interfaces, atalkd uses, are set to ALLMULTI by default caused by countless NICs having problems without being forced into this mode (some even don\'t work with allmulti set)\&. In case, you\'ve a NIC known to support multicasts properly, you might want to set this option causing less packets to be processed
+.RE
+.PP
 \fB\-phase ( 1 | 2 )\fR
-Specifies the Appletalk phase that this interface is to use
-(either Phase 1 or Phase 2).
-.TP 
+.RS 4
+Specifies the Appletalk phase that this interface is to use (either Phase 1 or Phase 2)\&.
+.RE
+.PP
 \fB\-router\fR
-Like \fB\-seed\fR, but allows single interface
-routing. It is the opposite of \fB\-dontroute\fR.
-.TP 
+.RS 4
+Like
+\fB\-seed\fR, but allows single interface routing\&. It is the opposite of
+\fB\-dontroute\fR\&.
+.RE
+.PP
 \fB\-seed\fR
-The seed option only works if you have multiple interfaces. It
-also causes all missing arguments to be automagically configured
-from the network.
-.TP 
-\fB\-zone \fIzonename\fB\fR
+.RS 4
+The seed option only works if you have multiple interfaces\&. It also causes all missing arguments to be automagically configured from the network\&.
+.RE
+.PP
+\fB\-zone \fR\fB\fIzonename\fR\fR
+.RS 4
 Specifies a specific zone that this interface should appear on (example:
-\fB\-zone "Parking Lot"\fR). Please note that zones with
-spaces and other special characters should be enclosed in
-parentheses.
+\fB\-zone "Parking Lot"\fR)\&. Please note that zones with spaces and other special characters should be enclosed in parentheses\&.
+.RE
 .SH "SEE ALSO"
+.PP
 \fBatalkd\fR(8)
-
index 267c4b96788cfaa6d1ca26a935cdd2169ffb33f7..b606554ce7c0a6f5e1bcc3ba59c638c4d997f96c 100644 (file)
-.TH netatalk.conf 5 "24 June 2004" 2.0.3 Netatalk 
-.SH NAME
-netatalk.conf \- Configuration file used by netatalk(8) to determine its general configuration 
-.SH DESCRIPTION
-\fI:ETCDIR:/netatalk.conf\fR is the
-configuration file used by afpd to determine what portions of the file
-system will be shared via Appletalk, as well as their behaviors.
-.PP
-Any line not prefixed with \fI#\fR is
-interpreted. The configuration lines are composed like:
-.PP
-\fIoption\fR \fI=\fR
+'\" t
+.\"     Title: netatalk.conf
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 24 June 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "NETATALK\&.CONF" "5" "24 June 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+netatalk.conf \- Configuration file used by netatalk(8) to determine its general configuration
+.SH "DESCRIPTION"
+.PP
+\fB:ETCDIR:/netatalk\&.conf\fR
+is the configuration file used by afpd to determine what portions of the file system will be shared via Appletalk, as well as their behaviors\&.
+.PP
+Any line not prefixed with
+\fB#\fR
+is interpreted\&. The configuration lines are composed like:
+.PP
+\fIoption\fR
+\fB=\fR
 \fIvalue\fR
 .PP
 The possible options and their meanings are:
-.TP 
-\fIAFPD_GUEST\fR
-Sets the id of the guest user to a local user on the system.
-.TP 
-\fIAFPD_MAX_CLIENTS\fR
-Sets the maximum number of clients that can simultaneously
-connect to the server.
-.TP 
-\fIAFPD_RUN\fR
-Enables the afpd daemon if set to "yes". This should
-be enabled if you are planning on using netatalk as a file server.
-.TP 
-\fIAFPD_UAM_LIST\fR
-Sets the default UAMs for afpd (and papd, if printer
-authentication is compiled in) to use.
-
-\fIExample:\fR \fIAFPD_UAMLIST\fR=\fI"\-U uams_guest.so,uams_randnum.so"\fR
-.TP 
-\fICNID_METAD_RUN\fR
-Enables the cnid_metad daemon if set to "yes". This
-should be enabled if you are going to use the dbd CNID backend.
-.TP 
-\fIATALK_BGROUND\fR
-"yes" will set netatalk to initialize in the
-background, and "no" will cause normal initialization.
-.TP 
-\fIATALK_NAME\fR
-Sets the machines' Appletalk name.
-.TP 
-\fIATALK_ZONE\fR
-Sets the machines' Appletalk zone.
-.TP 
-\fIATALKD_RUN\fR
-Enables the atalkd daemon if set to "yes". This should
-be enabled if you are planning on providing Appletalk services.
-.TP 
-\fIPAPD_RUN\fR
-Enables the papd daemon if set to "yes". This should
-be enabled if you are planning on using netatalk as a print server.
-.TP 
-\fIATALK_MAC_CHARSET\fR
-Set the Mac client codepage, used by atalkd and papd to
-convert extended characters from the Unix to the Mac codepage.
-.TP 
-\fIATALK_UNIX_CHARSET\fR
-Set the Unix codepage, used by atalkd and papd to convert
-extended characters from the Unix to the Mac codepage. Has to match
-the codepage of the configuration files.
+.PP
+\fBAFPD_GUEST\fR
+.RS 4
+Sets the id of the guest user to a local user on the system\&.
+.RE
+.PP
+\fBAFPD_MAX_CLIENTS\fR
+.RS 4
+Sets the maximum number of clients that can simultaneously connect to the server\&.
+.RE
+.PP
+\fBAFPD_RUN\fR
+.RS 4
+Enables the afpd daemon if set to "yes"\&. This should be enabled if you are planning on using netatalk as a file server\&.
+.RE
+.PP
+\fBAFPD_UAM_LIST\fR
+.RS 4
+Sets the default UAMs for afpd (and papd, if printer authentication is compiled in) to use\&.
+.sp
+\fIExample:\fR
+\fBAFPD_UAMLIST\fR=\fB"\-U uams_guest\&.so,uams_randnum\&.so"\fR
+.RE
+.PP
+\fBCNID_METAD_RUN\fR
+.RS 4
+Enables the cnid_metad daemon if set to "yes"\&. This should be enabled if you are going to use the dbd CNID backend\&.
+.RE
+.PP
+\fBATALK_BGROUND\fR
+.RS 4
+"yes" will set netatalk to initialize in the background, and "no" will cause normal initialization\&.
+.RE
+.PP
+\fBATALK_NAME\fR
+.RS 4
+Sets the machines\' Appletalk name\&.
+.RE
+.PP
+\fBATALK_ZONE\fR
+.RS 4
+Sets the machines\' Appletalk zone\&.
+.RE
+.PP
+\fBATALKD_RUN\fR
+.RS 4
+Enables the atalkd daemon if set to "yes"\&. This should be enabled if you are planning on providing Appletalk services\&.
+.RE
+.PP
+\fBPAPD_RUN\fR
+.RS 4
+Enables the papd daemon if set to "yes"\&. This should be enabled if you are planning on using netatalk as a print server\&.
+.RE
+.PP
+\fBATALK_MAC_CHARSET\fR
+.RS 4
+Set the Mac client codepage, used by atalkd and papd to convert extended characters from the Unix to the Mac codepage\&.
+.RE
+.PP
+\fBATALK_UNIX_CHARSET\fR
+.RS 4
+Set the Unix codepage, used by atalkd and papd to convert extended characters from the Unix to the Mac codepage\&. Has to match the codepage of the configuration files\&.
+.RE
 .SH "SEE ALSO"
+.PP
 \fBatalkd\fR(8),
 \fBatalkd.conf\fR(5)
-
index cde96522ba758a0ddbb9392b51c124d577652b5b..d707eaa8a9e7c73c857b5bd43fbadd52762fb1f6 100644 (file)
-.TH papd.conf 5 "06 Sep 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: papd.conf
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 06 Sep 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "PAPD\&.CONF" "5" "06 Sep 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 papd.conf \- Configuration file used by papd(8) to determine the configuration of printers used by the Netatalk printing daemon
-.SH DESCRIPTION
-\fI:ETCDIR:/papd.conf\fR is the
-configuration file used by papd to configure the printing services offered
-by netatalk. Please note that papd must be enabled in \fI:ETCDIR:/netatalk.conf\fR for this to take any effect.
-\fIpapd\fR shares the same defaults as lpd on
-many systems, but not Solaris.
+.SH "DESCRIPTION"
 .PP
-Any line not prefixed with \fI#\fR is
-interpreted. The configuration lines are composed like:
+\fB:ETCDIR:/papd\&.conf\fR
+is the configuration file used by papd to configure the printing services offered by netatalk\&. Please note that papd must be enabled in
+\fB:ETCDIR:/netatalk\&.conf\fR
+for this to take any effect\&.
+\fBpapd\fR
+shares the same defaults as lpd on many systems, but not Solaris\&.
+.PP
+Any line not prefixed with
+\fB#\fR
+is interpreted\&. The configuration lines are composed like:
 .PP
 \fIprintername:[options]\fR
 .PP
-On systems running a System V printing system the simplest case is
-to have either no papd.conf, or to have one that has no active lines. In
-this case, atalkd should auto\-discover the local printers on the machine.
-Please note that you can split lines by using \fI\\\\fR.\fR
-.PP
-printername may be just a name (\fIPrinter
-1\fR), or it may be a full name in nbp_name format (\fIPrinter 1:LaserWriter@My Zone\fR).
-.PP
-Systems using a BSD printing system should make use of a pipe to the
-printing command in question within the \fIpr\fR
-option (eg. \fIpr=|/usr/bin/lpr \-J%J \-u%U\fR).
-Note: When printing using a pipe, papd recognizes several wildcards: %F
-will be replaced by the name present in the "%%For:" comment in the
-PostScript stream, same with %J for the "%%Title:" comment. %U will be
-substituted with the login name (the latter applies only when
-authenticated printing is in effect).
-.PP
-When CUPS support is compiled in, then \fIcupsautoadd \fRas the first entry in papd.conf will
-automagically share all CUPS printers by papd utilizing the PPDs assigned
-in CUPS (customizable \-\- see below). This can be overwritten for individal
-printers by subsequently adding individual entries using the CUPS queue
-name as \fIpr \fRentry. Note: CUPS support is
-mutually exclusive with System V support described above.
-.PP
-The possible options are colon delimited (\fI:\fR), and lines must be terminated with colons. The
-possible options and flags are:
-.TP 
-\fIam=(uams list)\fR
-The \fIam\fR option allows specific
-UAMs to be specified for a particular printer. It has no effect if
-the \fIau\fR flag is not present or if papd
-authentication was not built into netatalk. Note: possible values
-are \fIuams_guest.so\fR and \fIuams_clrtxt.so\fR only. The first method requires
-a valid username, but no password. The second requires both a valid
-username and the correct password.
-.TP 
-\fIau\fR
-If present, this flag enables authentication for the printer.
-Please note that papd authentication must be built into netatalk for
-this to take effect.
-.TP 
-\fIco=(CUPS options)\fR
-The \fIco\fR option allows options to
-be passed through to CUPS (eg. \fIco="protocol=TBCP" \fRor \fIco="raw"\fR).
-.TP 
-\fIcupsautoadd[:type][@zone]\fR
-If used as the first entry in papd.conf this will share all
-CUPS printers via papd. type/zone settings as well as other
-parameters assigned to this special printer share will apply to all
-CUPS printers. Unless the \fIpd\fR option
-is set, the CUPS PPDs will be used. To overwrite these global
-settings for individual printers simply add them subsequently to
-papd.conf and assign different settings.
-.TP 
-\fIfo\fR
-If present, this flag enables a hack to translate line endings
-originating from pre Mac OS X LaserWriter drivers to let \fIfoomatic\-rip\fR recognize foomatic PPD options set
-in the printer dialog. Attention: Use with caution since this might
-corrupt binary print jobs!
-.TP 
-\fIop=(operator)\fR
-This specifies the operator name, for lpd spooling.
-.TP 
-\fIpa=(appletalk address)\fR
-Allows specification of Appletalk addresses. Usually not
-needed.
-.TP 
-\fIpd=(path to ppd file)\fR
-Specifies a particular PPD (printer description file) to
-associate with the selected printer.
-.TP 
-\fIpr=(lpd/CUPS printer name or pipe command)\fR
-Sets the \fIlpd\fR or \fICUPS\fR printer that this is spooled to.
-.SH EXAMPLES
-Unless CUPS support has been compiled in (which is default from
-Netatalk 2.0 on) one simply defines the lpd queue in question by setting
-the \fBpr\fR parameter to the queue name, in the following
-example "ps". If no \fBpr\fR parameter is set, the default
-printer will be used.
-.PP
-\fBpapd.conf System V printing system examples\fR
-.PP
-The first spooler is known by the AppleTalk name Mac Printer
-Spooler, and uses a PPD file located in
-\fB/usr/share/lib/ppd\fR. In addition, the user mcs will
-be the owner of all jobs that are spooled. The second spooler is known
-as HP Printer and all options are the default. 
-
+On systems running a System V printing system the simplest case is to have either no papd\&.conf, or to have one that has no active lines\&. In this case, atalkd should auto\-discover the local printers on the machine\&. Please note that you can split lines by using
+\fB\e\efR\&.\fR
+.PP
+printername may be just a name (\fBPrinter 1\fR), or it may be a full name in nbp_name format (\fBPrinter 1:LaserWriter@My Zone\fR)\&.
+.PP
+Systems using a BSD printing system should make use of a pipe to the printing command in question within the
+\fBpr\fR
+option (eg\&.
+\fBpr=|/usr/bin/lpr \-J%J \-u%U\fR)\&. Note: When printing using a pipe, papd recognizes several wildcards: %F will be replaced by the name present in the "%%For:" comment in the PostScript stream, same with %J for the "%%Title:" comment\&. %U will be substituted with the login name (the latter applies only when authenticated printing is in effect)\&.
+.PP
+When CUPS support is compiled in, then
+\fBcupsautoadd \fR
+as the first entry in papd\&.conf will automagically share all CUPS printers by papd utilizing the PPDs assigned in CUPS (customizable \-\- see below)\&. This can be overwritten for individal printers by subsequently adding individual entries using the CUPS queue name as
+\fBpr \fR
+entry\&. Note: CUPS support is mutually exclusive with System V support described above\&.
+.PP
+The possible options are colon delimited (\fB:\fR), and lines must be terminated with colons\&. The possible options and flags are:
+.PP
+\fBam=(uams list)\fR
+.RS 4
+The
+\fBam\fR
+option allows specific UAMs to be specified for a particular printer\&. It has no effect if the
+\fBau\fR
+flag is not present or if papd authentication was not built into netatalk\&. Note: possible values are
+\fBuams_guest\&.so\fR
+and
+\fB uams_clrtxt\&.so\fR
+only\&. The first method requires a valid username, but no password\&. The second requires both a valid username and the correct password\&.
+.RE
+.PP
+\fBau\fR
+.RS 4
+If present, this flag enables authentication for the printer\&. Please note that papd authentication must be built into netatalk for this to take effect\&.
+.RE
+.PP
+\fBco=(CUPS options)\fR
+.RS 4
+The
+\fBco\fR
+option allows options to be passed through to CUPS (eg\&.
+\fBco="protocol=TBCP" \fR
+or
+\fBco="raw"\fR)\&.
+.RE
+.PP
+\fBcupsautoadd[:type][@zone]\fR
+.RS 4
+If used as the first entry in papd\&.conf this will share all CUPS printers via papd\&. type/zone settings as well as other parameters assigned to this special printer share will apply to all CUPS printers\&. Unless the
+\fBpd\fR
+option is set, the CUPS PPDs will be used\&. To overwrite these global settings for individual printers simply add them subsequently to papd\&.conf and assign different settings\&.
+.RE
+.PP
+\fBfo\fR
+.RS 4
+If present, this flag enables a hack to translate line endings originating from pre Mac OS X LaserWriter drivers to let
+\fBfoomatic\-rip\fR
+recognize foomatic PPD options set in the printer dialog\&. Attention: Use with caution since this might corrupt binary print jobs!
+.RE
+.PP
+\fBop=(operator)\fR
+.RS 4
+This specifies the operator name, for lpd spooling\&.
+.RE
+.PP
+\fBpa=(appletalk address)\fR
+.RS 4
+Allows specification of Appletalk addresses\&. Usually not needed\&.
+.RE
+.PP
+\fBpd=(path to ppd file)\fR
+.RS 4
+Specifies a particular PPD (printer description file) to associate with the selected printer\&.
+.RE
+.PP
+\fBpr=(lpd/CUPS printer name or pipe command)\fR
+.RS 4
+Sets the
+\fBlpd\fR
+or
+\fBCUPS\fR
+printer that this is spooled to\&.
+.RE
+.SH "EXAMPLES"
+.PP
+Unless CUPS support has been compiled in (which is default from Netatalk 2\&.0 on) one simply defines the lpd queue in question by setting the
+\fBpr\fR
+parameter to the queue name, in the following example "ps"\&. If no
+\fBpr\fR
+parameter is set, the default printer will be used\&.
+.PP
+\fBExample.\ \&papd.conf System V printing system examples\fR
+.PP
+The first spooler is known by the AppleTalk name Mac Printer Spooler, and uses a PPD file located in
+/usr/share/lib/ppd\&. In addition, the user mcs will be the owner of all jobs that are spooled\&. The second spooler is known as HP Printer and all options are the default\&.
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
-Mac Printer Spooler:\\
-   :pr=ps:\\
-   :pd=/usr/share/lib/ppd/HPLJ_4M.PPD:\\
+Mac Printer Spooler:\e
+   :pr=ps:\e
+   :pd=/usr/share/lib/ppd/HPLJ_4M\&.PPD:\e
    :op=mcs:
 
-HP Printer:\\
+HP Printer:\e
    :
 .fi
-.PP
-An alternative to the technique outlined above is to direct papd's
-output via a pipe into another program. Using this mechanism almost all
-printing systems can be driven. Netatalk supplies three "wildcards" that
-get substituted with values of the already printed job:
-\fB%F\fR, \fB%U\fR and \fB%J\fR. Using
-these wildcards, one can pass those parameters directly to programs or
-implement small wrapper scripts to call the printing system in
-question.
-.PP
-\fBpapd.conf examples using pipes\fR
-.PP
-The first spooler is known as HP 8100. It pipes the print job to
-/usr/bin/lpr for printing using the value of the
-\fI%%Title: \fRcomment as job name. PSSP authenticated
-printing is enabled, as is CAP\-style authenticated printing. Both
-methods support guest and cleartext authentication as specified by the
-\&'\fBam\fR' option. The PPD used is
-\fB/etc/atalk/ppds/hp8100.ppd\fR. The second spooler is
-called "Dump PostScript" and uses a pipe to cat to
-send the raw PostScript code into the user's home directory into a file
-called like the printjob. 
+.if n \{\
+.RE
+.\}
 
+.PP
+An alternative to the technique outlined above is to direct papd\'s output via a pipe into another program\&. Using this mechanism almost all printing systems can be driven\&. Netatalk supplies three "wildcards" that get substituted with values of the already printed job:
+\fB%F\fR,
+\fB%U\fR
+and
+\fB%J\fR\&. Using these wildcards, one can pass those parameters directly to programs or implement small wrapper scripts to call the printing system in question\&.
+.PP
+\fBExample.\ \&papd.conf examples using pipes\fR
+.PP
+The first spooler is known as HP 8100\&. It pipes the print job to
+\fB/usr/bin/lpr\fR
+for printing using the value of the
+\fI%%Title: \fR
+comment as job name\&. PSSP authenticated printing is enabled, as is CAP\-style authenticated printing\&. Both methods support guest and cleartext authentication as specified by the \'\fBam\fR\' option\&. The PPD used is
+/etc/atalk/ppds/hp8100\&.ppd\&. The second spooler is called "Dump PostScript" and uses a pipe to
+\fBcat\fR
+to send the raw PostScript code into the user\'s home directory into a file called like the printjob\&.
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
-HP 8100:\\
-   :pr=|/usr/bin/lpr \-Plp \-J"%J":\\
-   :sp:\\
-   :ca=/tmp/print:\\
-   :am=uams_guest.so,uams_pam.so:\\
-   :pd=/etc/atalk/ppds/hp8100.ppd:
+HP 8100:\e
+   :pr=|/usr/bin/lpr \-Plp \-J"%J":\e
+   :sp:\e
+   :ca=/tmp/print:\e
+   :am=uams_guest\&.so,uams_pam\&.so:\e
+   :pd=/etc/atalk/ppds/hp8100\&.ppd:
 
-Dump PostScript:LaserWriter@Server:\\
-   :pr=|cat >/home/%U/%J\-prn.out:\\
-   :pd=/usr/share/lib/ppd/mooralana.ppd:\\
-   :sp:au:op=lp:\\
-   :am=uams_clrtxt.so:
+Dump PostScript:LaserWriter@Server:\e
+   :pr=|cat >/home/%U/%J\-prn\&.out:\e
+   :pd=/usr/share/lib/ppd/mooralana\&.ppd:\e
+   :sp:au:op=lp:\e
+   :am=uams_clrtxt\&.so:
 .fi
-.PP
-Starting with Netatalk 2.0 direct CUPS integration is available. In
-this case, defining only a queue name as \fBpr\fR parameter
-won't invoke the SysV lpd daemon but uses CUPS instead. Unless a specific
-PPD has been assigned using the \fBpd\fR switch, the PPD
-configured in CUPS will be used by papd, too.
-.PP
-There exists one special share named "cupsautoadd". If this is
-present as the first entry then all available CUPS queues will be served
-automagically using the parameters assigned to this global share. But
-subsequent printer definitions can be used to override these global
-settings for individual spoolers.
-.PP
-\fBpapd.conf CUPS examples\fR
-.PP
-The first entry sets up automatic sharing of all CUPS printers.
-All those shares appear in the zone "1st floor" and since no additional
-settings have been made, they use the CUPS printer name as NBP name and
-use the PPD configured in CUPS. The second entry defines different
-settings for one single CUPS printer. It's NBP name is differing from
-the printer's name and the registration happens in another zone.
+.if n \{\
+.RE
+.\}
 
+.PP
+Starting with Netatalk 2\&.0 direct CUPS integration is available\&. In this case, defining only a queue name as
+\fBpr\fR
+parameter won\'t invoke the SysV lpd daemon but uses CUPS instead\&. Unless a specific PPD has been assigned using the
+\fBpd\fR
+switch, the PPD configured in CUPS will be used by
+\fBpapd\fR, too\&.
+.PP
+There exists one special share named "cupsautoadd"\&. If this is present as the first entry then all available CUPS queues will be served automagically using the parameters assigned to this global share\&. But subsequent printer definitions can be used to override these global settings for individual spoolers\&.
+.PP
+\fBExample.\ \&papd.conf CUPS examples\fR
+.PP
+The first entry sets up automatic sharing of all CUPS printers\&. All those shares appear in the zone "1st floor" and since no additional settings have been made, they use the CUPS printer name as NBP name and use the PPD configured in CUPS\&. The second entry defines different settings for one single CUPS printer\&. It\'s NBP name is differing from the printer\'s name and the registration happens in another zone\&.
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
 cupsautoadd@1st floor:op=root:
 
-Boss' LaserWriter@2nd floor:\\
+Boss\' LaserWriter@2nd floor:\e
    :pr=laserwriter\-chief:
 .fi
-.SH "SEE ALSO"
-\fBpapd\fR(8), \fBatalkd.conf\fR(5), \fBlpd\fR(8), \fBlpoptions\fR(8)
+.if n \{\
+.RE
+.\}
 
+.SH "SEE ALSO"
+.PP
+\fBpapd\fR(8),
+\fBatalkd.conf\fR(5),
+\fBlpd\fR(8),
+\fBlpoptions\fR(8)
index ac22c48c95b5d0a9e7acf437c542a96ef4708455..56fee967f88206b3192d2f06e2f33e02b12ceda1 100644 (file)
-.TH afpd 8 "06 Jan 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: afpd
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 06 Jan 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "AFPD" "8" "06 Jan 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 afpd \- AppleTalk Filing Protocol daemon
-.SH SYNOPSIS
-\fBafpd\fR [\-duptDTvI] [\-f \fBdefaultvolumes\fR] [\-s \fBsystemvolumes\fR] [\-n \fBnbpname\fR] [\-c \fBmaxconnections\fR] [\-g \fBguest\fR] [\-P \fBpidfile\fR] [\-S \fBport\fR] [\-L \fBmessage\fR] [\-F \fBconfig\fR] [\-U \fBuamsv\fR] [\-m \fBumask\fR]
-.SH DESCRIPTION
-afpd provides an AppleTalk Filing Protocol (AFP)
-interface to the Unix file system. It is normally started at boot time
-from /etc/rc. 
+.SH "SYNOPSIS"
+.HP \w'\fBafpd\fR\fB\fR\ 'u
+\fBafpd\fR\fB\fR [\-duptDTvI] [\-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\ \fIconfig\fR] [\-U\ \fIuamsv\fR] [\-m\ \fIumask\fR]
+.SH "DESCRIPTION"
+.PP
+\fBafpd\fR
+provides an AppleTalk Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time from /etc/rc\&.
 .PP
 The list of volumes offered to the user is generated from
-\fB:ETCDIR:/AppleVolumes.system\fR and one of
-\fB:ETCDIR:/AppleVolumes.default\fR, \fB~/AppleVolumes\fR,
-or \fB~/.AppleVolumes\fR. The \fBAppleVolumes\fR
-files is used to specify volumes to mount and file name extension
-mappings. It is formatted as follows, one specification per line: pathname
-[ volumename ] .extension [ type [ creator ] ] If volumename is
-unspecified, the last component of pathname is used. No two volumes may
-have the same name. If type is unspecified '????' is used. If
-creator is unspecified 'UNIX' is used. The extension '.'
-sets the default creator and type for otherwise untyped Unix files. Blank
-lines and lines beginning with `#' are ignored.
-.PP
-.SH OPTIONS
-.TP 
+:ETCDIR:/AppleVolumes\&.system
+and one of
+:ETCDIR:/AppleVolumes\&.default,
+~/AppleVolumes, or
+~/\&.AppleVolumes\&. The
+AppleVolumes
+files is used to specify volumes to mount and file name extension mappings\&. It is formatted as follows, one specification per line: pathname [ volumename ] \&.extension [ type [ creator ] ] If volumename is unspecified, the last component of pathname is used\&. No two volumes may have the same name\&. If type is unspecified \'????\' is used\&. If creator is unspecified \'UNIX\' is used\&. The extension \'\&.\' sets the default creator and type for otherwise untyped Unix files\&. Blank lines and lines beginning with `#\' are ignored\&.
+.PP
+.SH "OPTIONS"
+.PP
 \-d
-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.
-.TP 
+.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
-Prevents clients from saving their passwords. (Equivalent to \-\fBnosavepasswd\fR
-in \fBafpd.conf\fR.)
-.TP 
+.RS 4
+Prevents clients from saving their passwords\&. (Equivalent to \-\fBnosavepasswd\fR
+in
+afpd\&.conf\&.)
+.RE
+.PP
 \-t
-Allows clients to change their passwords. (Equivalent to
-\fB\-setpasswd\fR in \fBafpd.conf\fR.)
-.TP 
+.RS 4
+Allows clients to change their passwords\&. (Equivalent to
+\fB\-setpasswd\fR
+in
+afpd\&.conf\&.)
+.RE
+.PP
 \-D
-Use DDP (AppleTalk) as transport protocol. (Equivalent to
-\fB\-ddp\fR in \fBafpd.cond\fR.)
-.TP 
+.RS 4
+Use DDP (AppleTalk) as transport protocol\&. (Equivalent to
+\fB\-ddp\fR
+in
+afpd\&.cond\&.)
+.RE
+.PP
 \-T
-Use TCP/IP as transport protocol. (Equivalent to
-\fB\-tcp\fR in \fBafpd.conf\fR.)
-.TP 
+.RS 4
+Use TCP/IP as transport protocol\&. (Equivalent to
+\fB\-tcp\fR
+in
+afpd\&.conf\&.)
+.RE
+.PP
 \-v
-Print version information and exit.
-.TP 
+.RS 4
+Print version information and exit\&.
+.RE
+.PP
 \-I
-Use a platform specific icon. (Equivalent to \fB\-icon\fR
-in \fBafpd.conf\fR.)
-.TP 
+.RS 4
+Use a platform specific icon\&. (Equivalent to
+\fB\-icon\fR
+in
+afpd\&.conf\&.)
+.RE
+.PP
 \-f \fIdefaultvolumes\fR
-Specifies that \fIdefaultvolumes\fR
+.RS 4
+Specifies that
+\fIdefaultvolumes\fR
 should be read for a list of default volumes to offer, instead of
-\fB:ETCDIR:/AppleVolumes.default\fR.
-.TP 
+:ETCDIR:/AppleVolumes\&.default\&.
+.RE
+.PP
 \-s \fIsystemvolumes\fR
-Specifies that \fIsystemvolumes\fR should
-be read for a list of volume that all users will be offered, instead
-of \fB:ETCDIR:/AppleVolumes.system\fR.
-.TP 
+.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
-Read the user's \fBAppleVolumes\fR file
-first. This option causes volume names in the user's
-\fBAppleVolumes\fR file to override volume names in
-the system's \fBAppleVolumes\fR file. The default
-is to read the system \fBAppleVolumes\fR file first.
-Note that this option doesn't effect the precendence of filename
-extension mappings: the user's \fBAppleVolumes\fR
-file always has precedence.
-.TP 
+.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
-Specifies that \fInbpname\fR should be
-used for NBP registration, instead of the first component of the
-hostname in the local zone.
-.TP 
+.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
-afpd. The default is 20.
-.TP 
+\fBafpd\fR\&. The default is 20\&.
+.RE
+.PP
 \-g \fIguest\fR
-Specifies the name of the guest account. The default is
-\&'\fInobody\fR'.
-.TP 
+.RS 4
+Specifies the name of the guest account\&. The default is \'\fInobody\fR\'\&.
+.RE
+.PP
 \-P \fIpidfile\fR
-Specifies the file in which afpd stores its
-process id.
-.TP 
+.RS 4
+Specifies the file in which
+\fBafpd\fR
+stores its process id\&.
+.RE
+.PP
 \-S \fIport\fR
-Specifies the port to register with when doing AFPoverTCP.
-Defaults to 548. (Equivalent to \fB\-port \fRin
-\fBafpd.conf\fR.)
-.TP 
+.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
-Specifies the login message that will be sent to clients.
-(Equivalent to \fB\-loginmsg\fR in \fBafpd.conf\fR.)
-.TP 
+.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
-Specifies the configuration file to use. (Defaults to
-\fB:ETCDIR:/netatalk/afpd.conf\fR.)
-.TP 
+.RS 4
+Specifies the configuration file to use\&. (Defaults to
+:ETCDIR:/netatalk/afpd\&.conf\&.)
+.RE
+.PP
 \-U \fIuams\fR
-Comma\-separated list of UAMs to use for the authentication
-process. (Equivalent to \fB\-uamlist\fR in
-\fBafpd.conf\fR.)
-.TP 
+.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
-Use this umask for the creation of
-folders in Netatalk.
-.SH SIGNALS
-Signals that are sent to the main afpd process
-are propagated to the children, so all will be affected.
-.TP 
+.RS 4
+Use this
+\fIumask\fR
+for the creation of folders in Netatalk\&.
+.RE
+.SH "SIGNALS"
+.PP
+Signals that are sent to the main
+\fBafpd\fR
+process are propagated to the children, so all will be affected\&.
+.PP
 SIGHUP
-Sending a SIGHUP to afpd will cause it to
-reload its configuration files.
-.TP 
+.RS 4
+Sending a
+\fBSIGHUP\fR
+to afpd will cause it to reload its configuration files\&.
+.RE
+.PP
 SIGUSR1
-The afpd process will send the message
-"The server is going down for maintenance." to the client
-and shut itself down in 5 minutes. New connections are not allowed.
-If this is sent to a child afpd, the other children are not
-affected. However, the main process will still exit, disabling all
-new connections.
-.TP 
+.RS 4
+The
+\fBafpd\fR
+process will send the message "The server is going down for maintenance\&." to the client and shut itself down in 5 minutes\&. New connections are not allowed\&. If this is sent to a child afpd, the other children are not affected\&. However, the main process will still exit, disabling all new connections\&.
+.RE
+.PP
 SIGUSR2
-The afpd process will look in the message
-directory configured at build time for a file named message.pid. For
-each one found, a the contents will be sent as a message to the
-associated AFP client. The file is removed after the message is
-sent. This should only be sent to a child afpd.
-Warning: If the \-\-with\-message\-dir option was not used, this will
-kill the afpd process
-
-To shut down a user's afpd process it
-is recommended that SIGKILL (\-9)
-\fINOT\fR be used, except as a last resort, as this
-may leave the CNID database in an inconsistent state. The safe way
-to terminate an afpd is to send it a
-SIGTERM (\-15) signal and wait for it to die on
-its own.
-.SH FILES
-.TP 
-\fB:ETCDIR:/AppleVolumes.default\fR
+.RS 4
+The
+\fBafpd\fR
+process will look in the message directory configured at build time for a file named message\&.pid\&. For each one found, a the contents will be sent as a message to the associated AFP client\&. The file is removed after the message is sent\&. This should only be sent to a child
+\fBafpd\fR\&. Warning: If the \-\-with\-message\-dir option was not used, this will kill the
+\fBafpd\fR
+process
+.sp
+To shut down a user\'s
+\fBafpd\fR
+process it is recommended that
+\fBSIGKILL (\-9)\fR
+\fINOT\fR
+be used, except as a last resort, as this may leave the CNID database in an inconsistent state\&. The safe way to terminate an
+\fBafpd\fR
+is to send it a
+\fBSIGTERM (\-15)\fR
+signal and wait for it to die on its own\&.
+.RE
+.SH "FILES"
+.PP
+:ETCDIR:/AppleVolumes\&.default
+.RS 4
 list of default volumes to mount
-.TP 
-\fB:ETCDIR:/AppleVolumes.system\fR
+.RE
+.PP
+:ETCDIR:/AppleVolumes\&.system
+.RS 4
 list of volumes to offer all users
-.TP 
-\fB~/AppleVolumes\fR
-user's list of volumes to mount
-.TP 
-\fB:ETCDIR:/netatalk/msg/message.pid\fR
-contains messages to be sent to users.
-.SH BUGS
+.RE
+.PP
+~/AppleVolumes
+.RS 4
+user\'s list of volumes to mount
+.RE
+.PP
+:ETCDIR:/netatalk/msg/message\&.pid
+.RS 4
+contains messages to be sent to users\&.
+.RE
+.SH "BUGS"
+.PP
 .SH "SEE ALSO"
+.PP
 \fBhosts_access\fR(5),
 \fBafpd.conf\fR(5),
 \fBAppleVolumes.default\fR(5),
-\fBAppleVolumes.system\fR(5).
-
+\fBAppleVolumes.system\fR(5)\&.
index c0caa0a006c943d95fb5cf30089a7f10d79dc591..4a6c0e0ad0a14b183f0becdc8e199ac5e05067c4 100644 (file)
-.TH atalkd 8 "06 Sep 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: atalkd
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 06 Sep 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "ATALKD" "8" "06 Sep 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 atalkd \- AppleTalk RTMP, NBP, ZIP, and AEP manager
-.SH SYNOPSIS
-\fBatalkd\fR [\-f \fBconfigfile\fR] [\-1] [\-2]
-.SH DESCRIPTION
-atalkd is responsible for all user level
-AppleTalk network management. This includes routing, name registration and
-lookup, zone lookup, and the AppleTalk Echo Protocol (similar to
-\fBping\fR(8)). atalkd is typically started at boot
-time, out of \fB/etc/rc\fR. It first reads from its
-configuration file, \fB:ETCDIR:/atalkd.conf\fR. If there is
-no configuration file, atalkd will attempt to configure
-all available interfaces and will create a configuration file. The file
-consists of a series of interfaces, one per line. Lines with `#' in the
-first column are ignored, as are blank lines. The syntax is
+.SH "SYNOPSIS"
+.HP \w'\fBatalkd\fR\fB\fR\fB\fR\fB\fR\fB\fR\fB\fR\fB\fR\ 'u
+\fBatalkd\fR\fB\fR\fB\fR\fB\fR\fB\fR\fB\fR\fB\fR [\-f\ \fIconfigfile\fR] [\-1] [\-2]
+.SH "DESCRIPTION"
 .PP
-\fIinterface\fR [ \fB\-seed\fR ]
-[ \fB\-phase\fR \fInumber\fR ] [
-\fB\-net\fR \fInet\-range\fR ] [
-\fB\-addr\fR \fIaddress\fR ] [
-\fB\-zone\fR \fIzonename\fR ] ...
+\fBatalkd\fR
+is responsible for all user level AppleTalk network management\&. This includes routing, name registration and lookup, zone lookup, and the AppleTalk Echo Protocol (similar to
+\fBping\fR(8))\&.
+\fBatalkd\fR
+is typically started at boot time, out of
+/etc/rc\&. It first reads from its configuration file,
+:ETCDIR:/atalkd\&.conf\&. If there is no configuration file,
+\fBatalkd\fR
+will attempt to configure all available interfaces and will create a configuration file\&. The file consists of a series of interfaces, one per line\&. Lines with `#\' in the first column are ignored, as are blank lines\&. The syntax is
 .PP
-Note that all fields except the interface are optional. The loopback
-interface is configured automatically. If \fB\-seed\fR is
-specified, all other fields must be present. Also,
-atalkd will exit during bootstrap\%ping, if a router
-disagrees with its seed information. If \fB\-seed\fR is not
-given, all other information may be overriden during auto\-configuration.
-If no \fB\-phase\fR option is given, the default phase as given
-on the command line is used (the default is 2). If \fB\-addr\fR
-is given and \fB\-net\fR is not, a net\-range of one is
-assumed.
+\fIinterface\fR
+[
+\fB\-seed\fR
+] [
+\fB\-phase\fR
+\fInumber\fR
+] [
+\fB\-net\fR
+\fInet\-range\fR
+] [
+\fB\-addr\fR
+\fIaddress\fR
+] [
+\fB\-zone\fR
+\fIzonename\fR
+] \&.\&.\&.
 .PP
-The first \-zone directive for each interface is the ``default''
-zone. Under Phase 1, there is only one zone. Under Phase 2, all routers on
-the network are configured with the default zone and must agree.
-atalkd maps ``*'' to the default zone of the first
-interface. Note: The default zone for a machine is determined by the
-configuration of the local routers; to appear in a non\-default zone, each
-service, e.g. afpd, must individually specify the
-desired zone. See also \fBnbp_name\fR(3).
-.SH ROUTING
-If you are connecting a netatalk router to an existing AppleTalk
-internet, you should first contact your local network administrators to
-obtain appropriate network addresses.
+Note that all fields except the interface are optional\&. The loopback interface is configured automatically\&. If
+\fB\-seed\fR
+is specified, all other fields must be present\&. Also,
+\fBatalkd\fR
+will exit during bootstrap\%ping, if a router disagrees with its seed information\&. If
+\fB\-seed\fR
+is not given, all other information may be overriden during auto\-configuration\&. If no
+\fB\-phase\fR
+option is given, the default phase as given on the command line is used (the default is 2)\&. If
+\fB\-addr\fR
+is given and
+\fB\-net\fR
+is not, a net\-range of one is assumed\&.
 .PP
-atalkd can provide routing between interfaces by
-configuring multiple interfaces. Each interface must be assigned a unique
-net\-range between 1 and 65279 (0 and 65535 are illegal, and addresses
-between 65280 and 65534 are reserved for startup). It is best to choose
-the smallest useful net\-range, i.e. if you have three machines on an
-Ethernet, don't chose a net\-range of 1000\-2000. Each net\-range may have an
-arbitrary list of zones associated with it.
-.SH EXAMPLES
-Below is an example configuration file for a sun4/40. The machine
-has two interfaces, ``le0'' and ``le1''. The ``le0'' interface is
-configured automatically from other routers on the network. The machine is
-the only router for the ``le1'' interface.
+The first \-zone directive for each interface is the ``default\'\' zone\&. Under Phase 1, there is only one zone\&. Under Phase 2, all routers on the network are configured with the default zone and must agree\&.
+\fBatalkd\fR
+maps ``*\'\' to the default zone of the first interface\&. Note: The default zone for a machine is determined by the configuration of the local routers; to appear in a non\-default zone, each service, e\&.g\&.
+\fBafpd\fR, must individually specify the desired zone\&. See also
+\fBnbp_name\fR(3)\&.
+.SH "ROUTING"
 .PP
+If you are connecting a netatalk router to an existing AppleTalk internet, you should first contact your local network administrators to obtain appropriate network addresses\&.
+.PP
+\fBatalkd\fR
+can provide routing between interfaces by configuring multiple interfaces\&. Each interface must be assigned a unique net\-range
+between 1 and 65279 (0 and 65535 are illegal, and addresses between 65280 and 65534 are reserved for startup)\&. It is best to choose the smallest useful net\-range, i\&.e\&. if you have three machines on an Ethernet, don\'t chose a net\-range of 1000\-2000\&. Each net\-range may have an arbitrary list of zones associated with it\&.
+.SH "EXAMPLES"
+.PP
+Below is an example configuration file for a sun4/40\&. The machine has two interfaces, ``le0\'\' and ``le1\'\'\&. The ``le0\'\' interface is configured automatically from other routers on the network\&. The machine is the only router for the ``le1\'\' interface\&.
+.PP
+.if n \{\
+.RS 4
+.\}
 .nf
    le0
    le1 \-seed \-net 9461\-9471 \-zone netatalk \-zone Argus
 .fi
-
-atalkd
-automatically acts as a router if there is more than one interface.
-.SH FILES
-\fB:ETCDIR:/atalkd.conf\fR configuration file
-.SH BUGS
-On some systems, atalkd can not be
-restarted.
+.if n \{\
+.RE
+.\}
+.sp
+\fBatalkd\fR
+automatically acts as a router if there is more than one interface\&.
+.SH "FILES"
+.PP
+:ETCDIR:/atalkd\&.conf
+configuration file
+.SH "BUGS"
+.PP
+On some systems,
+\fBatalkd\fR
+can not be restarted\&.
 .SH "SEE ALSO"
+.PP
 \fBatalkd.conf\fR(5)
-
index c751f270bd7745917c8e9a28e3511be7d0f20463..c500ad2d3f7b1e96d68103494972d163a83792c3 100644 (file)
-.TH cnid_dbd 8 "2 Dec 2003" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: cnid_dbd
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 2 Dec 2003
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "CNID_DBD" "8" "2 Dec 2003" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 cnid_dbd \- implement access to CNID databases through a dedicated daemon process
-.SH SYNOPSIS
-\fBcnid_dbd\fR \fBdbdir\fR \fBctrlfd\fR \fBclntfd\fR 
-.SH DESCRIPTION
-cnid_dbd provides an interface for storage and
-retrieval of catalog node IDs (CNIDs) and related information to the
-\fIafpd\fR daemon. CNIDs are a component of
-Macintosh based file systems with semantics that map not easily onto Unix
-file systems. This makes separate storage in a database necessary.
-cnid_dbd is part of the \fICNID
-backend\fR framework of \fIafpd\fR and
-implements the \fIdbd\fR backend.
-.PP
-cnid_dbd is never started via the command line or
-system startup scripts but only by the \fIcnid_metad\fR daemon. There is at most one instance of
-cnid_dbd per netatalk volume.
-.PP
-cnid_dbd uses the \fIBerkleley
-DB\fR database library and optionally supports transactionally
-protected updates if the netatalk package is compiled with the appropriate
-options. Using the \fIdbd\fR backend without
-transactions will protect the CNID database against unexpected crashes of
-the \fIafpd\fR daemon. Using the \fIdbd\fR backend with transactions will avoid corruption
-of the CNID database even if the system crashes unexpectedly.
-.PP
-cnid_dbd uses the same on\-disk database format as
-the \fIcdb\fR backend. It is therefore possible
-to switch between the two backends as necessary.
-.PP
-cnid_dbd inherits the effective userid and
-groupid from \fIcnid_metad\fR on startup, which
-is normally caused by \fIafpd\fR serving a
-netatalk volume to a client. It changes to the \fIBerkleley DB\fR database home directory \fIdbdir\fR that is associated with the volume. If the
-userid inherited from \fIcnid_metad\fR is 0
-(root), cnid_dbd will change userid and groupid to the
-owner and group of the database home directory. Otherwise, it will
-continue to use the inherited values. cnid_dbd will
-then attempt to open the database and start serving requests using
-filedescriptor \fIclntfd\fR. Subsequent instances
-of \fIafpd\fR that want to access the same volume
-are redirected to the running cnid_dbd process by
-\fIcnid_metad\fR via the filedescriptor \fIctrlfd\fR.
-.PP
-cnid_dbd can be configured to run forever or to
-exit after a period of inactivity. If cnid_dbd receives
-a TERM or an INT signal it will exit cleanly after flushing dirty database
-buffers to disk and closing \fIBerkleley DB\fR
-database environments. It is safe to terminate cnid_dbd
-this way, it will be restarted when necessary. Other signals are not
-handled and will cause an immediate exit, possibly leaving the CNID
-database in an inconsistent state (no transactions) or losing recent
-updates during recovery (transactions).
-.PP
-If transactions are used the \fIBerkleley
-DB\fR database subsystem will create files named log.xxxxxxxxxx in
-the database home directory \fIdbdir\fR, where
-xxxxxxxxxx is a monotonically increasing integer. These files contain
-information to replay database changes and are not automatically removed,
-unless the \fIlogfile_autoremove\fR option is
-specified in the \fIdb_param\fR configuration
-file (see below). Please see the sections \fIDatabase and
-log file archival\fR, \fILog file
-removal\fR and the documentation of the \fI
-db_archive\fR command line utility in the Berkeley DB Tutorial and
-Reference for information when and how it is safe to remove these files
-manually.
-.PP
-Do not use cnid_dbd for databases on
-NFS mounted file systems. It makes the whole point of securing
-database changes properly moot. Use the dbdir: Option in the appropriate
-\fIAppleVolumes\fR configuration file to put the
-database onto a local disk.
-.SH CONFIGURATION
-cnid_dbd reads configuration information from the
-file \fIdb_param\fR in the database directory
-\fIdbdir\fR on startup. If the file does not
-exist or a parameter is not listed, suitable default values are used. The
-format for a single parameter is the parameter name, followed by one or
-more spaces, followed by the parameter value, followed by a newline. The
-following parameters are currently recognized:
-.TP 
-\fIlogfile_autoremove\fR
-This flag is ignored unless transactional support is enabled.
-If set to 1, unused Berkeley DB transactional logfiles
-(log.xxxxxxxxxx in the database home directory) are removed on
-startup of cnid_dbd. This is usually safe if the
-content of the database directory is backed up on a regular basis.
-Default: 0.
-.TP 
-\fIcachesize\fR
-Determines the size of the Berkeley DB cache in kilobytes.
-Default: 1024. Each cnid_dbd process grabs that
-much memory on top of its normal memory footprint. It can be used to
-tune database performance. The \fIdb_stat\fR utility with the \fB\-m\fR
-option that comes with Berkely DB can help you determine wether you
-need to change this value. The default is pretty conservative so
-that a large percentage of requests should be satisfied from the
-cache directly. If memory is not a bottleneck on your system you
-might want to leave it at that value. The \fIBerkeley DB Tutorial and Reference Guide\fR has a
-section \fISelecting a cache size\fR that
-gives more detailed information.
-.TP 
+.SH "SYNOPSIS"
+.HP \w'\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR\ 'u
+\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR \fIdbdir\fR \fIctrlfd\fR \fIclntfd\fR
+.SH "DESCRIPTION"
+.PP
+\fBcnid_dbd\fR
+provides an interface for storage and retrieval of catalog node IDs (CNIDs) and related information to the
+\fBafpd\fR
+daemon\&. CNIDs are a component of Macintosh based file systems with semantics that map not easily onto Unix file systems\&. This makes separate storage in a database necessary\&.
+\fBcnid_dbd\fR
+is part of the
+\fBCNID backend\fR
+framework of
+\fBafpd\fR
+and implements the
+\fBdbd\fR
+backend\&.
+.PP
+\fBcnid_dbd\fR
+is never started via the command line or system startup scripts but only by the
+\fBcnid_metad\fR
+daemon\&. There is at most one instance of
+\fBcnid_dbd\fR
+per netatalk volume\&.
+.PP
+\fBcnid_dbd\fR
+uses the
+\fBBerkleley DB\fR
+database library and optionally supports transactionally protected updates if the netatalk package is compiled with the appropriate options\&. Using the
+\fBdbd\fR
+backend without transactions will protect the CNID database against unexpected crashes of the
+\fBafpd\fR
+daemon\&. Using the
+\fBdbd\fR
+backend with transactions will avoid corruption of the CNID database even if the system crashes unexpectedly\&.
+.PP
+\fBcnid_dbd\fR
+uses the same on\-disk database format as the
+\fBcdb\fR
+backend\&. It is therefore possible to switch between the two backends as necessary\&.
+.PP
+\fBcnid_dbd\fR
+inherits the effective userid and groupid from
+\fBcnid_metad\fR
+on startup, which is normally caused by
+\fBafpd\fR
+serving a netatalk volume to a client\&. It changes to the
+\fBBerkleley DB\fR
+database home directory
+\fIdbdir\fR
+that is associated with the volume\&. If the userid inherited from
+\fBcnid_metad\fR
+is 0 (root),
+\fBcnid_dbd\fR
+will change userid and groupid to the owner and group of the database home directory\&. Otherwise, it will continue to use the inherited values\&.
+\fBcnid_dbd\fR
+will then attempt to open the database and start serving requests using filedescriptor
+\fIclntfd\fR\&. Subsequent instances of
+\fBafpd\fR
+that want to access the same volume are redirected to the running
+\fBcnid_dbd\fR
+process by
+\fBcnid_metad\fR
+via the filedescriptor
+\fIctrlfd\fR\&.
+.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
+\fBBerkleley DB\fR
+database environments\&. It is safe to terminate
+\fBcnid_dbd\fR
+this way, it will be restarted when necessary\&. Other signals are not handled and will cause an immediate exit, possibly leaving the CNID database in an inconsistent state (no transactions) or losing recent updates during recovery (transactions)\&.
+.PP
+If transactions are used the
+\fBBerkleley DB\fR
+database subsystem will create files named log\&.xxxxxxxxxx in the database home directory
+\fIdbdir\fR, where xxxxxxxxxx is a monotonically increasing integer\&. These files contain information to replay database changes and are not automatically removed, unless the
+\fBlogfile_autoremove\fR
+option is specified in the
+\fIdb_param\fR
+configuration file (see below)\&. Please see the sections
+\fBDatabase and log file archival\fR,
+\fB Log file removal\fR
+and the documentation of the
+\fB db_archive\fR
+command line utility in the Berkeley DB Tutorial and Reference for information when and how it is safe to remove these files manually\&.
+.PP
+Do not use
+\fBcnid_dbd\fR
+for databases on NFS mounted file systems\&. It makes the whole point of securing database changes properly moot\&. Use the dbdir: Option in the appropriate
+\fBAppleVolumes\fR
+configuration file to put the database onto a local disk\&.
+.SH "CONFIGURATION"
+.PP
+\fBcnid_dbd\fR
+reads configuration information from the file
+\fIdb_param\fR
+in the database directory
+\fIdbdir\fR
+on startup\&. If the file does not exist or a parameter is not listed, suitable default values are used\&. The format for a single parameter is the parameter name, followed by one or more spaces, followed by the parameter value, followed by a newline\&. The following parameters are currently recognized:
+.PP
+\fBlogfile_autoremove\fR
+.RS 4
+This flag is ignored unless transactional support is enabled\&. If set to 1, unused Berkeley DB transactional logfiles (log\&.xxxxxxxxxx in the database home directory) are removed on startup of
+\fBcnid_dbd\fR\&. This is usually safe if the content of the database directory is backed up on a regular basis\&. Default: 0\&.
+.RE
+.PP
+\fBcachesize\fR
+.RS 4
+Determines the size of the Berkeley DB cache in kilobytes\&. Default: 1024\&. Each
+\fBcnid_dbd\fR
+process grabs that much memory on top of its normal memory footprint\&. It can be used to tune database performance\&. The
+\fBdb_stat\fR
+utility with the
+\fB\-m\fR
+option that comes with Berkely DB can help you determine wether you need to change this value\&. The default is pretty conservative so that a large percentage of requests should be satisfied from the cache directly\&. If memory is not a bottleneck on your system you might want to leave it at that value\&. The
+\fBBerkeley DB Tutorial and Reference Guide\fR
+has a section
+\fBSelecting a cache size\fR
+that gives more detailed information\&.
+.RE
+.PP
+\fBnosync\fR
+.RS 4
+This flag is ignored unless transactional support is enabled\&. If it is set to 1, transactional changes to the database are not synchronously written to disk when the transaction completes\&. This will increase performance considerably at the risk of recent changes getting lost in case of a crash\&. The database will still be consistent, though\&. See
+\fBTransaction Throughput\fR
+in the Berkeley DB Tutorial for more information\&. Default: 0\&.
+.RE
+.PP
+\fBflush_frequency\fR, \fBflush_interval\fR
+.RS 4
+\fIflush_frequency\fR
+(Default: 100) and
+\fIflush_interval\fR
+(Default: 30) control how often changes to the database are written to the underlying database files if no transactions are used or how often the transaction system is checkpointed for transactions\&. Both of these operations are performed if either i) more than
+\fIflush_frequency\fR
+requests have been received or ii) more than
+\fIflush_interval\fR
+seconds have elapsed since the last save/checkpoint\&. If you use transactions with
+\fInosync\fR
+set to zero these parameters only influence how long recovery takes after a crash, there should never be any lost data\&. If
 \fInosync\fR
-This flag is ignored unless transactional support is enabled.
-If it is set to 1, transactional changes to the database are not
-synchronously written to disk when the transaction completes. This
-will increase performance considerably at the risk of recent changes
-getting lost in case of a crash. The database will still be
-consistent, though. See \fITransaction
-Throughput\fR in the Berkeley DB Tutorial for more
-information. Default: 0.
-.TP 
-\fIflush_frequency\fR, \fIflush_interval\fR
-\fIflush_frequency\fR (Default: 100)
-and \fIflush_interval\fR (Default: 30)
-control how often changes to the database are written to the
-underlying database files if no transactions are used or how often
-the transaction system is checkpointed for transactions. Both of
-these operations are performed if either i) more than \fIflush_frequency\fR requests have been received or
-ii) more than \fIflush_interval\fR seconds
-have elapsed since the last save/checkpoint. If you use transactions
-with \fInosync\fR set to zero these
-parameters only influence how long recovery takes after a crash,
-there should never be any lost data. If \fInosync\fR is 1, changes might be lost, but only
-since the last checkpoint. Be careful to check your harddisk
-configuration for on disk cache settings. Many IDE disks just cache
-writes as the default behaviour, so even flushing database files to
-disk will not have the desired effect.
-.TP 
-\fIfd_table_size\fR
-is the maximum number of connections (filedescriptors) that
-can be open for \fIafpd\fR client processes
-in \fIcnid_dbd.\fR Default: 16. If this
-number is exceeded, one of the existing connections is closed and
-reused. The affected \fIafpd\fR process
-will transparently reconnect later, which causes slight overhead. On
-the other hand, setting this parameter too high could affect
-performance in cnid_dbd since all descriptors
-have to be checked in a select() system call,
-or worse, you might exceed the per process limit of open file
-descriptors on your system. It is safe to set the value to 1 on
-volumes where only one \fIafpd\fR client
-process is expected to run, e.g. home directories.
-.TP 
-\fIidle_timeout\fR
+is 1, changes might be lost, but only since the last checkpoint\&. Be careful to check your harddisk configuration for on disk cache settings\&. Many IDE disks just cache writes as the default behaviour, so even flushing database files to disk will not have the desired effect\&.
+.RE
+.PP
+\fBfd_table_size\fR
+.RS 4
+is the maximum number of connections (filedescriptors) that can be open for
+\fBafpd\fR
+client processes in
+\fBcnid_dbd\&.\fR
+Default: 16\&. If this number is exceeded, one of the existing connections is closed and reused\&. The affected
+\fBafpd\fR
+process will transparently reconnect later, which causes slight overhead\&. On the other hand, setting this parameter too high could affect performance in
+\fBcnid_dbd\fR
+since all descriptors have to be checked in a
+\fBselect()\fR
+system call, or worse, you might exceed the per process limit of open file descriptors on your system\&. It is safe to set the value to 1 on volumes where only one
+\fBafpd\fR
+client process is expected to run, e\&.g\&. home directories\&.
+.RE
+.PP
+\fBidle_timeout\fR
+.RS 4
 is the number of seconds of inactivity before an idle
-cnid_dbd exits. Default: 600. Set this to 0 to
-disable the timeout.
-.TP 
-\fIcheck\fR
-is a flag value. If set cnid_dbd will 
-automatically check the database indexes. Default: 0. Set this 
-to 1 to enable checking. 
+\fBcnid_dbd\fR
+exits\&. Default: 600\&. Set this to 0 to disable the timeout\&.
+.RE
+.PP
+\fBcheck\fR
+.RS 4
+is a flag value\&. If set
+\fBcnid_dbd\fR
+will automatically check the database indexes\&. Default: 0\&. Set this to 1 to enable checking\&.
+.RE
 .SH "SEE ALSO"
-\fBcnid_metad\fR(8), \fBafpd\fR(8)
-
+.PP
+\fBcnid_metad\fR(8),
+\fBafpd\fR(8)
index e2009e3deed5e5294d1870d5502480ce6d718874..e112f23ef74263dd676e3797908f6af968248673 100644 (file)
-.TH cnid_metad 8 "28 Nov 2003" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: cnid_metad
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 23 Apr 2009
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "CNID_METAD" "8" "23 Apr 2009" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * 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\ 'u
+\fBcnid_metad\fR\fB\fR [\-d] [\-h\ \fIhostname\fR] [\-p\ \fIport\fR] [\-u\ \fIuser\fR] [\-g\ \fIgroup\fR] [\-s\ \fIcnid_dbdpathname\fR]
+.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\-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\&.
+.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 
+.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\-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 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
+.SH "CAVEATS"
 .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.
+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)
-
index 53c47269965fea416820d69246a04e92e397410a..9cdaeaa7b684ada0ced2ec00478be0981598e4e0 100644 (file)
-.\" t
-.TH papd 8 "06 September 2004" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: papd
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 06 September 2004
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "PAPD" "8" "06 September 2004" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 papd \- AppleTalk print server daemon
-.SH SYNOPSIS
-\fBpapd\fR [\-d] [\-f configfile] [\-p printcap]
-.SH DESCRIPTION
-papd is the AppleTalk printer daemon. This daemon
-accepts print jobs from AppleTalk clients (typically Macintosh computers)
-using the Printer Access Protocol (PAP). When used with System V printing
-systems, papd spools jobs directly into an
-\fBlpd\fR(8) spool directory and wakes up lpd
-after accepting a job from the network to have it re\-examine the
-appropriate spool directory. The actual printing and spooling is handled
-entirely by lpd.
-.PP
-papd can also pipe the print job to an external
-program for processing, and this is the preferred method on systems not
-using CUPS to avoid compatibility problems with all the flavours of
-lpd in use.
-.PP
-As of version 2.0, CUPS is also supported. Simply using \fIcupsautoadd\fR as first papd.conf entry will share all
-CUPS printers automagically using the PPD files configured in CUPS. It ist
-still possible to overwrite these defaults by individually define printer
-shares. See \fBpapd.conf\fR(5) for details.
-.PP
-papd is typically started at boot time, out of
-system init scripts. It first reads from its configuration file,
-\fB:ETCDIR:/papd.conf\fR. The file is in the same format as
-\fB/etc/printcap\fR. See \fBprintcap\fR(5) for details. The name of the entry is registered with
-NBP.
-.PP
-The following options are supported: 
+.SH "SYNOPSIS"
+.HP \w'\fBpapd\fR\fB\fR\fB\fR\ 'u
+\fBpapd\fR\fB\fR\fB\fR [\-d] [\-f\ configfile] [\-p\ printcap]
+.SH "DESCRIPTION"
+.PP
+\fBpapd\fR
+is the AppleTalk printer daemon\&. This daemon accepts print jobs from AppleTalk clients (typically Macintosh computers) using the Printer Access Protocol (PAP)\&. When used with System V printing systems,
+\fBpapd\fR
+spools jobs directly into an
+\fBlpd\fR(8)
+spool directory and wakes up
+\fBlpd\fR
+after accepting a job from the network to have it re\-examine the appropriate spool directory\&. The actual printing and spooling is handled entirely by
+\fBlpd\fR\&.
+.PP
+\fBpapd\fR
+can also pipe the print job to an external program for processing, and this is the preferred method on systems not using CUPS to avoid compatibility problems with all the flavours of
+\fBlpd\fR
+in use\&.
+.PP
+As of version 2\&.0, CUPS is also supported\&. Simply using
+\fBcupsautoadd\fR
+as first papd\&.conf entry will share all CUPS printers automagically using the PPD files configured in CUPS\&. It ist still possible to overwrite these defaults by individually define printer shares\&. See
+\fBpapd.conf\fR(5)
+for details\&.
+.PP
+\fBpapd\fR
+is typically started at boot time, out of system init scripts\&. It first reads from its configuration file,
+:ETCDIR:/papd\&.conf\&. The file is in the same format as
+/etc/printcap\&. See
+\fBprintcap\fR(5)
+for details\&. The name of the entry is registered with NBP\&.
+.PP
+The following options are supported:
 .TS
-c c c l.
+tab(:);
+cB cB cB nB.
 T{
 Name
-T}     T{
+T}:T{
 Type
-T}     T{
+T}:T{
 Default
-T}     T{
+T}:T{
 Description
 T}
 .T&
+c l l l
+c l l l
+c l l l
+c l l l
+c l l l
+c l l l
+c l l l
+c l l l
+c l l l
 c l l l.
 T{
 pd
-T}     T{
+T}:T{
 str
-T}     T{
-\&'.ppd'
-T}     T{
+T}:T{
+\'\&.ppd\'
+T}:T{
 Pathname to PPD file
 T}
 T{
 pr
-T}     T{
+T}:T{
 str
-T}     T{
-\&'lp'
-T}     T{
+T}:T{
+\'lp\'
+T}:T{
 LPD or CUPS printer name (or pipe to a print
-command)
+              command)
 T}
 T{
 op
-T}     T{
+T}:T{
 str
-T}     T{
-\&'operator'
-T}     T{
+T}:T{
+\'operator\'
+T}:T{
 Operator name for LPD spooling
 T}
 T{
 au
-T}     T{
+T}:T{
 bool
-T}     T{
+T}:T{
 false
-T}     T{
+T}:T{
 Whether to do authenticated printing or not
 T}
 T{
 ca
-T}     T{
+T}:T{
 str
-T}     T{
+T}:T{
 NULL
-T}     T{
+T}:T{
 Pathname used for CAP\-style authentification
 T}
 T{
 sp
-T}     T{
+T}:T{
 bool
-T}     T{
+T}:T{
 false
-T}     T{
+T}:T{
 PSSP\-style authetication
 T}
 T{
 am
-T}     T{
+T}:T{
 str
-T}     T{
+T}:T{
 NULL
-T}     T{
+T}:T{
 UAMS to use for authentication
 T}
 T{
 pa
-T}     T{
+T}:T{
 str
-T}     T{
+T}:T{
 NULL
-T}     T{
-Printer's AppleTalk address
+T}:T{
+Printer\'s AppleTalk address
 T}
 T{
 co
-T}     T{
+T}:T{
 str
-T}     T{
+T}:T{
 NULL
-T}     T{
+T}:T{
 CUPS options as supplied to the \fBlp\fR(1) command with "\-o"
 T}
 T{
 fo
-T}     T{
+T}:T{
 bool
-T}     T{
+T}:T{
 false
-T}     T{
+T}:T{
 adjust lineending for foomatic\-rip
 T}
 .TE
-If no configuration file is given, the hostname of the
-machine is used as the NBP name and all options take their default
-value.
-.SH OPTIONS
-.TP 
+.sp 1
+If no configuration file is given, the hostname of the machine is used as the NBP name and all options take their default value\&.
+.SH "OPTIONS"
+.PP
 \-d
-Do not fork or disassociate from the terminal. Write some
-debugging information to stderr.
-.TP 
+.RS 4
+Do not fork or disassociate from the terminal\&. Write some debugging information to stderr\&.
+.RE
+.PP
 \-f \fIconfigfile\fR
-Consult \fIconfigfile\fR instead of
-\fB:ETCDIR:/papd.conf\fR for the configuration
-information.
-.TP 
+.RS 4
+Consult
+\fIconfigfile\fR
+instead of
+:ETCDIR:/papd\&.conf
+for the configuration information\&.
+.RE
+.PP
 \-p \fIprintcap\fR
-Consult \fIprintcap\fR instead of
-\fB/etc/printcap\fR for LPD configuration
-information.
-.SH NOTES
-PSSP (Print Server Security Protocol) is an authentication
-protocol carried out through postscript printer queries to the print
-server. Using PSSP requires LaserWriter 8.6.1 or greater on the client
-mac. The user will be prompted to enter their username and password before
-they print. It may be necessary to re\-setup the printer on each client the
-first time PSSP is enabled, so that the client can figure out that
-authentication is required to print. You can enable PSSP on a per\-printer
-basis. PSSP is the recommended method of authenticating printers as it is
-more robust than CAP\-style authentication, described below.
-.PP
-CAP\-style authentication gets its name from the method the CAP (Columbia APpletalk)
-package used to authenticate its mac clients' printing. This method
-requires that a user login to a file share before they print.
-afpd records the username in a temporary file named
-after the client's Appletalk address, and it deletes the temporary file
-when the user disconnects. Therefore CAP style authentification will
-\fInot\fR work for clients connected to
-afpd via TCP/IP. papd gets the
-username from the file with the same Appletalk address as the machine
-connecting to it. CAP\-style authentication will work with any mac client.
-If both CAP and PSSP are enabled for a particular printer, CAP will be
-tried first, then papd will fall back to PSSP.
-.PP
-The list of UAMs to use for authentication (specified with the 'am' option)
-applies to all printers. It is not possible to define different
-authentication methods on each printer. You can specify the list of UAMS
-multiple times, but only the last setting will be used. Currently only
-uams_guest.so and uams_clrtxt.so are supported as printer authentication
-methods. The guest method requires a valid username, but not a password.
-The Cleartext UAM requires both a valid username and the correct
-password.
-.RS 
+.RS 4
+Consult
+\fIprintcap\fR
+instead of
+/etc/printcap
+for LPD configuration information\&.
+.RE
+.SH "NOTES"
+.PP
+PSSP
+(Print Server Security Protocol) is an authentication protocol
+carried out through postscript printer queries to the print server\&. Using PSSP requires LaserWriter 8\&.6\&.1 or greater on the client mac\&. The user will be prompted to enter their username and password before they print\&. It may be necessary to re\-setup the printer on each client the first time PSSP is enabled, so that the client can figure out that authentication is required to print\&. You can enable PSSP on a per\-printer basis\&. PSSP is the recommended method of authenticating printers as it is more robust than CAP\-style authentication, described below\&.
+.PP
+CAP\-style authentication
+gets its name from the method the CAP (Columbia APpletalk) package used to authenticate its mac clients\' printing\&. This method requires that a user login to a file share before they print\&.
+\fBafpd\fR
+records the username in a temporary file named after the client\'s Appletalk address, and it deletes the temporary file when the user disconnects\&. Therefore CAP style authentification will
+\fInot\fR
+work for clients connected to
+\fBafpd\fR
+via TCP/IP\&.
+\fBpapd\fR
+gets the username from the file with the same Appletalk address as the machine connecting to it\&. CAP\-style authentication will work with any mac client\&. If both CAP and PSSP are enabled for a particular printer, CAP will be tried first, then
+\fBpapd\fR
+will fall back to PSSP\&.
+.PP
+The list of UAMs to use for authentication (specified with the \'am\' option) applies to all printers\&. It is not possible to define different authentication methods on each printer\&. You can specify the list of UAMS multiple times, but only the last setting will be used\&. Currently only uams_guest\&.so and uams_clrtxt\&.so are supported as printer authentication methods\&. The guest method requires a valid username, but not a password\&. The Cleartext UAM requires both a valid username and the correct password\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
 \fBNote\fR
+.ps -1
+.br
+.PP
+As of this writing, Mac OS X makes no use of PSSP authentication any longer\&. CAP\-style authentication normally won\'t be an option, too caused by the use of AFP over TCP these days\&.
+.sp .5v
+.RE
+.PP
+.SH "FILES"
+.PP
+:ETCDIR:/papd\&.conf
+.RS 4
+Default configuration file\&.
+.RE
 .PP
-As of this writing, Mac OS X makes no use of PSSP authentication
-any longer. CAP\-style authentication normally won't be an option, too
-caused by the use of AFP over TCP these days.
+/etc/printcap
+.RS 4
+Printer capabilities database\&.
 .RE
 .PP
-.SH FILES
-.TP 
-\fB:ETCDIR:/papd.conf\fR
-Default configuration file.
-.TP 
-\fB/etc/printcap\fR
-Printer capabilities database.
-.TP 
-\fB\&.ppd\fR
-PostScript Printer Description file. papd answers
-configuration and font queries from printing clients by consulting
-the configured PPD file. Such files are available for download from
-Adobe, Inc. (http://www.adobe.com/support/downloads/main.htm),
-or from the printer's manufacturer. If no PPD file is configured,
-papd will return the default answer, possibly causing the client to
-send excessively large jobs.
-.SH CAVEATS
-papd accepts characters with the high bit set (a
-full 8\-bits) from the clients, but some PostScript printers (including
-Apple Computer's LaserWriter family) only accept 7\-bit characters on their
-serial interface by default. The same applies for some printers when
-they're accessed via TCP/IP methods (remote LPR or socket). You will need
-to configure your printer to accept a full 8 bits or take special
-precautions and convert the printjob's encoding (eg. by using \fIco="protocol=BCP"\fR when using CUPS 1.1.19 or
-above).
-.PP
-When printing clients run MacOS 10.2 or above, take care that PPDs
-do not make use of \fI*cupsFilter:\fR comments
-unless the appropriate filters are installed at the client's side, too
-(remember: Starting with 10.2 Apple chose to integrate CUPS into MacOS X).
-For in\-depth information on how CUPS uses PPDs see chapter 3.4 in http://tinyurl.com/zbxn).
+\&.ppd
+.RS 4
+PostScript Printer Description file\&. papd answers configuration and font queries from printing clients by consulting the configured PPD file\&. Such files are available for download from Adobe, Inc\&. (\m[blue]\fBhttp://www\&.adobe\&.com/support/downloads/main\&.htm\fR\m[]\&\s-2\u[1]\d\s+2), or from the printer\'s manufacturer\&. If no PPD file is configured, papd will return the default answer, possibly causing the client to send excessively large jobs\&.
+.RE
+.SH "CAVEATS"
+.PP
+\fBpapd\fR
+accepts characters with the high bit set (a full 8\-bits) from the clients, but some PostScript printers (including Apple Computer\'s LaserWriter family) only accept 7\-bit characters on their serial interface by default\&. The same applies for some printers when they\'re accessed via TCP/IP methods (remote LPR or socket)\&. You will need to configure your printer to accept a full 8 bits or take special precautions and convert the printjob\'s encoding (eg\&. by using
+\fBco="protocol=BCP"\fR
+when using CUPS 1\&.1\&.19 or above)\&.
+.PP
+When printing clients run MacOS 10\&.2 or above, take care that PPDs do not make use of
+\fB*cupsFilter:\fR
+comments unless the appropriate filters are installed at the client\'s side, too (remember: Starting with 10\&.2 Apple chose to integrate CUPS into MacOS X)\&. For in\-depth information on how CUPS uses PPDs see chapter 3\&.4 in
+\m[blue]\fB http://tinyurl\&.com/zbxn\fR\m[]\&\s-2\u[2]\d\s+2)\&.
 .SH "SEE ALSO"
-\fBlpr\fR(1),\fBlprm\fR(1),\fBprintcap\fR(5),\fBlpc\fR(8),\fBlpd\fR(8), \fBlp\fR(1).
-
+.PP
+\fBlpr\fR(1),\fBlprm\fR(1),\fBprintcap\fR(5),\fBlpc\fR(8),\fBlpd\fR(8),
+\fBlp\fR(1)\&.
+.SH "NOTES"
+.IP " 1." 4
+http://www.adobe.com/support/downloads/main.htm
+.RS 4
+\%http://www.adobe.com/support/downloads/main.html#Printer
+.RE
+.IP " 2." 4
+http://tinyurl.com/zbxn
+.RS 4
+\%http://tinyurl.com/zbxn
+.RE
index db06bf5412c32d1c6e44f70af10eaffa6f512e4e..89db3672939c3dac7ebd10ae6e6db7d52ad815d4 100644 (file)
@@ -1,46 +1,94 @@
-.TH papstatus 8 "17 Dec 1991" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: papstatus
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 17 Dec 1991
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "PAPSTATUS" "8" "17 Dec 1991" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 papstatus \- get the status of an AppleTalk\-connected printer
-.SH SYNOPSIS
-\fB:SBINDIR:/papstatus\fR [\-d] [ \-p \fBprinter\fR ] [\fBretrytime\fR]
-.SH DESCRIPTION
-\fIpapstatus\fR is used to obtain the
-current status message from an AppleTalk connected printer. It uses the
-Printer Access Protocol (PAP) to obtain the status information.
+.SH "SYNOPSIS"
+.HP \w'\fB:SBINDIR:/papstatus\fR\fB\fR\ 'u
+\fB:SBINDIR:/papstatus\fR\fB\fR [\-d] [\-p\ \fIprinter\fR] [\fIretrytime\fR]
+.SH "DESCRIPTION"
+.PP
+\fBpapstatus\fR
+is used to obtain the current status message from an AppleTalk connected printer\&. It uses the Printer Access Protocol (PAP) to obtain the status information\&.
+.PP
+If no printer is specified on the command line,
+\fBpapstatus\fR
+looks for a file called
+\fB\&.paprc\fR
+in the current directory and reads it to obtain the name of a printer\&. The
+\fB\&.paprc\fR
+file should contain a single line of the form
+\fIobject\fR\fB:\fR\fItype\fR\fB@\fR\fIzone\fR
+where each of
+\fIobject\fR,
+\fB:\fR\fItype\fR\fB,\fR
+and
+\fB@\fR\fIzone\fR
+are optional\&.
+\fItype\fR
+and
+\fIzone\fR
+must be proceeded by `\fB:\fR\' and `\fB@\fR\' respectively\&. Blank lines and lines the begin with a `\fB#\fR\' are ignored\&.
+\fItype\fR
+and
+\fIzone\fR
+default to
+\fBLaserWriter\fR
+and the zone of the local host, respectively\&.
+.SH "OPTIONS"
 .PP
-If no printer is specified on the command line, \fIpapstatus\fR
-looks for a file called .paprc in the current directory
-and reads it to obtain the name of a printer. The .paprc
-file should contain a single line of the form \fIobject\fR\fI:\fR\fI\fR\fItype\fR\fI@\fR\fI\fR\fIzone\fR
-where each of \fIobject\fR, \fI:\fR\fItype\fR\fI,\fR and \fI@\fR\fIzone\fR are optional.
-\fItype\fR and \fIzone\fR
-must be proceeded by `\fI:\fR' and `\fI@\fR' respectively. Blank lines and lines the begin
-with a `\fI#\fR' are ignored. \fItype\fR and \fIzone\fR default
-to \fILaserWriter\fR and the zone of the local
-host, respectively.
-.SH OPTIONS
-.TP 
 \fB\-d\fR
-Turns on a debugging mode that prints some extra information
-to standard error.
-.TP 
+.RS 4
+Turns on a debugging mode that prints some extra information to standard error\&.
+.RE
+.PP
 \fB\-p\fR \fIprinter\fR
-Get status from \fIprinter\fR (do not
-consult any .paprc files to find a printer name).
-The syntax for \fIprinter\fR is the same as
-discussed above for the .paprc file.
-.TP 
+.RS 4
+Get status from
+\fIprinter\fR
+(do not consult any
+\fB\&.paprc\fR
+files to find a printer name)\&. The syntax for
+\fIprinter\fR
+is the same as discussed above for the
+\fB\&.paprc\fR
+file\&.
+.RE
+.PP
+\fIretrytime\fR
+.RS 4
+Normally,
+\fBpapstatus\fR
+only gets the status from the printer once\&. If
 \fIretrytime\fR
-Normally, \fIpapstatus\fR only gets
-the status from the printer once. If \fIretrytime\fR
 is specified, the status is obtained repeatedly, with a sleep of
-\fIretrytime\fR seconds between inquiring
-the printer.
-.SH FILES
-.TP 
-\&.paprc
+\fIretrytime\fR
+seconds between inquiring the printer\&.
+.RE
+.SH "FILES"
+.PP
+\fB\&.paprc\fR
+.RS 4
 file that contains printer name
+.RE
 .SH "SEE ALSO"
+.PP
 \fBnbp\fR(1),
 \fBpap\fR(1)
-
index b5f9fe904dd361a4fc7eae945fb95037c3d58863..757ff3ffc5f917678ed77a0d26d40832490e33fa 100644 (file)
-.TH psf 8 "17 Dec 1991" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: psf
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 17 Dec 1991
+.\"    Manual: Netatalk 2.0.4
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "PSF" "8" "17 Dec 1991" "Netatalk 2\&.0\&.4" "Netatalk 2.0.4"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 psf \- PostScript filter
-.SH SYNOPSIS
-\fBpsf\fR [ \-n \fBname\fR ] [ \-h \fBhost\fR ] [ \-w \fBwidth\fR ] [ \-l \fBlength\fR ] [ \-i \fBindent\fR ] [\-c]
-.SH DESCRIPTION
-psf is an \fIlpd\fR
-filter for PostScript printing. psf interprets the name
-it was called with to determine what filters to invoke. First, if the
-string ``pap'' appears anywhere in the name, psf
-invokes \fIpap\fR to talk to a printer via
-AppleTalk. Next, if the string ``rev'' appears,
-psf invokes \fIpsorder\fR to
-reverse the pages of the job. Finally, if psf was
-called with a filter's name as the leading string, it invokes that
-filter. If there is no filter to run, psf examines the
-magic number of the input, and if the input is not PostScript, converts it
-to PostScript.
-.SH KLUDGE
-In the default configuration, psf supports two
-kludges. The first causes psf to check its name for the
-letter `m'. If this letter is found and accounting is turned on,
-psf calls \fIpap\fR twice,
-once to get an initial page count and to print the job, and another time
-to get a final page count. This is a work\-around for bugs in a variety of
-PAP implementions that cause printers to never properly close the PAP
-output file. A notable example is any printer by Hewlett\-Packard.
+.SH "SYNOPSIS"
+.HP \w'\fBpsf\fR\fB\fR\ 'u
+\fBpsf\fR\fB\fR [\-n\ \fIname\fR] [\-h\ \fIhost\fR] [\-w\ \fIwidth\fR] [\-l\ \fIlength\fR] [\-i\ \fIindent\fR] [\-c]
+.SH "DESCRIPTION"
 .PP
-The second kludge causes psf to examine its name
-for the letter `w'. If this letter is found and accounting is turned
-on, psf calls \fIpap\fR with
-the \fB\-w\fR flag. This flag causes \fIpap\fR
-to wait until the printer's status contains the string `idle'.
-Once this string is found, the job is printed as normal. This kludge is a
-work\-around for printers, notably Hewlett\-Packard's LaserJet IV, which
-will report a page count while a previous jobs is still printing.
-.SH EXAMPLE
-The sample \fIprintcap\fR entry below
-invokes psf to print text files, PostScript files,
-\fItroff\fR's C/A/T output, and \fITeX\fR's DVI output, to an AppleTalk connected
-LaserWriter Plus. Since the LaserWriter Plus stacks pages in descending
-order, we reverse the pages and print the burst page last.
+\fBpsf\fR
+is an
+\fBlpd\fR
+filter for PostScript printing\&.
+\fBpsf\fR
+interprets the name it was called with to determine what filters to invoke\&. First, if the string ``pap\'\' appears anywhere in the name,
+\fBpsf\fR
+invokes
+\fBpap\fR
+to talk to a printer via AppleTalk\&. Next, if the string ``rev\'\' appears,
+\fBpsf\fR
+invokes
+\fBpsorder\fR
+to reverse the pages of the job\&. Finally, if
+\fBpsf\fR
+was called with a filter\'s name as the leading string, it invokes that filter\&. If there is no filter to run,
+\fBpsf\fR
+examines the magic number of the input, and if the input is not PostScript, converts it to PostScript\&.
+.SH "KLUDGE"
 .PP
+In the default configuration,
+\fBpsf\fR
+supports two kludges\&. The first causes
+\fBpsf\fR
+to check its name for the letter `m\'\&. If this letter is found and accounting is turned on,
+\fBpsf\fR
+calls
+\fBpap\fR
+twice, once to get an initial page count and to print the job, and another time to get a final page count\&. This is a work\-around for bugs in a variety of PAP implementions that cause printers to never properly close the PAP output file\&. A notable example is any printer by Hewlett\-Packard\&.
+.PP
+The second kludge causes
+\fBpsf\fR
+to examine its name for the letter `w\'\&. If this letter is found and accounting is turned on,
+\fBpsf\fR
+calls
+\fBpap\fR
+with the
+\fB\-w\fR
+flag\&. This flag causes
+\fBpap\fR
+to wait until the printer\'s status contains the string `idle\'\&. Once this string is found, the job is printed as normal\&. This kludge is a work\-around for printers, notably Hewlett\-Packard\'s LaserJet IV, which will report a page count while a previous jobs is still printing\&.
+.SH "EXAMPLE"
+.PP
+The sample
+\fBprintcap\fR
+entry below invokes
+\fBpsf\fR
+to print text files, PostScript files,
+\fBtroff\fR\'s C/A/T output, and
+\fBTeX\fR\'s DVI output, to an AppleTalk connected LaserWriter Plus\&. Since the LaserWriter Plus stacks pages in descending order, we reverse the pages and print the burst page last\&.
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
-
-laser|lp|LaserWriter Plus on AppleTalk:\\
-    :sd=/usr/spool/lpd/laser:\\
-    :lp=/usr/spool/lpd/laser/null:\\
-    :lf=/var/adm/lpd\-errs:pw#80:hl:\\
-    :of=:LIBEXECDIR:/ofpap:\\
-    :if=:LIBEXECDIR:/ifpaprev:\\
-    :tf=:LIBEXECDIR:/tfpaprev:\\
+laser|lp|LaserWriter Plus on AppleTalk:\e
+    :sd=/usr/spool/lpd/laser:\e
+    :lp=/usr/spool/lpd/laser/null:\e
+    :lf=/var/adm/lpd\-errs:pw#80:hl:\e
+    :of=:LIBEXECDIR:/ofpap:\e
+    :if=:LIBEXECDIR:/ifpaprev:\e
+    :tf=:LIBEXECDIR:/tfpaprev:\e
     :df=:LIBEXECDIR:/dfpaprev:
 .fi
+.if n \{\
+.RE
+.\}
 .PP
-Note that if the host in question spools to more than one AppleTalk
-printer, \fB/dev/null\fR should not be used for the
-\fIlp\fR capability. Instead, a null device
-should be created with \fImknod\fR for each
-printer, as has been done above.
+Note that if the host in question spools to more than one AppleTalk printer,
+/dev/null
+should not be used for the
+\fBlp\fR
+capability\&. Instead, a null device should be created with
+\fBmknod\fR
+for each printer, as has been done above\&.
 .PP
 Finally, there is a file in the spool directory,
-\fB/var/spool/lpd/laser\fR, called .paprc,
-which \fIpap\fR reads for the AppleTalk name of
-the printer.
+/var/spool/lpd/laser, called
+\fB\&.paprc\fR, which
+\fBpap\fR
+reads for the AppleTalk name of the printer\&.
 .SH "SEE ALSO"
+.PP
 \fBpsorder\fR(1),
 \fBprintcap\fR(5),
 \fBlpd\fR(1),
 \fBmknod\fR(1),
-\fBpap\fR(1).
-
+\fBpap\fR(1)\&.
index 6cf2b54e6fa62dc79d1f840685db1021f7ecc7b2..8888b11afd0becb88d15cd8cbb3beb9baf51ac0b 100644 (file)
@@ -1,19 +1,45 @@
-.TH timelord 8 "27 Jun 2001" 2.0.3 Netatalk 
-.SH NAME
+'\" t
+.\"     Title: timelord
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 27 Jun 2001
+.\"    Manual: The Netatalk Project
+.\"    Source: Netatalk 2.0.4
+.\"  Language: English
+.\"
+.TH "TIMELORD" "8" "27 Jun 2001" "Netatalk 2\&.0\&.4" "The Netatalk Project"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
 timelord \- Macintosh time server daemon
-.SH SYNOPSIS
-.SH SYNTAX
-timelord [\-d] [\-n \fIfilename\fR]
-.SH DESCRIPTION
-\fItimelord\fR is a simple time server for
-Macintosh computers that use the \fItardis\fR
-client.
-.SH OPTIONS
-.TP 
+.SH "SYNOPSIS"
+.SH "SYNTAX"
+.PP
+timelord [\-d] [\-n
+\fIfilename\fR]
+.SH "DESCRIPTION"
+.PP
+\fBtimelord\fR
+is a simple time server for Macintosh computers that use the
+\fBtardis\fR
+client\&.
+.SH "OPTIONS"
+.PP
 \fB\-d\fR
-Debug mode, i.e. don't disassociate from controlling
-TTY.
-.TP 
+.RS 4
+Debug mode, i\&.e\&. don\'t disassociate from controlling TTY\&.
+.RE
+.PP
 \fB\-n\fR \fInbpname\fR
-Register this server as \fInbpname\fR. This defaults to the hostname.
-
+.RS 4
+Register this server as
+\fInbpname\fR\&. This defaults to the hostname\&.
+.RE