]> arthur.barton.de Git - netatalk.git/commitdiff
manpages of AppleVolumes.default, AppleVolumes.system, AppleVolumes and afpd
authorhat001 <hat001>
Thu, 22 Apr 2010 14:49:05 +0000 (14:49 +0000)
committerhat001 <hat001>
Thu, 22 Apr 2010 14:49:05 +0000 (14:49 +0000)
man/man5/AppleVolumes.5 [new file with mode: 0644]
man/man5/AppleVolumes.default.5.tmpl
man/man5/AppleVolumes.system.5 [new file with mode: 0644]
man/man5/Makefile.am
man/man8/afpd.8.tmpl

diff --git a/man/man5/AppleVolumes.5 b/man/man5/AppleVolumes.5
new file mode 100644 (file)
index 0000000..e12bc53
--- /dev/null
@@ -0,0 +1 @@
+.so man5/AppleVolumes.default.5
index 967af699fc703a4d19ee3da9ed893fe557fe7369..56ce77213f3693004fef49ed916da95e48874aa8 100644 (file)
@@ -2,12 +2,12 @@
 .\"     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: 31 Mar 2010
+.\"      Date: 22 Apr 2010
 .\"    Manual: Netatalk 2.1
 .\"    Source: Netatalk 2.1
 .\"  Language: English
 .\"
-.TH "APPLEVOLUMES\&.DEFAU" "5" "31 Mar 2010" "Netatalk 2.1" "Netatalk 2.1"
+.TH "APPLEVOLUMES\&.DEFAU" "5" "22 Apr 2010" "Netatalk 2.1" "Netatalk 2.1"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "NAME"
-AppleVolumes.default \- Configuration file used by \fBafpd\fR(8) to determine the shares made available through AFP
+AppleVolumes.default, AppleVolumes.system, AppleVolumes \- Configuration file used by \fBafpd\fR(8) to determine the shares made available through AFP and specify file name extension mappings\&.
+.SH "SYNOPSIS"
+.HP \w'\fB:ETCDIR:/AppleVolumes\&.default\fR\fB\fR\fB:ETCDIR:/AppleVolumes\&.system\fR\fB\fR\fB~/AppleVolumes\fR\fB\fR\fB~/\&.AppleVolumes\fR\fB\fR\fB~/applevolumes\fR\fB\fR\fB~/\&.applevolumes\fR\fB\fR\ 'u
+\fB:ETCDIR:/AppleVolumes\&.default\fR\fB\fR
+.br
+\fB:ETCDIR:/AppleVolumes\&.system\fR\fB\fR
+.br
+\fB~/AppleVolumes\fR\fB\fR
+.br
+\fB~/\&.AppleVolumes\fR\fB\fR
+.br
+\fB~/applevolumes\fR\fB\fR
+.br
+\fB~/\&.applevolumes\fR\fB\fR
 .SH "DESCRIPTION"
 .PP
-:ETCDIR:/AppleVolumes\&.default
-is the configuration file used by
+
+:ETCDIR:/AppleVolumes\&.system
+and one of
+:ETCDIR:/AppleVolumes\&.default,
+~/AppleVolumes,
+~/\&.AppleVolumes,
+~/applevolumes, or
+~/\&.applevolumes
+are the configuration files 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:
+to determine what portions of the file system will be shared via Apple Filing Protocol, as well as their behaviour\&.
+.PP
+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
+\&.extension
+\fI[ type [ creator ] ]\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 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 volumename is unspecified, the last component of pathname is used\&. No two volumes may have the same name\&. If there are spaces in the name, it should be in quotes (i\&.e\&. "File Share")\&. The volume name cannot contain the
 \':\'
 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 \{\
@@ -54,6 +79,24 @@ line\&. Though newline escaping is supported\&.
 .sp .5v
 .RE
 .PP
+The leading\-dot lines specify file name extension mappings\&. The extension \'\&.\' sets the default creator and type for otherwise untyped Unix files\&.
+.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
+file name extension mapping is useful for Mac OS 9 and earlier\&. But it should not use for Mac OS X\&.
+.sp .5v
+.RE
+.PP
 It is possible to specify default options for all volumes with a
 \fI:DEFAULT: \fRline preceeding these volume definitions:.PP \fBExample.\ \&:DEFAULT: configuration line\fR .PP :DEFAULT: options:upriv,usedots dbpath:/var/dbd/AppleDB/$v dperm:0775 fperm:0664
 .PP
@@ -641,6 +684,31 @@ prodos
 Provides compatibility with Apple II clients\&. (legacy)
 .RE
 .RE
+.SH "FILE NAME EXTENSION MAPPINGS"
+.PP
+\fBExample.\ \&Extension is jpg. Type is "JPEG". Creator is "ogle".\fR
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+\&.jpg "JPEG" "ogle"
+.fi
+.if n \{\
+.RE
+.\}
+.PP
+\fBExample.\ \&Extension is lzh. Type is "LHA ". Creator is not defined.\fR
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+\&.lzh "LHA "
+.fi
+.if n \{\
+.RE
+.\}
 .SH "SEE ALSO"
 .PP
 \fBafpd.conf\fR(5),
diff --git a/man/man5/AppleVolumes.system.5 b/man/man5/AppleVolumes.system.5
new file mode 100644 (file)
index 0000000..e12bc53
--- /dev/null
@@ -0,0 +1 @@
+.so man5/AppleVolumes.default.5
index 6e082fca4eec1be30918e61bef6ec45405192e80..a1e28886df45aa60cca4ce65529e79ca207da133 100644 (file)
@@ -9,11 +9,11 @@ SUFFIXES = .tmpl .
            -e "s@:BINDIR:@${bindir}@g" \
            -e "s@:ETCDIR:@${pkgconfdir}@g" \
            -e "s@:LIBDIR:@${libdir}@g" \
-               -e "s@:DEFAULT_CNID_SCHEME:@${DEFAULT_CNID_SCHEME}@g" \
-               -e "s@:COMPILED_BACKENDS:@${compiled_backends}@g" \
+           -e "s@:DEFAULT_CNID_SCHEME:@${DEFAULT_CNID_SCHEME}@g" \
+           -e "s@:COMPILED_BACKENDS:@${compiled_backends}@g" \
            <$< >$@
 
-man_MANS = AppleVolumes.default.5 afpd.conf.5 \
+GENERATED_MANS = AppleVolumes.default.5 afpd.conf.5 \
        atalkd.conf.5 netatalk.conf.5 papd.conf.5 \
        afp_ldap.conf.5 afp_signature.conf.5
 
@@ -21,6 +21,10 @@ 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_signature.conf.5.tmpl
 
-CLEANFILES = $(man_MANS)
+NONGENERATED_MANS = AppleVolumes.5 AppleVolumes.system.5
 
-EXTRA_DIST = $(TEMPLATE_FILES) 
+man_MANS = $(GENERATED_MANS) $(NONGENERATED_MANS)
+
+CLEANFILES = $(GENERATED_MANS)
+
+EXTRA_DIST = $(TEMPLATE_FILES) $(NONGENERATED_MANS)
index aeb6618058cab61aec65db1656ac4f0368ed6936..117fecb6d034a5e1e8ce8d82b4922982c629d5df 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: afpd
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
-.\"      Date: 08 Feb 2010
+.\"      Date: 21 Apr 2010
 .\"    Manual: Netatalk 2.1
 .\"    Source: Netatalk 2.1
 .\"  Language: English
 .\"
-.TH "AFPD" "8" "08 Feb 2010" "Netatalk 2.1" "Netatalk 2.1"
+.TH "AFPD" "8" "21 Apr 2010" "Netatalk 2.1" "Netatalk 2.1"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -30,14 +30,21 @@ afpd \- Apple Filing Protocol daemon
 \fBafpd\fR
 provides an Apple Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time from /etc/rc\&.
 .PP
+:ETCDIR:/afpd\&.conf
+is the configuration file used by
+\fBafpd\fR
+to determine the behavior and configuration of the different virtual file servers that it provides\&.
+.PP
 The list of volumes offered to the user is generated from
 :ETCDIR:/AppleVolumes\&.system
 and one of
 :ETCDIR:/AppleVolumes\&.default,
-~/AppleVolumes, or
-~/\&.AppleVolumes\&. The
+~/AppleVolumes,
+~/\&.AppleVolumes,
+~/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\&. 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\&.
 .PP
 .SH "OPTIONS"
 .PP
@@ -246,6 +253,11 @@ signal and wait for it to die on its own\&.
 .RE
 .SH "FILES"
 .PP
+:ETCDIR:/afpd\&.conf
+.RS 4
+configuration file used by afpd
+.RE
+.PP
 :ETCDIR:/AppleVolumes\&.default
 .RS 4
 list of default volumes to mount
@@ -256,11 +268,16 @@ list of default volumes to mount
 list of volumes to offer all users
 .RE
 .PP
-~/AppleVolumes, ~/\&.AppleVolumes
+~/AppleVolumes, ~/\&.AppleVolumes, ~/applevolumes, ~/\&.applevolumes
 .RS 4
 user\'s list of volumes to mount
 .RE
 .PP
+:ETCDIR:/afp_signature\&.conf
+.RS 4
+list of server signature
+.RE
+.PP
 :ETCDIR:/netatalk/msg/message\&.pid
 .RS 4
 contains messages to be sent to users\&.
@@ -272,6 +289,5 @@ contains messages to be sent to users\&.
 \fBhosts_access\fR(5),
 \fBafpd.conf\fR(5),
 \fBAppleVolumes.default\fR(5),
-\fBAppleVolumes.system\fR(5),
 \fBafp_signature.conf\fR(5),
 \fBdbd\fR(1)\&.