From 0936b000599ade5a9be623cea527f4c4e26d1845 Mon Sep 17 00:00:00 2001 From: franklahm Date: Mon, 29 Mar 2010 20:24:27 +0000 Subject: [PATCH] Doc for new AFP signature stuff, from HAT --- NEWS | 5 ++ man/man5/AppleVolumes.default.5.tmpl | 22 ++++---- man/man5/Makefile.am | 4 +- man/man5/afp_signature.conf.5.tmpl | 79 ++++++++++++++++++++++++++++ man/man5/afpd.conf.5.tmpl | 31 ++++++----- man/man5/netatalk.conf.5.tmpl | 8 +-- man/man8/afpd.8.tmpl | 16 ++++-- 7 files changed, 127 insertions(+), 38 deletions(-) create mode 100644 man/man5/afp_signature.conf.5.tmpl diff --git a/NEWS b/NEWS index fa352af4..2d0f7799 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,8 @@ +Changes in 2.1-beta2 +==================== +* NEW: afpd: static generated AFP signature stored in afp_signature.conf, + cf man 5 afp_signature.conf + Changes in 2.1-beta1 ==================== diff --git a/man/man5/AppleVolumes.default.5.tmpl b/man/man5/AppleVolumes.default.5.tmpl index 899bdb70..2e8e9bc9 100644 --- a/man/man5/AppleVolumes.default.5.tmpl +++ b/man/man5/AppleVolumes.default.5.tmpl @@ -3,11 +3,11 @@ .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.74.3 .\" Date: 23 Dec 2009 -.\" Manual: Netatalk 2.1 -.\" Source: Netatalk 2.1 +.\" Manual: Netatalk 2.1beta2 +.\" Source: Netatalk 2.1beta2 .\" Language: English .\" -.TH "APPLEVOLUMES\&.DEFAU" "5" "23 Dec 2009" "Netatalk 2.1" "Netatalk 2.1" +.TH "APPLEVOLUMES\&.DEFAU" "5" "23 Dec 2009" "Netatalk 2.1beta2" "Netatalk 2.1beta2" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -32,9 +32,9 @@ path .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 +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 cannot contain the \':\' -character\&. +character\&. The volume name is mangled if it is very long\&. Mac codepage volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to \-volnamelen parameter in afpd\&.conf .if n \{\ .sp .\} @@ -61,7 +61,7 @@ The possible options and their meanings are: .PP adouble:\fI[v1|v2|osx]\fR .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 +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 10\&.3\&.x uses, is also supported\&. .if n \{\ .sp .\} @@ -74,11 +74,9 @@ Specify the format of the metadata files, which are used for saving Mac resource \fBNote\fR .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 +\fBcannot\fR +be treated normally any longer\&. Its only aim was 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\&. AppleDouble file of Mac OS X 10\&.6 is incompatible to V1 and V2\&. .sp .5v .RE .RE @@ -383,8 +381,6 @@ $$ prints dollar sign ($) .RE .PP -When using variable substitution in the volume name, always keep in mind, not to exceed the 27 characters limit -.PP \fBExample.\ \&Using variable substitution when defining volumes\fR .PP .if n \{\ @@ -620,7 +616,7 @@ don\'t stat volume path when enumerating volumes list, useful for automounting o .PP prodos .RS 4 -Provides compatibility with Apple II clients\&. +Provides compatibility with Apple II clients\&. (legacy) .RE .RE .SH "SEE ALSO" diff --git a/man/man5/Makefile.am b/man/man5/Makefile.am index 07e2dee3..6e082fca 100644 --- a/man/man5/Makefile.am +++ b/man/man5/Makefile.am @@ -15,11 +15,11 @@ SUFFIXES = .tmpl . man_MANS = AppleVolumes.default.5 afpd.conf.5 \ atalkd.conf.5 netatalk.conf.5 papd.conf.5 \ - afp_ldap.conf.5 + afp_ldap.conf.5 afp_signature.conf.5 TEMPLATE_FILES = AppleVolumes.default.5.tmpl afpd.conf.5.tmpl \ atalkd.conf.5.tmpl netatalk.conf.5.tmpl papd.conf.5.tmpl \ - afp_ldap.conf.5.tmpl + afp_ldap.conf.5.tmpl afp_signature.conf.5.tmpl CLEANFILES = $(man_MANS) diff --git a/man/man5/afp_signature.conf.5.tmpl b/man/man5/afp_signature.conf.5.tmpl new file mode 100644 index 00000000..587c9149 --- /dev/null +++ b/man/man5/afp_signature.conf.5.tmpl @@ -0,0 +1,79 @@ +'\" t +.\" Title: afp_signature.conf +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.74.3 +.\" Date: 29 March 2010 +.\" Manual: Netatalk 2.1beta2 +.\" Source: Netatalk 2.1beta2 +.\" Language: English +.\" +.TH "AFP_SIGNATURE\&.CONF" "5" "29 March 2010" "Netatalk 2.1beta2" "Netatalk 2.1beta2" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +afp_signature.conf \- Configuration file used by afpd(8) to specify server signature +.SH "DESCRIPTION" +.PP +:ETCDIR:/afp_signature\&.conf +is the configuration file used by +\fBafpd\fR +to specify server signature automatically\&. The configuration lines are composed like: +.PP +\fI"server name"\fR +\fIhexa\-string\fR +.PP +The first field is server name\&. Server names must be quoted if they contain spaces\&. The second field is the hexadecimal string of 32 characters for 16\-bytes server signature\&. +.PP +The leading spaces and tabs are ignored\&. Blank lines are ignored\&. The lines prefixed with # are ignored\&. The illegal lines are ignored\&. +.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 +Server Signature is unique 16\-bytes identifier used to prevent logging on to the same server twice\&. +.PP +Netatalk 2\&.0 and earlier generated server signature by using gethostid()\&. There was a problem that another servers have the same signature because the hostid is not unique enough\&. +.PP +Netatalk 2\&.1 generates the signature from random numbers and saves it into afp_signature\&.conf\&. When starting next time, it is read from this file\&. +.PP +This file should not be thoughtlessly edited and be copied onto another server\&. If it wants to set the signature intentionally, use the option "\-signature user:xxxx" in afpd\&.conf\&. In this case, afp_signature\&.conf is not used\&. +.sp .5v +.RE +.PP +.SH "EXAMPLES" +.PP +\fBExample.\ \&afp_signature.conf three servers on one netatalk\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# This is a comment\&. +"Guest Server" 251D25569CB29AFDF296C6B5B3A385B7 +"User Server" 26B5D785046C019F55718F76B1C13BFB +special 74A0BB94EC8C13988B2E75042347E528 +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBafpd\fR(8), +\fBafpd.conf\fR(5), +\fBasip-status.pl\fR(1) diff --git a/man/man5/afpd.conf.5.tmpl b/man/man5/afpd.conf.5.tmpl index f08d3598..b56c1f9a 100644 --- a/man/man5/afpd.conf.5.tmpl +++ b/man/man5/afpd.conf.5.tmpl @@ -3,11 +3,11 @@ .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.74.3 .\" Date: 23 December 2009 -.\" Manual: Netatalk 2.1 -.\" Source: Netatalk 2.1 +.\" Manual: Netatalk 2.1beta2 +.\" Source: Netatalk 2.1beta2 .\" Language: English .\" -.TH "AFPD\&.CONF" "5" "23 December 2009" "Netatalk 2.1" "Netatalk 2.1" +.TH "AFPD\&.CONF" "5" "23 December 2009" "Netatalk 2.1beta2" "Netatalk 2.1beta2" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -133,7 +133,7 @@ Use for eg\&. winbind authentication, prepends both strings before the username .RE .SH "CODEPAGE OPTIONS" .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\&. +With OS X Apple introduced the AFP3 protocol\&. One of the big changes was, that AFP3 uses Unicode names encoded as Decomposed UTF\-8 (UTF8\-MAC)\&. Previous AFP/OS versions used codepages like MacRoman, MacCentralEurope, etc\&. .PP To be able to serve AFP3 and older clients at the same time, \fBafpd\fR @@ -145,7 +145,7 @@ 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 +needs to interact with unix operating system as well, it need\'s to be able to convert from UTF8\-MAC/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 @@ -196,23 +196,23 @@ 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\&. +to prevent DDP connections from working\&. (default is \-noddp) .RE .PP \-[no]tcp .RS 4 -Enables or disables AFP\-over\-TCP +Enables or disables AFP\-over\-TCP (default is \-tcp) .RE .PP \-transall .RS 4 -Make both available (default) +Make both available .RE .SH "TRANSPORT OPTIONS" .PP \-advertise_ssh .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 +Allows Mac OS X clients (10\&.3\&.3\-10\&.4) 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 \{\ @@ -342,7 +342,7 @@ With this switch enabled, afpd won\'t advertise that it is capable of server not \fBNote\fR .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\&. +Do not use this option any longer as Netatalk 2\&.x correctly supports server notifications, allowing connected clients to update folder listings in case another client changed the contents\&. .sp .5v .RE .RE @@ -364,7 +364,7 @@ Specifies the user that guests should use (default is "nobody")\&. The name shou .PP \-[no]icon .RS 4 -[Dont\'t] Use the platform\-specific icon +[Dont\'t] Use the platform\-specific icon\&. Recent Mac OS don\'t display it any longer\&. .RE .PP \-loginmesg \fI[message]\fR @@ -386,9 +386,11 @@ AFP 3\&.x waits hours before disconnecting clients in sleep mode\&. Default is 10 hours\&. .RE .PP -\-signature { user: | host } +\-signature { user: | auto } .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 +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\&.)\&. Default is "auto"\&. "auto" signature type allows afpd generating signature and saving it to +:ETCDIR:/afp_signature\&.conf +automatically (based on random number)\&. "host" signature type switches back to "auto" because it is obsoleted\&. "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 @@ -593,4 +595,5 @@ Specify the number of tickles to send before timing out a connection\&. The defa .PP \fBafpd\fR(8), \fBafppasswd\fR(1), -\fBAppleVolumes.default\fR(5) +\fBAppleVolumes.default\fR(5), +\fBafp_signature.conf\fR(5) diff --git a/man/man5/netatalk.conf.5.tmpl b/man/man5/netatalk.conf.5.tmpl index 78d32db7..ad7ad55b 100644 --- a/man/man5/netatalk.conf.5.tmpl +++ b/man/man5/netatalk.conf.5.tmpl @@ -3,11 +3,11 @@ .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.74.3 .\" Date: 9 Jun 2009 -.\" Manual: Netatalk 2.1 -.\" Source: Netatalk 2.1 +.\" Manual: Netatalk 2.1beta2 +.\" Source: Netatalk 2.1beta2 .\" Language: English .\" -.TH "NETATALK\&.CONF" "5" "9 Jun 2009" "Netatalk 2.1" "Netatalk 2.1" +.TH "NETATALK\&.CONF" "5" "9 Jun 2009" "Netatalk 2.1beta2" "Netatalk 2.1beta2" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -23,7 +23,7 @@ netatalk.conf \- Configuration file used by netatalk(8) to determine its general .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\&. +is the configuration file used by afpd to determine what portions of the file system will be shared via AFP, as well as their behaviors\&. .PP Any line not prefixed with \fB#\fR diff --git a/man/man8/afpd.8.tmpl b/man/man8/afpd.8.tmpl index ff821c5e..068cc7f3 100644 --- a/man/man8/afpd.8.tmpl +++ b/man/man8/afpd.8.tmpl @@ -3,11 +3,11 @@ .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.74.3 .\" Date: 08 Feb 2010 -.\" Manual: Netatalk 2.1 -.\" Source: Netatalk 2.1 +.\" Manual: Netatalk 2.1beta2 +.\" Source: Netatalk 2.1beta2 .\" Language: English .\" -.TH "AFPD" "8" "08 Feb 2010" "Netatalk 2.1" "Netatalk 2.1" +.TH "AFPD" "8" "08 Feb 2010" "Netatalk 2.1beta2" "Netatalk 2.1beta2" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -35,7 +35,7 @@ and one of ~/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\&. +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\&. 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 @@ -81,12 +81,17 @@ afpd\&.conf\&.) Print version information and exit\&. .RE .PP +\-V +.RS 4 +Print verbose information and exit\&. +.RE +.PP \-I .RS 4 Use a platform specific icon\&. (Equivalent to \fB\-icon\fR in -afpd\&.conf\&.) +afpd\&.conf\&.) (Recent Mac OS don\'t display it\&.) .RE .PP \-f \fIdefaultvolumes\fR @@ -261,4 +266,5 @@ contains messages to be sent to users\&. \fBafpd.conf\fR(5), \fBAppleVolumes.default\fR(5), \fBAppleVolumes.system\fR(5), +\fBafp_signature.conf\fR(5), \fBdbd\fR(1)\&. -- 2.39.2