From: Ralph Boehme Date: Tue, 14 May 2013 04:52:03 +0000 (+0200) Subject: Finish renaming X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=netatalk.git;a=commitdiff_plain;h=078278ce973d8513474e9505095a04f3a6db04c0 Finish renaming --- diff --git a/Makefile.am b/Makefile.am index 36a8c3cd..4d714f2d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,9 +1,9 @@ # Makefile.am for top level of netatalk package if USE_BUILTIN_LIBEVENT -SUBDIRS = libevent include libatalk bin config etc man contrib distrib doc macros test +SUBDIRS = libevent include libatalk bin config etc contrib distrib doc man macros test else -SUBDIRS = include libatalk bin config etc man contrib distrib doc macros test +SUBDIRS = include libatalk bin config etc contrib distrib doc man macros test endif EXTRA_DIST = CONTRIBUTORS COPYRIGHT COPYING NEWS VERSION diff --git a/configure.ac b/configure.ac index fd252e6f..ade3cf6c 100644 --- a/configure.ac +++ b/configure.ac @@ -252,6 +252,9 @@ AC_OUTPUT([Makefile doc/html.xsl doc/man.xsl doc/manual/manual.xml + doc/manpages/Makefile + doc/manpages/man1/Makefile + doc/manpages/man8/Makefile etc/Makefile etc/afpd/Makefile etc/cnid_dbd/Makefile @@ -279,8 +282,26 @@ AC_OUTPUT([Makefile macros/Makefile man/Makefile man/man1/Makefile + man/man1/ad.1 + man/man1/afpldaptest.1 + man/man1/afppasswd.1 + man/man1/afpstats.1 + man/man1/apple_dump.1 + man/man1/asip-status.pl.1 + man/man1/dbd.1 + man/man1/macusers.1 + man/man1/netatalk-config.1 + man/man1/uniconv.1 man/man5/Makefile + man/man5/afp.conf.5 + man/man5/afp_signature.conf.5 + man/man5/afp_voluuid.conf.5 + man/man5/extmap.conf.5 man/man8/Makefile + man/man8/afpd.8 + man/man8/cnid_dbd.8 + man/man8/cnid_metad.8 + man/man8/netatalk.8 test/Makefile test/afpd/Makefile ], diff --git a/doc/.gitignore b/doc/.gitignore index ade949aa..c8189ad1 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,4 +1,4 @@ Makefile.in Makefile -.gitignore -*.o +html.xsl +man.xsl \ No newline at end of file diff --git a/doc/Makefile.am b/doc/Makefile.am index 2869dbb6..e4e156e3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,64 +1,13 @@ +SUBDIRS = XSLTPROC=@XSLTPROC@ XSLTPROC_FLAGS=@XSLTPROC_FLAGS@ XHTML_STYLESHEET=$(top_srcdir)/doc/html.xsl -MAN_STYLESHEET=$(top_srcdir)/doc/man.xsl htmldir = $(prefix)/share/doc/@PACKAGE@ dist_html_DATA = @PACKAGE@.html -XML_MANPAGES = \ - ${top_srcdir}/doc/manpages/man1/ad.1.xml \ - ${top_srcdir}/doc/manpages/man1/afpldaptest.1.xml \ - ${top_srcdir}/doc/manpages/man1/afppasswd.1.xml \ - ${top_srcdir}/doc/manpages/man1/afpstats.1.xml \ - ${top_srcdir}/doc/manpages/man1/apple_dump.1.xml \ - ${top_srcdir}/doc/manpages/man1/asip-status.pl.1.xml \ - ${top_srcdir}/doc/manpages/man1/dbd.1.xml \ - ${top_srcdir}/doc/manpages/man1/macusers.1.xml \ - ${top_srcdir}/doc/manpages/man1/megatron.1.xml \ - ${top_srcdir}/doc/manpages/man1/netatalk-config.1.xml \ - ${top_srcdir}/doc/manpages/man1/uniconv.1.xml \ - ${top_srcdir}/doc/manpages/man5/afp_signature.conf.5.xml \ - ${top_srcdir}/doc/manpages/man5/afp_voluuid.conf.5.xml \ - ${top_srcdir}/doc/manpages/man5/afp.conf.5.xml \ - ${top_srcdir}/doc/manpages/man5/extmap.conf.5.xml \ - ${top_srcdir}/doc/manpages/man8/afpd.8.xml \ - ${top_srcdir}/doc/manpages/man8/cnid_dbd.8.xml \ - ${top_srcdir}/doc/manpages/man8/cnid_metad.8.xml \ - ${top_srcdir}/doc/manpages/man8/netatalk.8.xml - -MAN_MANPAGES = \ - ${top_builddir}/man/man1/ad.1.in \ - ${top_builddir}/man/man1/afpldaptest.1.in \ - ${top_builddir}/man/man1/afppasswd.1.in \ - ${top_builddir}/man/man1/afpstats.1.in \ - ${top_builddir}/man/man1/apple_dump.1.in \ - ${top_builddir}/man/man1/asip-status.pl.1.in \ - ${top_builddir}/man/man1/dbd.1.in \ - ${top_builddir}/man/man1/macusers.1.in \ - ${top_builddir}/man/man1/megatron.1.in \ - ${top_builddir}/man/man1/netatalk-config.1.in \ - ${top_builddir}/man/man1/uniconv.1.in \ - ${top_builddir}/man/man5/afp_signature.conf.5.in \ - ${top_builddir}/man/man5/afp_voluuid.conf.5.in \ - ${top_builddir}/man/man5/afp.conf.5.in \ - ${top_builddir}/man/man5/extmap.conf.5.in \ - ${top_builddir}/man/man8/afpd.8.in \ - ${top_builddir}/man/man8/cnid_dbd.8.in \ - ${top_builddir}/man/man8/cnid_metad.8.in \ - ${top_builddir}/man/man8/netatalk.8.in - if HAVE_XSLTPROC -${top_srcdir}/man/man1/%.1.in : $(MAN_STYLESHEET) ${top_srcdir}/doc/manpages/man1/%.1.xml - @xsltproc -o $(top_builddir)/man/man1/ $(MAN_STYLESHEET) $< - mv $% $@.in -${top_srcdir}/man/man5/%.8.in : $(MAN_STYLESHEET) ${top_srcdir}/doc/manpages/man5/%.5.xml - @xsltproc -o $(top_builddir)/man/man5/ $(MAN_STYLESHEET) $< -${top_srcdir}/man/man8/%.8.in : $(MAN_STYLESHEET) ${top_srcdir}/doc/manpages/man8/%.8.xml - @xsltproc -o $(top_builddir)/man/man8/ $(MAN_STYLESHEET) $< - -all-local: $(MAN_MANPAGES) - + SUBDIRS += manpages endif distclean-local: diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am new file mode 100644 index 00000000..4bc3be50 --- /dev/null +++ b/doc/manpages/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = man1 man5 man8 \ No newline at end of file diff --git a/doc/manpages/man1/.gitignore b/doc/manpages/man1/.gitignore new file mode 100644 index 00000000..7943d1d6 --- /dev/null +++ b/doc/manpages/man1/.gitignore @@ -0,0 +1 @@ +*\.1 \ No newline at end of file diff --git a/doc/manpages/man1/Makefile.am b/doc/manpages/man1/Makefile.am new file mode 100644 index 00000000..7c750e31 --- /dev/null +++ b/doc/manpages/man1/Makefile.am @@ -0,0 +1,24 @@ +XSLTPROC=@XSLTPROC@ +XSLTPROC_FLAGS=@XSLTPROC_FLAGS@ +MAN_STYLESHEET=$(top_srcdir)/doc/man.xsl + +MAN_MANPAGES = \ + ad.1 \ + afpldaptest.1 \ + afppasswd.1 \ + afpstats.1 \ + apple_dump.1 \ + asip-status.pl.1 \ + dbd.1 \ + macusers.1 \ + megatron.1 \ + netatalk-config.1 \ + uniconv.1 + +CLEANFILES = $(MAN_MANPAGES) + +%.1 : $(MAN_STYLESHEET) %.1.xml + @xsltproc $(MAN_STYLESHEET) $< + @cp $@ $(top_builddir)/man/man1/$@.in + +html-local: $(MAN_MANPAGES) diff --git a/doc/manpages/man5/.gitignore b/doc/manpages/man5/.gitignore new file mode 100644 index 00000000..2fc1d34e --- /dev/null +++ b/doc/manpages/man5/.gitignore @@ -0,0 +1 @@ +*\.5 diff --git a/doc/manpages/man5/Makefile.am b/doc/manpages/man5/Makefile.am new file mode 100644 index 00000000..0188bcac --- /dev/null +++ b/doc/manpages/man5/Makefile.am @@ -0,0 +1,17 @@ +XSLTPROC=@XSLTPROC@ +XSLTPROC_FLAGS=@XSLTPROC_FLAGS@ +MAN_STYLESHEET=$(top_srcdir)/doc/man.xsl + +MAN_MANPAGES = \ + afp.conf.5 \ + afp_signature.conf.5 \ + afp_voluuid.conf.5 \ + extmap.conf.5 + +CLEANFILES = $(MAN_MANPAGES) + +%.5 : $(MAN_STYLESHEET) %.5.xml + @xsltproc $(MAN_STYLESHEET) $< + @cp $@ $(top_builddir)/man/man5/$@.in + +html-local: $(MAN_MANPAGES) diff --git a/doc/manpages/man8/.gitignore b/doc/manpages/man8/.gitignore new file mode 100644 index 00000000..c756d8f5 --- /dev/null +++ b/doc/manpages/man8/.gitignore @@ -0,0 +1 @@ +*\.8 diff --git a/doc/manpages/man8/Makefile.am b/doc/manpages/man8/Makefile.am new file mode 100644 index 00000000..cf6c1f27 --- /dev/null +++ b/doc/manpages/man8/Makefile.am @@ -0,0 +1,17 @@ +XSLTPROC=@XSLTPROC@ +XSLTPROC_FLAGS=@XSLTPROC_FLAGS@ +MAN_STYLESHEET=$(top_srcdir)/doc/man.xsl + +MAN_MANPAGES = \ + afpd.8 \ + cnid_dbd.8 \ + cnid_metad.8 \ + netatalk.8 + +CLEANFILES = $(MAN_MANPAGES) + +%.8 : $(MAN_STYLESHEET) %.8.xml + @xsltproc $(MAN_STYLESHEET) $< + @cp $@ $(top_builddir)/man/man8/$@.in + +html-local: $(MAN_MANPAGES) diff --git a/doc/manual/.gitignore b/doc/manual/.gitignore new file mode 100644 index 00000000..8eb18aa7 --- /dev/null +++ b/doc/manual/.gitignore @@ -0,0 +1 @@ +manual.xml diff --git a/man/.gitignore b/man/.gitignore index 895a5e77..8f1b0d99 100644 --- a/man/.gitignore +++ b/man/.gitignore @@ -1,4 +1,3 @@ Makefile Makefile.in -.gitignore *.o diff --git a/man/man1/.gitignore b/man/man1/.gitignore index 39ffeb2f..0ac9461e 100644 --- a/man/man1/.gitignore +++ b/man/man1/.gitignore @@ -1,11 +1,3 @@ Makefile Makefile.in -apple_cp.1 -apple_dump.1 -apple_mv.1 -apple_rm.1 -asip-status.pl.1 -afpldaptest.1 -afpstats.1 -uniconv.1 -*.o +*.1 diff --git a/man/man1/Makefile.am b/man/man1/Makefile.am index 5e72f887..09ee0be7 100644 --- a/man/man1/Makefile.am +++ b/man/man1/Makefile.am @@ -1,7 +1,5 @@ # Makefile.am for man/man1/ -pkgconfdir = @PKGCONFDIR@ - man_MANS = \ ad.1 \ afpldaptest.1 \ @@ -14,4 +12,4 @@ man_MANS = \ netatalk-config.1 \ uniconv.1 -DISTCLEANFILES = $(man_MANS) +CLEANFILES = $(man_MANS) diff --git a/man/man1/ad.1 b/man/man1/ad.1 deleted file mode 100644 index 0e51d128..00000000 --- a/man/man1/ad.1 +++ /dev/null @@ -1,250 +0,0 @@ -'\" t -.\" Title: ad -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 02 Sep 2011 -.\" Manual: Netatalk 3.0.4dev -.\" Source: Netatalk 3.0.4dev -.\" Language: English -.\" -.TH "AD" "1" "02 Sep 2011" "Netatalk 3.0.4dev" "Netatalk 3.0.4dev" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -ad \- Netatalk compatible UNIX file utility suite\&. -.SH "SYNOPSIS" -.HP \w'\fBad\fR\ 'u -\fBad\fR {ls\ |\ cp\ |\ mv\ |\ rm} [\&.\&.\&.] -.HP \w'\fBad\fR\ 'u -\fBad\fR {\-v\ |\ \-\-version} -.SH "DESCRIPTION" -.PP -\fBad\fR -is a UNIX file utility suite with Netatalk compatibility\&. AppleDouble -files in -\&.AppleDouble -directories and the CNID databases are updated as appropriate\&. -.SH "AVAILABLE COMMANDS" -.HP \w'\fBad\ ls\fR\ 'u -\fBad ls\fR [\-dRl\ [u]] {file|dir\ [\&.\&.\&.]} -.PP -List files and directories\&. -.HP \w'\fBad\ cp\fR\ 'u -\fBad cp\fR [\-aipvf] {src_file} {dst_file} -.HP \w'\fBad\ cp\ \-R\fR\ 'u -\fBad cp \-R\fR [\-aipvf] {src_file|src_directory\ \&.\&.\&.} {dst_directory} -.PP -Copy files and directories\&. -.HP \w'\fBad\ mv\fR\ 'u -\fBad mv\fR [\-finv] {src_file} {dst_file} -.HP \w'\fBad\ mv\fR\ 'u -\fBad mv\fR [\-finv] {src_file|src_directory\ \&.\&.\&.} {dst_directory} -.PP -Move files and directories\&. -.HP \w'\fBad\ rm\fR\ 'u -\fBad rm\fR [\-Rv] {file|directory} -.HP \w'\fBad\ \-v|\-\-version\fR\ 'u -\fBad \-v|\-\-version\fR -.PP -Show version\&. -.SH "AD LS" -.PP -List files and directories\&. Options: -.PP -\-d -.RS 4 -Directories are listed as plain files -.RE -.PP -\-R -.RS 4 -list subdirectories recursively -.RE -.PP -\-l -.RS 4 -Long output, list AFP info -.RE -.PP -\-u -.RS 4 -List UNIX info -.RE -.PP -\fILong output description\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf - - -FinderFlags (valid for (f)iles and/or (d)irectories): - - d = On Desktop (f/d) - e = Hidden extension (f/d) - m = Shared (can run multiple times) (f) - n = No INIT resources (f) - i = Inited (f/d) - c = Custom icon (f/d) - t = Stationery (f) - s = Name locked (f/d) - b = Bundle (f/d) - v = Invisible (f/d) - a = Alias file (f/d) - -AFP Attributes: - - y = System (f/d) - w = No write (f) - p = Needs backup (f/d) - r = No rename (f/d) - l = No delete (f/d) - o = No copy (f) - -Note: any letter appearing in uppercase means the flag is set but it\*(Aqs a directory for which the flag is not allowed\&. -.fi -.if n \{\ -.RE -.\} -.SH "AD CP" -.PP -Copy files and directories\&. -.PP -In the first synopsis form, the cp utility copies the contents of the source_file to the target_file\&. In the second synopsis form, the contents of each named source_file is copied to the destination target_directory\&. The names of the files themselves are not changed\&. If cp detects an attempt to copy a file to itself, the copy will fail\&. -.PP -Netatalk AFP volumes are detected by means of their "\&.AppleDesktop" directory which is located in their volume root\&. When a copy targeting an AFP volume is detected, its CNID database daemon is connected and all copies will also go through the CNID database\&. AppleDouble files are also copied and created as needed when the target is an AFP volume\&. -.PP -Options: -.PP -\-a -.RS 4 -Archive mode\&. Same as \-Rp\&. -.RE -.PP -\-f -.RS 4 -For each existing destination pathname, remove it and create a new file, without prompting for confirmation regardless of its permis\- sions\&. (The \-f option overrides any previous \-i or \-n options\&.) -.RE -.PP -\-i -.RS 4 -Cause cp to write a prompt to the standard error output before copying a file that would overwrite an existing file\&. If the response from the standard input begins with the character \*(Aqy\*(Aq or \*(AqY\*(Aq, the file copy is attempted\&. (The \-i option overrides any pre\- vious \-f or \-n options\&.) -.RE -.PP -\-n -.RS 4 -Do not overwrite an existing file\&. (The \-n option overrides any previous \-f or \-i options\&.) -.RE -.PP -\-p -.RS 4 -Cause cp to preserve the following attributes of each source file in the copy: modification time, access time, file flags, file mode, user ID, and group ID, as allowed by permissions\&. If the user ID and group ID cannot be preserved, no error message is displayed and the exit value is not altered\&. -.RE -.PP -\-R -.RS 4 -If source_file designates a directory, cp copies the directory and the entire subtree connected at that point\&.If the source_file ends in a /, the contents of the directory are copied rather than the directory itself\&. -.RE -.PP -\-v -.RS 4 -Cause cp to be verbose, showing files as they are copied\&. -.RE -.PP -\-x -.RS 4 -File system mount points are not traversed\&. -.RE -.SH "AD MV" -.PP -Move files and directories\&. -.PP -Move files around within an AFP volume, updating the CNID database as needed\&. If either: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -source or destination is not an AFP volume -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -source AFP volume != destination AFP volume -.RE -.sp -the files are copied and removed from the source\&. -.PP -Options: -.PP -\-f -.RS 4 -Do not prompt for confirmation before overwriting the destination path\&. (The \-f option overrides any previous \-i or \-n options\&.) -.RE -.PP -\-i -.RS 4 -Cause mv to write a prompt to standard error before moving a file that would overwrite an existing file\&. If the response from the standard input begins with the character `y\*(Aq or `Y\*(Aq, the move is attempted\&. (The \-i option overrides any previous \-f or \-n options\&.) -.RE -.PP -\-n -.RS 4 -Do not overwrite an existing file\&. (The \-n option overrides any previous \-f or \-i options\&.) -.RE -.PP -\-v -.RS 4 -Cause mv to be verbose, showing files after they are moved\&. -.RE -.SH "AD RM" -.PP -Remove files and directories\&. -.PP -The rm utility attempts to remove the non\-directory type files specified on the command line\&. If the files and directories reside on an AFP volume, the corresponding CNIDs are deleted from the volumes database\&. -.PP -The options are as follows: -.PP -\-R -.RS 4 -Attempt to remove the file hierarchy rooted in each file argument\&. -.RE -.PP -\-v -.RS 4 -Be verbose when deleting files, showing them as they are removed\&. -.RE -.SH "REPORTING BUGS" -.PP -Report bugs to the Netatalk\-devel list \&. -.SH "SEE ALSO" -.PP -\fBdbd\fR(1), -\fBapple_dump\fR(1)\&. diff --git a/man/man1/ad.1.in b/man/man1/ad.1.in new file mode 100644 index 00000000..1a807cfe --- /dev/null +++ b/man/man1/ad.1.in @@ -0,0 +1,250 @@ +'\" t +.\" Title: ad +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 02 Sep 2011 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "AD" "1" "02 Sep 2011" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +ad \- Netatalk compatible UNIX file utility suite\&. +.SH "SYNOPSIS" +.HP \w'\fBad\fR\ 'u +\fBad\fR {ls\ |\ cp\ |\ mv\ |\ rm} [\&.\&.\&.] +.HP \w'\fBad\fR\ 'u +\fBad\fR {\-v\ |\ \-\-version} +.SH "DESCRIPTION" +.PP +\fBad\fR +is a UNIX file utility suite with Netatalk compatibility\&. AppleDouble +files in +\&.AppleDouble +directories and the CNID databases are updated as appropriate\&. +.SH "AVAILABLE COMMANDS" +.HP \w'\fBad\ ls\fR\ 'u +\fBad ls\fR [\-dRl\ [u]] {file|dir\ [\&.\&.\&.]} +.PP +List files and directories\&. +.HP \w'\fBad\ cp\fR\ 'u +\fBad cp\fR [\-aipvf] {src_file} {dst_file} +.HP \w'\fBad\ cp\ \-R\fR\ 'u +\fBad cp \-R\fR [\-aipvf] {src_file|src_directory\ \&.\&.\&.} {dst_directory} +.PP +Copy files and directories\&. +.HP \w'\fBad\ mv\fR\ 'u +\fBad mv\fR [\-finv] {src_file} {dst_file} +.HP \w'\fBad\ mv\fR\ 'u +\fBad mv\fR [\-finv] {src_file|src_directory\ \&.\&.\&.} {dst_directory} +.PP +Move files and directories\&. +.HP \w'\fBad\ rm\fR\ 'u +\fBad rm\fR [\-Rv] {file|directory} +.HP \w'\fBad\ \-v|\-\-version\fR\ 'u +\fBad \-v|\-\-version\fR +.PP +Show version\&. +.SH "AD LS" +.PP +List files and directories\&. Options: +.PP +\-d +.RS 4 +Directories are listed as plain files +.RE +.PP +\-R +.RS 4 +list subdirectories recursively +.RE +.PP +\-l +.RS 4 +Long output, list AFP info +.RE +.PP +\-u +.RS 4 +List UNIX info +.RE +.PP +\fILong output description\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf + + +FinderFlags (valid for (f)iles and/or (d)irectories): + + d = On Desktop (f/d) + e = Hidden extension (f/d) + m = Shared (can run multiple times) (f) + n = No INIT resources (f) + i = Inited (f/d) + c = Custom icon (f/d) + t = Stationery (f) + s = Name locked (f/d) + b = Bundle (f/d) + v = Invisible (f/d) + a = Alias file (f/d) + +AFP Attributes: + + y = System (f/d) + w = No write (f) + p = Needs backup (f/d) + r = No rename (f/d) + l = No delete (f/d) + o = No copy (f) + +Note: any letter appearing in uppercase means the flag is set but it\*(Aqs a directory for which the flag is not allowed\&. +.fi +.if n \{\ +.RE +.\} +.SH "AD CP" +.PP +Copy files and directories\&. +.PP +In the first synopsis form, the cp utility copies the contents of the source_file to the target_file\&. In the second synopsis form, the contents of each named source_file is copied to the destination target_directory\&. The names of the files themselves are not changed\&. If cp detects an attempt to copy a file to itself, the copy will fail\&. +.PP +Netatalk AFP volumes are detected by means of their "\&.AppleDesktop" directory which is located in their volume root\&. When a copy targeting an AFP volume is detected, its CNID database daemon is connected and all copies will also go through the CNID database\&. AppleDouble files are also copied and created as needed when the target is an AFP volume\&. +.PP +Options: +.PP +\-a +.RS 4 +Archive mode\&. Same as \-Rp\&. +.RE +.PP +\-f +.RS 4 +For each existing destination pathname, remove it and create a new file, without prompting for confirmation regardless of its permis\- sions\&. (The \-f option overrides any previous \-i or \-n options\&.) +.RE +.PP +\-i +.RS 4 +Cause cp to write a prompt to the standard error output before copying a file that would overwrite an existing file\&. If the response from the standard input begins with the character \*(Aqy\*(Aq or \*(AqY\*(Aq, the file copy is attempted\&. (The \-i option overrides any pre\- vious \-f or \-n options\&.) +.RE +.PP +\-n +.RS 4 +Do not overwrite an existing file\&. (The \-n option overrides any previous \-f or \-i options\&.) +.RE +.PP +\-p +.RS 4 +Cause cp to preserve the following attributes of each source file in the copy: modification time, access time, file flags, file mode, user ID, and group ID, as allowed by permissions\&. If the user ID and group ID cannot be preserved, no error message is displayed and the exit value is not altered\&. +.RE +.PP +\-R +.RS 4 +If source_file designates a directory, cp copies the directory and the entire subtree connected at that point\&.If the source_file ends in a /, the contents of the directory are copied rather than the directory itself\&. +.RE +.PP +\-v +.RS 4 +Cause cp to be verbose, showing files as they are copied\&. +.RE +.PP +\-x +.RS 4 +File system mount points are not traversed\&. +.RE +.SH "AD MV" +.PP +Move files and directories\&. +.PP +Move files around within an AFP volume, updating the CNID database as needed\&. If either: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +source or destination is not an AFP volume +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +source AFP volume != destination AFP volume +.RE +.sp +the files are copied and removed from the source\&. +.PP +Options: +.PP +\-f +.RS 4 +Do not prompt for confirmation before overwriting the destination path\&. (The \-f option overrides any previous \-i or \-n options\&.) +.RE +.PP +\-i +.RS 4 +Cause mv to write a prompt to standard error before moving a file that would overwrite an existing file\&. If the response from the standard input begins with the character `y\*(Aq or `Y\*(Aq, the move is attempted\&. (The \-i option overrides any previous \-f or \-n options\&.) +.RE +.PP +\-n +.RS 4 +Do not overwrite an existing file\&. (The \-n option overrides any previous \-f or \-i options\&.) +.RE +.PP +\-v +.RS 4 +Cause mv to be verbose, showing files after they are moved\&. +.RE +.SH "AD RM" +.PP +Remove files and directories\&. +.PP +The rm utility attempts to remove the non\-directory type files specified on the command line\&. If the files and directories reside on an AFP volume, the corresponding CNIDs are deleted from the volumes database\&. +.PP +The options are as follows: +.PP +\-R +.RS 4 +Attempt to remove the file hierarchy rooted in each file argument\&. +.RE +.PP +\-v +.RS 4 +Be verbose when deleting files, showing them as they are removed\&. +.RE +.SH "REPORTING BUGS" +.PP +Report bugs to the Netatalk\-devel list \&. +.SH "SEE ALSO" +.PP +\fBdbd\fR(1), +\fBapple_dump\fR(1)\&. diff --git a/man/man1/afpldaptest.1.in b/man/man1/afpldaptest.1.in new file mode 100644 index 00000000..94d6bd50 --- /dev/null +++ b/man/man1/afpldaptest.1.in @@ -0,0 +1,67 @@ +'\" t +.\" Title: afpldaptest +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 22 Mar 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "AFPLDAPTEST" "1" "22 Mar 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +afpldaptest \- Syntactically check ldap parameters in afp\&.conf +.SH "SYNOPSIS" +.HP \w'\fBafpldaptest\fR\fB\fR\fBafpldaptest\fR\fB\fR\ 'u +\fBafpldaptest\fR\fB\fR {\-u\ \fIUSER\fR | \-g\ \fIGROUP\fR | \-i\ \fIUUID\fR} +.br +\fBafpldaptest\fR\fB\fR {\-h | \-? | \-:} +.SH "DESCRIPTION" +.PP +\fBafpldaptest\fR +is a simple command to syntactically check ldap parameters in @pkgconfdir@/afp\&.conf\&. +.SH "OPTIONS" +.PP +\fB\-u\fR \fIUSER\fR +.RS 4 +Show uuid for +\fIUSER\fR\&. +.RE +.PP +\fB\-g\fR \fIGROUP\fR +.RS 4 +Show uuid for +\fIGROUP\fR\&. +.RE +.PP +\fB\-i\fR \fIUUID\fR +.RS 4 +Show user, group or local\-uuid for +\fIUUID\fR\&. +.RE +.PP +\fB\-h, \-?, \-:\fR +.RS 4 +Show the help and exit\&. +.RE +.SH "SEE ALSO" +.PP +\fBafp.conf\fR(5) diff --git a/man/man1/afpldaptest.1.tmpl b/man/man1/afpldaptest.1.tmpl deleted file mode 100644 index 5c4c67f4..00000000 --- a/man/man1/afpldaptest.1.tmpl +++ /dev/null @@ -1,67 +0,0 @@ -'\" t -.\" Title: afpldaptest -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 22 Mar 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "AFPLDAPTEST" "1" "22 Mar 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -afpldaptest \- Syntactically check ldap parameters in afp\&.conf -.SH "SYNOPSIS" -.HP \w'\fBafpldaptest\fR\fB\fR\fBafpldaptest\fR\fB\fR\ 'u -\fBafpldaptest\fR\fB\fR {\-u\ \fIUSER\fR | \-g\ \fIGROUP\fR | \-i\ \fIUUID\fR} -.br -\fBafpldaptest\fR\fB\fR {\-h | \-? | \-:} -.SH "DESCRIPTION" -.PP -\fBafpldaptest\fR -is a simple command to syntactically check ldap parameters in :ETCDIR:/afp\&.conf\&. -.SH "OPTIONS" -.PP -\fB\-u\fR \fIUSER\fR -.RS 4 -Show uuid for -\fIUSER\fR\&. -.RE -.PP -\fB\-g\fR \fIGROUP\fR -.RS 4 -Show uuid for -\fIGROUP\fR\&. -.RE -.PP -\fB\-i\fR \fIUUID\fR -.RS 4 -Show user, group or local\-uuid for -\fIUUID\fR\&. -.RE -.PP -\fB\-h, \-?, \-:\fR -.RS 4 -Show the help and exit\&. -.RE -.SH "SEE ALSO" -.PP -\fBafp.conf\fR(5) diff --git a/man/man1/afppasswd.1 b/man/man1/afppasswd.1 deleted file mode 100644 index 60d640c0..00000000 --- a/man/man1/afppasswd.1 +++ /dev/null @@ -1,122 +0,0 @@ -'\" t -.\" Title: afppasswd -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 22 Mar 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "AFPPASSWD" "1" "22 Mar 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * 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" -.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" and "DHX2" UAM instead\&. Please compare with the -Authentication chapter -inside Netatalk\*(Aqs documentation\&. -.sp .5v -.RE -.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\&. -.fi -.if n \{\ -.RE -.\} -.SH "OPTIONS" -.PP -\fB\-a\fR -.RS 4 -Add a new user to the -\fBafppasswd\fR -file\&. -.RE -.PP -\fB\-c\fR -.RS 4 -Create and/or initialize -\fBafppasswd\fR -file or specific user\&. -.RE -.PP -\fB\-f\fR -.RS 4 -Force the current action\&. -.RE -.PP -\fB\-p\fR\fI path\fR -.RS 4 -Path to -\fBafppasswd\fR -file\&. -.RE -.PP -\fB\-n\fR -.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 -.RS 4 -This is the minimum -\fIuser id\fR -(uid) that -\fBafppasswd\fR -will use when creating users\&. -.RE -.SH "SEE ALSO" -.PP -\fBafpd\fR(8), -\fBafp.conf\fR(5)\&. diff --git a/man/man1/afppasswd.1.in b/man/man1/afppasswd.1.in new file mode 100644 index 00000000..6acce227 --- /dev/null +++ b/man/man1/afppasswd.1.in @@ -0,0 +1,122 @@ +'\" t +.\" Title: afppasswd +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 22 Mar 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "AFPPASSWD" "1" "22 Mar 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * 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" +.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" and "DHX2" UAM instead\&. Please compare with the +Authentication chapter +inside Netatalk\*(Aqs documentation\&. +.sp .5v +.RE +.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\&. +.fi +.if n \{\ +.RE +.\} +.SH "OPTIONS" +.PP +\fB\-a\fR +.RS 4 +Add a new user to the +\fBafppasswd\fR +file\&. +.RE +.PP +\fB\-c\fR +.RS 4 +Create and/or initialize +\fBafppasswd\fR +file or specific user\&. +.RE +.PP +\fB\-f\fR +.RS 4 +Force the current action\&. +.RE +.PP +\fB\-p\fR\fI path\fR +.RS 4 +Path to +\fBafppasswd\fR +file\&. +.RE +.PP +\fB\-n\fR +.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 +.RS 4 +This is the minimum +\fIuser id\fR +(uid) that +\fBafppasswd\fR +will use when creating users\&. +.RE +.SH "SEE ALSO" +.PP +\fBafpd\fR(8), +\fBafp.conf\fR(5)\&. diff --git a/man/man1/afpstats.1.in b/man/man1/afpstats.1.in new file mode 100644 index 00000000..16dc0b1d --- /dev/null +++ b/man/man1/afpstats.1.in @@ -0,0 +1,50 @@ +'\" t +.\" Title: afpstats +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 24 Mar 2013 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "AFPSTATS" "1" "24 Mar 2013" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +afpstats \- List AFP statistics +.SH "SYNOPSIS" +.HP \w'\fBafpstats\fR\fB\fR\ 'u +\fBafpstats\fR\fB\fR +.SH "DESCRIPTION" +.PP +\fBafpstats\fR +list AFP statistics via D\-Bus IPC\&. +.SH "NOTE" +.PP +\fBafpd\fR +must support D\-Bus\&. Check it by "\fBafpd \-V\fR"\&. +.PP +"\fBafpstats = yes\fR" must be set in +@pkgconfdir@/afp\&.conf\&. +.SH "SEE ALSO" +.PP +\fBafpd\fR(8), +\fBafp.conf\fR(5), +\fBdbus-daemon\fR(1) diff --git a/man/man1/afpstats.1.tmpl b/man/man1/afpstats.1.tmpl deleted file mode 100644 index b7980996..00000000 --- a/man/man1/afpstats.1.tmpl +++ /dev/null @@ -1,50 +0,0 @@ -'\" t -.\" Title: afpstats -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 24 Mar 2013 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "AFPSTATS" "1" "24 Mar 2013" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -afpstats \- List AFP statistics -.SH "SYNOPSIS" -.HP \w'\fBafpstats\fR\fB\fR\ 'u -\fBafpstats\fR\fB\fR -.SH "DESCRIPTION" -.PP -\fBafpstats\fR -list AFP statistics via D\-Bus IPC\&. -.SH "NOTE" -.PP -\fBafpd\fR -must support D\-Bus\&. Check it by "\fBafpd \-V\fR"\&. -.PP -"\fBafpstats = yes\fR" must be set in -:ETCDIR:/afp\&.conf\&. -.SH "SEE ALSO" -.PP -\fBafpd\fR(8), -\fBafp.conf\fR(5), -\fBdbus-daemon\fR(1) diff --git a/man/man1/apple_dump.1 b/man/man1/apple_dump.1 deleted file mode 100644 index f8676fda..00000000 --- a/man/man1/apple_dump.1 +++ /dev/null @@ -1,114 +0,0 @@ -'\" t -.\" Title: apple_dump -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 16 Jul 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "APPLE_DUMP" "1" "16 Jul 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -apple_dump \- Dump AppleSingle/AppleDouble format data -.SH "SYNOPSIS" -.HP \w'\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\ 'u -\fBapple_dump\fR\fB\fR [\-a] [\fIFILE\fR | \fIDIR\fR] -.br -\fBapple_dump\fR\fB\fR \-e \fIFILE\fR | \fIDIR\fR -.br -\fBapple_dump\fR\fB\fR \-f [\fIFILE\fR] -.br -\fBapple_dump\fR\fB\fR \-d [\fIFILE\fR] -.br -\fBapple_dump\fR\fB\fR \-h | \-help | \-\-help -.br -\fBapple_dump\fR\fB\fR \-v | \-version | \-\-version -.SH "DESCRIPTION" -.PP -\fBapple_dump\fR -is a perl script to dump AppleSingle/AppleDouble format data\&. -.PP -This script can dump various AppleSingle/AppleDouble data created by mailer, archiver, Mac OS X, Netatalk and so on\&. -.PP -With no -\fIFILE\fR|\fIDIR\fR, or when -\fIFILE\fR|\fIDIR\fR -is \-, read standard input\&. -.SH "OPTIONS" -.PP -\fB\-a\fR [\fIFILE\fR|\fIDIR\fR] -.RS 4 -This is default\&. Dump a AppleSingle/AppleDouble file for -\fIFILE\fR -or -\fIDIR\fR -automatically\&. If FILE is not AppleSingle/AppleDouble format, look for extended attribute, -\fI\&.AppleDouble/FILE\fR -and -\fI\&._FILE\fR\&. If -\fIDIR\fR, look for extended attribute, -\fIDIR/\&.AppleDouble/\&.Parent\fR -and -\fI\&._DIR\fR\&. -.RE -.PP -\fB\-e\fR \fIFILE\fR|\fIDIR\fR -.RS 4 -Dump extended attribute of\fIFILE\fR -or -\fIDIR\fR\&. -.RE -.PP -\fB\-f\fR [\fIFILE\fR] -.RS 4 -Dump -\fIFILE\fR\&. Assume FinderInfo to be FileInfo\&. -.RE -.PP -\fB\-d\fR [\fIFILE\fR] -.RS 4 -Dump -\fIFILE\fR\&. Assume FinderInfo to be DirInfo\&. -.RE -.PP -\fB\-h, \-help, \-\-help\fR -.RS 4 -Display the help and exit -.RE -.PP -\fB\-v, \-version, \-\-version\fR -.RS 4 -Show version and exit -.RE -.SH "NOTE" -.PP -There is no way to detect whether FinderInfo is FileInfo or DirInfo\&. By default, apple_dump examines whether file or directory, a parent directory is \&.AppleDouble, filename is \&._*, filename is \&.Parent, and so on\&. -.PP -If setting option \-e, \-f or \-d, assume FinderInfo and doesn\*(Aqt look for another file\&. -.SH "SEE ALSO" -.PP -\fBad\fR(1), -\fBgetfattr\fR(1), -\fBattr\fR(1), -\fBrunat\fR(1), -\fBgetextattr\fR(8), -\fBlsextattr\fR(8) diff --git a/man/man1/apple_dump.1.in b/man/man1/apple_dump.1.in new file mode 100644 index 00000000..c9d7ff64 --- /dev/null +++ b/man/man1/apple_dump.1.in @@ -0,0 +1,114 @@ +'\" t +.\" Title: apple_dump +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 16 Jul 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "APPLE_DUMP" "1" "16 Jul 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +apple_dump \- Dump AppleSingle/AppleDouble format data +.SH "SYNOPSIS" +.HP \w'\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\ 'u +\fBapple_dump\fR\fB\fR [\-a] [\fIFILE\fR | \fIDIR\fR] +.br +\fBapple_dump\fR\fB\fR \-e \fIFILE\fR | \fIDIR\fR +.br +\fBapple_dump\fR\fB\fR \-f [\fIFILE\fR] +.br +\fBapple_dump\fR\fB\fR \-d [\fIFILE\fR] +.br +\fBapple_dump\fR\fB\fR \-h | \-help | \-\-help +.br +\fBapple_dump\fR\fB\fR \-v | \-version | \-\-version +.SH "DESCRIPTION" +.PP +\fBapple_dump\fR +is a perl script to dump AppleSingle/AppleDouble format data\&. +.PP +This script can dump various AppleSingle/AppleDouble data created by mailer, archiver, Mac OS X, Netatalk and so on\&. +.PP +With no +\fIFILE\fR|\fIDIR\fR, or when +\fIFILE\fR|\fIDIR\fR +is \-, read standard input\&. +.SH "OPTIONS" +.PP +\fB\-a\fR [\fIFILE\fR|\fIDIR\fR] +.RS 4 +This is default\&. Dump a AppleSingle/AppleDouble file for +\fIFILE\fR +or +\fIDIR\fR +automatically\&. If FILE is not AppleSingle/AppleDouble format, look for extended attribute, +\fI\&.AppleDouble/FILE\fR +and +\fI\&._FILE\fR\&. If +\fIDIR\fR, look for extended attribute, +\fIDIR/\&.AppleDouble/\&.Parent\fR +and +\fI\&._DIR\fR\&. +.RE +.PP +\fB\-e\fR \fIFILE\fR|\fIDIR\fR +.RS 4 +Dump extended attribute of\fIFILE\fR +or +\fIDIR\fR\&. +.RE +.PP +\fB\-f\fR [\fIFILE\fR] +.RS 4 +Dump +\fIFILE\fR\&. Assume FinderInfo to be FileInfo\&. +.RE +.PP +\fB\-d\fR [\fIFILE\fR] +.RS 4 +Dump +\fIFILE\fR\&. Assume FinderInfo to be DirInfo\&. +.RE +.PP +\fB\-h, \-help, \-\-help\fR +.RS 4 +Display the help and exit +.RE +.PP +\fB\-v, \-version, \-\-version\fR +.RS 4 +Show version and exit +.RE +.SH "NOTE" +.PP +There is no way to detect whether FinderInfo is FileInfo or DirInfo\&. By default, apple_dump examines whether file or directory, a parent directory is \&.AppleDouble, filename is \&._*, filename is \&.Parent, and so on\&. +.PP +If setting option \-e, \-f or \-d, assume FinderInfo and doesn\*(Aqt look for another file\&. +.SH "SEE ALSO" +.PP +\fBad\fR(1), +\fBgetfattr\fR(1), +\fBattr\fR(1), +\fBrunat\fR(1), +\fBgetextattr\fR(8), +\fBlsextattr\fR(8) diff --git a/man/man1/asip-status.pl.1.in b/man/man1/asip-status.pl.1.in new file mode 100644 index 00000000..29636178 --- /dev/null +++ b/man/man1/asip-status.pl.1.in @@ -0,0 +1,135 @@ +'\" t +.\" Title: asip-status.pl +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 24 Jul 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "ASIP\-STATUS\&.PL" "1" "24 Jul 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * 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" +.HP \w'\fBasip\-status\&.pl\fR\fB\fR\ 'u +\fBasip\-status\&.pl\fR\fB\fR [\-d] [\-i] [\-x] HOSTNAME[:PORT] + +.br +.HP \w'\fBasip\-status\&.pl\fR\fB\fR\ 'u +\fBasip\-status\&.pl\fR\fB\fR \-v | \-version | \-\-version +.SH "DESCRIPTION" +.PP +\fBasip\-status\&.pl\fR +is a perl script that sends a FPGetSrvrInfo request to an AFP server at HOSTNAME:PORT and displays the results, namely "Machine type", the server\*(Aqs 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\*(Aqt supply :PORT, then the default AFP port, 548, will be used\&. +.SH "OPTIONS" +.PP +\fB\-d\fR +.RS 4 +Enable debug output\&. +.RE +.PP +\fB\-i\fR +.RS 4 +Show icon if it exists\&. +.RE +.PP +\fB\-x\fR +.RS 4 +Enable hex dump output\&. +.RE +.PP +\fB\-v, \-version, \-\-version\fR +.RS 4 +Show version\&. +.RE +.SH "EXAMPLES" +.PP +.if n \{\ +.RS 4 +.\} +.nf +\fBasip\-status\&.pl\fR 192\&.168\&.1\&.15 +AFP reply from 192\&.168\&.1\&.15: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 +UAMs: Cleartxt passwrd,Randnum exchange,2\-Way Randnum exchange +Volume Icon & Mask: Yes +Flags: + SupportsCopyFile + SupportsChgPwd + SupportsServerMessages + SupportsServerSignature + SupportsTCP/IP + SupportsSuperClient +Server name: bookchan +Signature: +04 1d 65 23 04 1d 65 23 04 1d 65 23 04 1d 65 23 \&.\&.e#\&.\&.e#\&.\&.e#\&.\&.e# + +Network address: 192\&.168\&.1\&.15:548 (TCP/IP address and port) +Network address: 65280\&.128 (ddp address) +.fi +.if n \{\ +.RE +.\} +.PP +.if n \{\ +.RS 4 +.\} +.nf +\fBasip\-status\&.pl\fR myserver:10548 +AFP reply from myserver:10548 +Flags: 1 Cmd: 3 ID: 57005 +Reply: DSIGetStatus +Request ID: 57005 +Machine type: Netatalk3\&.0 +AFP versions: AFP2\&.2,AFPX03,AFP3\&.1,AFP3\&.2,AFP3\&.3 +UAMs: DHX2,DHCAST128 +Volume Icon & Mask: Yes +Flags: + SupportsCopyFile + SupportsServerMessages + SupportsServerSignature + SupportsTCP/IP + SupportsSrvrNotifications + SupportsOpenDirectory + SupportsUTF8Servername + SupportsUUIDs + SupportsExtSleep + SupportsSuperClient +Server name: myserver +Signature: +8a c6 12 3a 0e d9 95 3e 6f 31 e3 a9 17 f5 70 f6 \&.\&.\&.:\&.\&.\&.>o1\&.\&.\&.\&.p\&. + +Network address: 192\&.168\&.1\&.154:10548 (TCP/IP address and port) +UTF8 Servername: myserver +.fi +.if n \{\ +.RE +.\} +.SH "REPORTING BUGS" +.PP +Report bugs to the Netatalk\-devel list \&. diff --git a/man/man1/asip-status.pl.1.tmpl b/man/man1/asip-status.pl.1.tmpl deleted file mode 100644 index 735f8eb7..00000000 --- a/man/man1/asip-status.pl.1.tmpl +++ /dev/null @@ -1,135 +0,0 @@ -'\" t -.\" Title: asip-status.pl -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 24 Jul 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "ASIP\-STATUS\&.PL" "1" "24 Jul 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * 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" -.HP \w'\fBasip\-status\&.pl\fR\fB\fR\ 'u -\fBasip\-status\&.pl\fR\fB\fR [\-d] [\-i] [\-x] HOSTNAME[:PORT] - -.br -.HP \w'\fBasip\-status\&.pl\fR\fB\fR\ 'u -\fBasip\-status\&.pl\fR\fB\fR \-v | \-version | \-\-version -.SH "DESCRIPTION" -.PP -\fBasip\-status\&.pl\fR -is a perl script that sends a FPGetSrvrInfo request to an AFP server at HOSTNAME:PORT and displays the results, namely "Machine type", the server\*(Aqs 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\*(Aqt supply :PORT, then the default AFP port, 548, will be used\&. -.SH "OPTIONS" -.PP -\fB\-d\fR -.RS 4 -Enable debug output\&. -.RE -.PP -\fB\-i\fR -.RS 4 -Show icon if it exists\&. -.RE -.PP -\fB\-x\fR -.RS 4 -Enable hex dump output\&. -.RE -.PP -\fB\-v, \-version, \-\-version\fR -.RS 4 -Show version\&. -.RE -.SH "EXAMPLES" -.PP -.if n \{\ -.RS 4 -.\} -.nf -\fBasip\-status\&.pl\fR 192\&.168\&.1\&.15 -AFP reply from 192\&.168\&.1\&.15: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 -UAMs: Cleartxt passwrd,Randnum exchange,2\-Way Randnum exchange -Volume Icon & Mask: Yes -Flags: - SupportsCopyFile - SupportsChgPwd - SupportsServerMessages - SupportsServerSignature - SupportsTCP/IP - SupportsSuperClient -Server name: bookchan -Signature: -04 1d 65 23 04 1d 65 23 04 1d 65 23 04 1d 65 23 \&.\&.e#\&.\&.e#\&.\&.e#\&.\&.e# - -Network address: 192\&.168\&.1\&.15:548 (TCP/IP address and port) -Network address: 65280\&.128 (ddp address) -.fi -.if n \{\ -.RE -.\} -.PP -.if n \{\ -.RS 4 -.\} -.nf -\fBasip\-status\&.pl\fR myserver:10548 -AFP reply from myserver:10548 -Flags: 1 Cmd: 3 ID: 57005 -Reply: DSIGetStatus -Request ID: 57005 -Machine type: Netatalk3\&.0 -AFP versions: AFP2\&.2,AFPX03,AFP3\&.1,AFP3\&.2,AFP3\&.3 -UAMs: DHX2,DHCAST128 -Volume Icon & Mask: Yes -Flags: - SupportsCopyFile - SupportsServerMessages - SupportsServerSignature - SupportsTCP/IP - SupportsSrvrNotifications - SupportsOpenDirectory - SupportsUTF8Servername - SupportsUUIDs - SupportsExtSleep - SupportsSuperClient -Server name: myserver -Signature: -8a c6 12 3a 0e d9 95 3e 6f 31 e3 a9 17 f5 70 f6 \&.\&.\&.:\&.\&.\&.>o1\&.\&.\&.\&.p\&. - -Network address: 192\&.168\&.1\&.154:10548 (TCP/IP address and port) -UTF8 Servername: myserver -.fi -.if n \{\ -.RE -.\} -.SH "REPORTING BUGS" -.PP -Report bugs to the Netatalk\-devel list \&. diff --git a/man/man1/dbd.1 b/man/man1/dbd.1 deleted file mode 100644 index 214b31d3..00000000 --- a/man/man1/dbd.1 +++ /dev/null @@ -1,81 +0,0 @@ -'\" t -.\" Title: dbd -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 28 Dec 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "DBD" "1" "28 Dec 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -dbd \- CNID database maintenance -.SH "SYNOPSIS" -.HP \w'\fBdbd\fR\fB\fR\ 'u -\fBdbd\fR\fB\fR [\-fsv] \fIvolumepath\fR -.SH "DESCRIPTION" -.PP -\fBdbd\fR -scans all file and directories of AFP volumes, updating the CNID database of the volume\&. It must be run with appropriate permissions i\&.e\&. as root\&.\&. -.SH "OPTIONS" -.PP -\-c -.RS 4 -convert from adouble:v2 to adouble:ea -.RE -.PP -\-f -.RS 4 -delete and recreate CNID database -.RE -.PP -\-F -.RS 4 -location of the afp\&.conf config file -.RE -.PP -\-s -.RS 4 -scan volume: treat the volume as read only and don\*(Aqt perform any filesystem modifications -.RE -.PP -\-t -.RS 4 -show statistics while running -.RE -.PP -\-v -.RS 4 -verbose -.RE -.PP -\-V -.RS 4 -display version info -.RE -.SH "CNID BACKGROUND" -.PP -The CNID backends maintains name to ID mappings\&. If you change a filename outside afpd(8) (shell, samba), the CNID database will not reflect that change\&. Netatalk tries to recover from such inconsistencies as gracefully as possible\&. -.SH "SEE ALSO" -.PP -\fBcnid_metad\fR(8), -\fBcnid_dbd\fR(8) diff --git a/man/man1/dbd.1.in b/man/man1/dbd.1.in new file mode 100644 index 00000000..ad233a9b --- /dev/null +++ b/man/man1/dbd.1.in @@ -0,0 +1,81 @@ +'\" t +.\" Title: dbd +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 28 Dec 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "DBD" "1" "28 Dec 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +dbd \- CNID database maintenance +.SH "SYNOPSIS" +.HP \w'\fBdbd\fR\fB\fR\ 'u +\fBdbd\fR\fB\fR [\-fsv] \fIvolumepath\fR +.SH "DESCRIPTION" +.PP +\fBdbd\fR +scans all file and directories of AFP volumes, updating the CNID database of the volume\&. It must be run with appropriate permissions i\&.e\&. as root\&.\&. +.SH "OPTIONS" +.PP +\-c +.RS 4 +convert from adouble:v2 to adouble:ea +.RE +.PP +\-f +.RS 4 +delete and recreate CNID database +.RE +.PP +\-F +.RS 4 +location of the afp\&.conf config file +.RE +.PP +\-s +.RS 4 +scan volume: treat the volume as read only and don\*(Aqt perform any filesystem modifications +.RE +.PP +\-t +.RS 4 +show statistics while running +.RE +.PP +\-v +.RS 4 +verbose +.RE +.PP +\-V +.RS 4 +display version info +.RE +.SH "CNID BACKGROUND" +.PP +The CNID backends maintains name to ID mappings\&. If you change a filename outside afpd(8) (shell, samba), the CNID database will not reflect that change\&. Netatalk tries to recover from such inconsistencies as gracefully as possible\&. +.SH "SEE ALSO" +.PP +\fBcnid_metad\fR(8), +\fBcnid_dbd\fR(8) diff --git a/man/man1/macusers.1 b/man/man1/macusers.1 deleted file mode 100644 index 6da607b7..00000000 --- a/man/man1/macusers.1 +++ /dev/null @@ -1,54 +0,0 @@ -'\" t -.\" Title: macusers -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 13 Oct 2011 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "MACUSERS" "1" "13 Oct 2011" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -macusers \- List the users connecting via AFP -.SH "SYNOPSIS" -.HP \w'\fBmacusers\fR\fB\fR\ 'u -\fBmacusers\fR\fB\fR -.HP \w'\fBmacusers\fR\fB\fR\ 'u -\fBmacusers\fR\fB\fR \-v | \-version | \-\-version | \-h | \-help | \-\-help -.SH "DESCRIPTION" -.PP -\fBmacusers\fR -list the users connecting via AFP\&. -.SH "OPTIONS" -.PP -\fB\-v, \-version, \-\-version\fR -.RS 4 -Show version and exit -.RE -.PP -\fB\-h, \-help, \-\-help\fR -.RS 4 -Display the help and exit -.RE -.SH "SEE ALSO" -.PP -\fBafpd\fR(8) diff --git a/man/man1/macusers.1.in b/man/man1/macusers.1.in new file mode 100644 index 00000000..ed948b21 --- /dev/null +++ b/man/man1/macusers.1.in @@ -0,0 +1,54 @@ +'\" t +.\" Title: macusers +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 13 Oct 2011 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "MACUSERS" "1" "13 Oct 2011" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +macusers \- List the users connecting via AFP +.SH "SYNOPSIS" +.HP \w'\fBmacusers\fR\fB\fR\ 'u +\fBmacusers\fR\fB\fR +.HP \w'\fBmacusers\fR\fB\fR\ 'u +\fBmacusers\fR\fB\fR \-v | \-version | \-\-version | \-h | \-help | \-\-help +.SH "DESCRIPTION" +.PP +\fBmacusers\fR +list the users connecting via AFP\&. +.SH "OPTIONS" +.PP +\fB\-v, \-version, \-\-version\fR +.RS 4 +Show version and exit +.RE +.PP +\fB\-h, \-help, \-\-help\fR +.RS 4 +Display the help and exit +.RE +.SH "SEE ALSO" +.PP +\fBafpd\fR(8) diff --git a/man/man1/megatron.1 b/man/man1/megatron.1 deleted file mode 100644 index 300bd4fd..00000000 --- a/man/man1/megatron.1 +++ /dev/null @@ -1,102 +0,0 @@ -'\" t -.\" Title: megatron -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 02 Sep 2011 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "MEGATRON" "1" "02 Sep 2011" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * 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" -.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 -\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 transformation is being asked of it\&. -.PP -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\*(Aqt have a standard filename extension\&. -.PP -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\*(Aqt copy them from the server using a Macintosh for some reason\&. -.PP -If -\fBmegatron\fR -is called with any other name, it uses the default translation, namely -\fBunhex\fR\&. -.PP -If no source file is given, or if -\fIsourcefile\fR -is `\fB\-\fR\*(Aq, 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 "OPTIONS" -.PP -\fB\-v, \-\-version\fR -.RS 4 -Show version\&. -.RE -.SH "SEE ALSO" -.PP -\fBafpd\fR(8) diff --git a/man/man1/megatron.1.in b/man/man1/megatron.1.in new file mode 100644 index 00000000..9b47c228 --- /dev/null +++ b/man/man1/megatron.1.in @@ -0,0 +1,102 @@ +'\" t +.\" Title: megatron +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 02 Sep 2011 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "MEGATRON" "1" "02 Sep 2011" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * 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" +.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 +\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 transformation is being asked of it\&. +.PP +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\*(Aqt have a standard filename extension\&. +.PP +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\*(Aqt copy them from the server using a Macintosh for some reason\&. +.PP +If +\fBmegatron\fR +is called with any other name, it uses the default translation, namely +\fBunhex\fR\&. +.PP +If no source file is given, or if +\fIsourcefile\fR +is `\fB\-\fR\*(Aq, 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 "OPTIONS" +.PP +\fB\-v, \-\-version\fR +.RS 4 +Show version\&. +.RE +.SH "SEE ALSO" +.PP +\fBafpd\fR(8) diff --git a/man/man1/netatalk-config.1 b/man/man1/netatalk-config.1 deleted file mode 100644 index 7208ce26..00000000 --- a/man/man1/netatalk-config.1 +++ /dev/null @@ -1,110 +0,0 @@ -'\" t -.\" Title: netatalk-config -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 09 June 2001 -.\" Manual: The Netatalk Project -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "NETATALK\-CONFIG" "1" "09 June 2001" "Netatalk 3.0" "The Netatalk Project" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * 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 -.RS 4 -Print a short help for this command and exit\&. -.RE -.PP -\fB\-\-version\fR -.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\&. -.RE -.PP -\fB\-\-libs\-dirs\fR -.RS 4 -Print only the \-l/\-R part of \-\-libs\&. -.RE -.PP -\fB\-\-libs\-names\fR -.RS 4 -Print only the \-l part of \-\-libs\&. -.RE -.PP -\fB\-\-cflags\fR -.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 -.RS 4 -Print the -\fInetatalk\fR -m4 directory\&. -.RE -.PP -\fB\-\-prefix=PREFIX\fR -.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\&. -.PP -Man page adapted for -\fBnetatalk\-config\fR -by Sebastian Rittau in 2001\&. diff --git a/man/man1/netatalk-config.1.in b/man/man1/netatalk-config.1.in new file mode 100644 index 00000000..f4947fa6 --- /dev/null +++ b/man/man1/netatalk-config.1.in @@ -0,0 +1,110 @@ +'\" t +.\" Title: netatalk-config +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 09 June 2001 +.\" Manual: The Netatalk Project +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "NETATALK\-CONFIG" "1" "09 June 2001" "@NETATALK_VERSION@" "The Netatalk Project" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * 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 +.RS 4 +Print a short help for this command and exit\&. +.RE +.PP +\fB\-\-version\fR +.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\&. +.RE +.PP +\fB\-\-libs\-dirs\fR +.RS 4 +Print only the \-l/\-R part of \-\-libs\&. +.RE +.PP +\fB\-\-libs\-names\fR +.RS 4 +Print only the \-l part of \-\-libs\&. +.RE +.PP +\fB\-\-cflags\fR +.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 +.RS 4 +Print the +\fInetatalk\fR +m4 directory\&. +.RE +.PP +\fB\-\-prefix=PREFIX\fR +.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\&. +.PP +Man page adapted for +\fBnetatalk\-config\fR +by Sebastian Rittau in 2001\&. diff --git a/man/man1/uniconv.1.in b/man/man1/uniconv.1.in new file mode 100644 index 00000000..1ec27797 --- /dev/null +++ b/man/man1/uniconv.1.in @@ -0,0 +1,203 @@ +'\" t +.\" Title: uniconv +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 19 Jan 2013 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "UNICONV" "1" "19 Jan 2013" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * 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" +.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 +.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 +.RS 4 +don\*(Aqt HEX encode leading dots (:2e), equivalent to +\fBuse dots = yes\fR +in +\fBafp.conf\fR(5) +.RE +.PP +\-f +.RS 4 +encoding to convert from, use ASCII for HEX encoded volumes +.RE +.PP +\-h +.RS 4 +display help +.RE +.PP +\-m +.RS 4 +Macintosh client codepage, required for HEX encoded volumes\&. Defaults to "MAC_ROMAN" +.RE +.PP +\-n +.RS 4 +"dry run", don\*(Aqt do any real changes +.RE +.PP +\-t +.RS 4 +volume encoding to convert to, e\&.g\&. UTF8 +.RE +.PP +\-v +.RS 4 +verbose output, use twice for maximum logging\&. +.RE +.PP +\-V +.RS 4 +print version and exit +.RE +.PP +.SH "WARNING" +.PP +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\&. +.PP +\fBafpd\fR(8) +should +\fInot\fR +be running while you change the volume encoding\&. Remember to change +\fBunix charset\fR +or +\fBvol charset\fR +in +\fBafp.conf\fR(5) +to the new codepage, before restarting afpd\&. +.PP +In case of +\fBMacChineseTraditional\fR, +\fBMacJapanese\fR +or +\fBMacKorean\fR, uniconv cannot be used\&. +.PP +\fBUSE AT YOUR OWN RISK!!!\fR +.SH "SELECTABLE CHARSETS" +.PP +Netatalk provides internal support for UTF\-8 (pre\- and decomposed) and HEX\&. If you want to use other charsets, they must be provided by +\fBiconv\fR(1) +.PP +\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\&. +.SH "CNID BACKGROUND" +.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\*(Aqt 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 +\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: +.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 HEX 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 HEX, for MacCyrillic clients: +.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 +\fBafp.conf\fR(5),\fBafpd\fR(8),\fBiconv\fR(1),\fBcnid_metad\fR(8),\fBcnid_dbd\fR(8) diff --git a/man/man1/uniconv.1.tmpl b/man/man1/uniconv.1.tmpl deleted file mode 100644 index fabf30c6..00000000 --- a/man/man1/uniconv.1.tmpl +++ /dev/null @@ -1,203 +0,0 @@ -'\" t -.\" Title: uniconv -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 19 Jan 2013 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "UNICONV" "1" "19 Jan 2013" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * 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" -.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 -.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 -.RS 4 -don\*(Aqt HEX encode leading dots (:2e), equivalent to -\fBuse dots = yes\fR -in -\fBafp.conf\fR(5) -.RE -.PP -\-f -.RS 4 -encoding to convert from, use ASCII for HEX encoded volumes -.RE -.PP -\-h -.RS 4 -display help -.RE -.PP -\-m -.RS 4 -Macintosh client codepage, required for HEX encoded volumes\&. Defaults to "MAC_ROMAN" -.RE -.PP -\-n -.RS 4 -"dry run", don\*(Aqt do any real changes -.RE -.PP -\-t -.RS 4 -volume encoding to convert to, e\&.g\&. UTF8 -.RE -.PP -\-v -.RS 4 -verbose output, use twice for maximum logging\&. -.RE -.PP -\-V -.RS 4 -print version and exit -.RE -.PP -.SH "WARNING" -.PP -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\&. -.PP -\fBafpd\fR(8) -should -\fInot\fR -be running while you change the volume encoding\&. Remember to change -\fBunix charset\fR -or -\fBvol charset\fR -in -\fBafp.conf\fR(5) -to the new codepage, before restarting afpd\&. -.PP -In case of -\fBMacChineseTraditional\fR, -\fBMacJapanese\fR -or -\fBMacKorean\fR, uniconv cannot be used\&. -.PP -\fBUSE AT YOUR OWN RISK!!!\fR -.SH "SELECTABLE CHARSETS" -.PP -Netatalk provides internal support for UTF\-8 (pre\- and decomposed) and HEX\&. If you want to use other charsets, they must be provided by -\fBiconv\fR(1) -.PP -\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\&. -.SH "CNID BACKGROUND" -.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\*(Aqt 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 -\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: -.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 HEX 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 HEX, for MacCyrillic clients: -.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 -\fBafp.conf\fR(5),\fBafpd\fR(8),\fBiconv\fR(1),\fBcnid_metad\fR(8),\fBcnid_dbd\fR(8) diff --git a/man/man5/.gitignore b/man/man5/.gitignore index ba10eeb0..99904603 100644 --- a/man/man5/.gitignore +++ b/man/man5/.gitignore @@ -1,4 +1,3 @@ Makefile Makefile.in *.5 -*.o diff --git a/man/man5/Makefile.am b/man/man5/Makefile.am index e9066c8b..31404cdb 100644 --- a/man/man5/Makefile.am +++ b/man/man5/Makefile.am @@ -1,25 +1,9 @@ # Makefile.am for man/man5/ -pkgconfdir = @PKGCONFDIR@ +man_MANS = \ + afp.conf.5 \ + afp_signature.conf.5 \ + afp_voluuid.conf.5 \ + extmap.conf.5 -SUFFIXES = .tmpl . - -.tmpl: - sed -e "s@:SBINDIR:@${sbindir}@g" \ - -e "s@:BINDIR:@${bindir}@g" \ - -e "s@:ETCDIR:@${pkgconfdir}@g" \ - -e "s@:LIBDIR:@${libdir}@g" \ - -e "s@:STATEDIR:@${localstatedir}@g" \ - -e "s@:DEFAULT_CNID_SCHEME:@${DEFAULT_CNID_SCHEME}@g" \ - -e "s@:COMPILED_BACKENDS:@${compiled_backends}@g" \ - <$< >$@ - -GENERATED_MANS = afp.conf.5 afp_signature.conf.5 afp_voluuid.conf.5 extmap.conf.5 -TEMPLATE_FILES = afp.conf.5.tmpl afp_signature.conf.5.tmpl afp_voluuid.conf.5.tmpl extmap.conf.5.tmpl -NONGENERATED_MANS = - -man_MANS = $(GENERATED_MANS) $(NONGENERATED_MANS) - -CLEANFILES = $(GENERATED_MANS) - -EXTRA_DIST = $(TEMPLATE_FILES) $(NONGENERATED_MANS) +CLEANFILES = $(man_MANS) diff --git a/man/man5/afp.conf.5.in b/man/man5/afp.conf.5.in new file mode 100644 index 00000000..a650d5ff --- /dev/null +++ b/man/man5/afp.conf.5.in @@ -0,0 +1,1182 @@ +'\" t +.\" Title: afp.conf +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 30 Apr 2013 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "AFP\&.CONF" "5" "30 Apr 2013" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +afp.conf \- Netatalk configuration file +.SH "SYNOPSIS" +.PP +The +afp\&.conf +file is the configuration file for the +\fBNetatalk\fR +AFP file server\&. +.PP +All AFP specific configuration and AFP volume definitions are done via this file\&. +.SH "FILE FORMAT" +.PP +The file consists of sections and parameters\&. A section begins with the name of the section in square brackets and continues until the next section begins\&. Sections contain parameters of the form: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fIname\fR = \fIvalue \fR + +.fi +.if n \{\ +.RE +.\} +.PP +The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&. +.PP +Section and parameter names are case sensitive\&. +.PP +Only the first equals sign in a parameter is significant\&. Whitespace before or after the first equals sign is discarded\&. Leading, trailing and internal whitespace in section and parameter names is irrelevant\&. Leading and trailing whitespace in a parameter value is discarded\&. Internal whitespace within a parameter value is retained verbatim\&. +.PP +Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&. +.PP +Any line ending in a +\(lq \e \(rq +is continued on the next line in the customary UNIX fashion\&. +.PP +The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 1/0 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&. +.PP +The parameter +\fBinclude = \fR\fB\fIpath\fR\fR +allows you to include one config file inside another\&. The file is included literally, as though typed in place\&. Nested includes are not supported\&. +.SH "SECTION DESCRIPTIONS" +.PP +Each section in the configuration file (except for the [Global] section) describes a shared resource (known as a +\(lqvolume\(rq)\&. The section name is the name of the volume and the parameters within the section define the volume attributes and options\&. +.PP +There are two special sections, [Global] and [Homes], which are described under +\fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&. +.PP +A volume consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service\&. For volumes the +\fBpath\fR +option must specify the directory to share\&. +.PP +Any volume section without +\fBpath\fR +option is considered a +\fIvol preset\fR +which can be selected in other volume sections via the +\fBvol preset\fR +option and constitutes defaults for the volume\&. For any option specified both in a preset +\fIand\fR +in a volume section the volume section setting completely substitutes the preset option\&. +.PP +The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system\&. The server does not grant more access than the host system grants\&. +.PP +The following sample section defines an AFP volume\&. The user has full access to the path +/foo/bar\&. The share is accessed via the share name +baz: +.sp +.if n \{\ +.RS 4 +.\} +.nf + [baz] + path = /foo/bar +.fi +.if n \{\ +.RE +.\} +.SH "SPECIAL SECTIONS" +.SS "The [Global] section" +.PP +Parameters in this section apply to the server as a whole\&. Parameters denoted by a (G) below are must be set in this section\&. +.SS "The [Homes] section" +.PP +This section enable sharing of the UNIX server user home directories\&. Specifying an optional +\fBpath\fR +parameter means that not the whole user home will be shared but the subdirectory +\fBpath\fR\&. It is necessary to define the +\fBbasedir regex\fR +option\&. It should be a regex which matches the parent directory of the user homes\&. Parameters denoted by a (H) belong to volume sections\&. The optional parameter +\fBhome name\fR +can be used to change the AFP volume name which +\fI$u\*(Aqs home\fR +by default\&. See below under VARIABLE SUBSTITUTIONS\&. +.PP +The following example illustrates this\&. Given all user home directories are stored under +/home: +.sp +.if n \{\ +.RS 4 +.\} +.nf + [Homes] + path = afp\-data + basedir regex = /home +.fi +.if n \{\ +.RE +.\} +.sp +For a user +\fIjohn\fR +this results in an AFP home volume with a path of +/home/john/afp\-data\&. +.PP +If +\fBbasedir regex\fR +contains symlink, set the canonicalized absolute path\&. When +/home +links to +/usr/home: +.sp +.if n \{\ +.RS 4 +.\} +.nf + [Homes] + basedir regex = /usr/home +.fi +.if n \{\ +.RE +.\} +.SH "PARAMETERS" +.PP +Parameters define the specific attributes of sections\&. +.PP +Some parameters are specific to the [Global] section (e\&.g\&., +\fIlog type\fR)\&. All others are permissible only in volume sections\&. The letter +\fIG\fR +in parentheses indicates that a parameter is specific to the [Global] section\&. The letter +\fIV\fR +indicates that a parameter can be specified in a volume specific section\&. +.SH "VARIABLE SUBSTITUTIONS" +.PP +You can use variables in volume names\&. The use of variables in paths is not supported for now\&. +.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\*(Aqt have a value, it will get ignored\&. +.RE +.PP +The variables which can be used for substitutions are: +.PP +$b +.RS 4 +basename +.RE +.PP +$c +.RS 4 +client\*(Aqs ip address +.RE +.PP +$d +.RS 4 +volume pathname on server +.RE +.PP +$f +.RS 4 +full name (contents of the gecos field in the passwd file) +.RE +.PP +$g +.RS 4 +group name +.RE +.PP +$h +.RS 4 +hostname +.RE +.PP +$i +.RS 4 +client\*(Aqs ip, without port +.RE +.PP +$s +.RS 4 +server name (this can be the hostname) +.RE +.PP +$u +.RS 4 +user name (if guest, it is the user that guest is running as) +.RE +.PP +$v +.RS 4 +volume name +.RE +.PP +$$ +.RS 4 +prints dollar sign ($) +.RE +.SH "EXPLANATION OF GLOBAL PARAMETERS" +.SS "Authentication Options" +.PP +ad domain = \fIDOMAIN\fR \fB(G)\fR +.RS 4 +Append @DOMAIN to username when authenticating\&. Useful in Active Directory environments that otherwise would require the user to enter the full user@domain string\&. +.RE +.PP +admin auth user = \fIuser\fR \fB(G)\fR +.RS 4 +Specifying eg "\fBadmin auth user = root\fR" whenever a normal user login fails, afpd will try to authenticate as the specified +\fBadmin auth user\fR\&. If this succeeds, a normal session is created for the original connecting user\&. Said differently: if you know the password of +\fBadmin auth user\fR, you can authenticate as any other user\&. +.RE +.PP +k5 keytab = \fIpath\fR \fB(G)\fR, k5 service = \fIservice\fR \fB(G)\fR, k5 realm = \fIrealm\fR \fB(G)\fR +.RS 4 +These are required if the server supports the Kerberos 5 authentication UAM\&. +.RE +.PP +nt domain = \fIDOMAIN\fR \fB(G)\fR, nt separator = \fISEPARATOR\fR \fB(G)\fR +.RS 4 +Use for eg\&. winbind authentication, prepends both strings before the username from login and then tries to authenticate with the result through the available and active UAM authentication modules\&. +.RE +.PP +save password = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR +.RS 4 +Enables or disables the ability of clients to save passwords locally\&. +.RE +.PP +set password = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR +.RS 4 +Enables or disables the ability of clients to change their passwords via chooser or the "connect to server" dialog\&. +.RE +.PP +uam list = \fIuam list\fR \fB(G)\fR +.RS 4 +Space or comma separated list of UAMs\&. (The default is "uams_dhx\&.so uams_dhx2\&.so")\&. +.sp +The most commonly used UAMs are: +.PP +uams_guest\&.so +.RS 4 +allows guest logins +.RE +.PP +uams_clrtxt\&.so +.RS 4 +(uams_pam\&.so or uams_passwd\&.so) Allow logins with passwords transmitted in the clear\&. (legacy) +.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 @pkgconfdir@/afppasswd file or the one specified via "\fBpasswd file\fR"\&. See +\fBafppasswd\fR(1) +for details\&. (legacy) +.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 +uams_dhx2\&.so +.RS 4 +(uams_dhx2_pam\&.so or uams_dhx2_passwd\&.so) Allow Diffie\-Hellman eXchange 2 (DHX2) for authentication\&. +.RE +.PP +uam_gss\&.so +.RS 4 +Allow Kerberos V for authentication (optional) +.RE +.RE +.PP +uam path = \fIpath\fR \fB(G)\fR +.RS 4 +Sets the default path for UAMs for this server (default is @libdir@/netatalk)\&. +.RE +.SS "Charset Options" +.PP +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 charsets like MacRoman, MacCentralEurope, etc\&. +.PP +To be able to serve AFP3 and older clients at the same time, +\fBafpd\fR +needs to be able to convert between UTF\-8 and Mac charsets\&. Even OS X clients partly still rely on the mac charset\&. As there\*(Aqs no way, +\fBafpd\fR +can detect the codepage a pre AFP3 client uses, you have to specify it using the +\fBmac charset\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\*(Aqs to be able to convert from UTF8\-MAC / Mac charset to the UNIX charset\&. By default +\fBafpd\fR +uses +\fIUTF8\fR\&. You can set the UNIX charset using the +\fBunix charset\fR +option\&. If you\*(Aqre using extended characters in the configuration files for +\fBafpd\fR, make sure your terminal matches the +\fBunix charset\fR\&. +.PP +mac charset = \fICHARSET\fR \fB(G)/(V)\fR +.RS 4 +Specifies the Mac clients charset, e\&.g\&. +\fIMAC_ROMAN\fR\&. 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 +\fBmac charset\fR\&. Defaults to +\fIMAC_ROMAN\fR\&. +.RE +.PP +unix charset = \fICHARSET\fR \fB(G)\fR +.RS 4 +Specifies the servers unix charset, e\&.g\&. +\fIISO\-8859\-15\fR +or +\fIEUC\-JP\fR\&. This is used to convert strings to/from the systems locale, e\&.g\&. for authentication, server messages and volume names\&. If +\fILOCALE\fR +is set, the systems locale is used\&. Defaults to +\fIUTF8\fR\&. +.RE +.PP +vol charset = \fICHARSET\fR \fB(G)/(V)\fR +.RS 4 +Specifies the encoding of the volumes filesystem\&. By default, it is the same as +\fBunix charset\fR\&. +.RE +.SS "Password Options" +.PP +passwd file = \fIpath\fR \fB(G)\fR +.RS 4 +Sets the path to the Randnum UAM passwd file for this server (default is @pkgconfdir@/afppasswd)\&. +.RE +.PP +passwd minlen = \fInumber\fR \fB(G)\fR +.RS 4 +Sets the minimum password length, if supported by the UAM +.RE +.SS "Network Options" +.PP +advertise ssh = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR +.RS 4 +Allows old 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\*(Aqs answers to client\*(Aqs FPGetSrvrInfo requests contain an additional entry\&. It depends on both client\*(Aqs 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 +.ps -1 +.br +Setting this option is not recommended since globally encrypting AFP connections via SSH will increase the server\*(Aqs load significantly\&. On the other hand, Apple\*(Aqs client side implementation of this feature in MacOS X versions prior to 10\&.3\&.4 contained a security flaw\&. +.sp .5v +.RE +.RE +.PP +afp listen = \fIip address[:port] [ip address[:port] \&.\&.\&.]\fR \fB(G)\fR +.RS 4 +Specifies the IP address that the server should advertise +\fBand\fR +listens to\&. The default is advertise the first IP address of the system, but to listen for any incoming request\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&. +.RE +.PP +afp port = \fIport number\fR \fB(G)\fR +.RS 4 +Allows a different TCP port to be used for AFP\&. The default is 548\&. Also sets the default port applied when none specified in an +\fBafp listen\fR +option\&. +.RE +.PP +cnid listen = \fIip address[:port] [ip address[:port] \&.\&.\&.]\fR \fB(G)\fR +.RS 4 +Specifies the IP address that the CNID server should listen on\&. The default is +\fBlocalhost:4700\fR\&. +.RE +.PP +disconnect time = \fInumber\fR \fB(G)\fR +.RS 4 +Keep disconnected AFP sessions for +\fInumber\fR +hours before dropping them\&. Default is 24 hours\&. +.RE +.PP +dsireadbuf = \fInumber\fR \fB(G)\fR +.RS 4 +Scale factor that determines the size of the DSI/TCP readahead buffer, default is 12\&. This is multiplies with the DSI server quantum (default ~300k) to give the size of the buffer\&. Increasing this value might increase throughput in fast local networks for volume to volume copies\&. +\fINote\fR: This buffer is allocated per afpd child process, so specifying large values will eat up large amount of memory (buffer size * number of clients)\&. +.RE +.PP +fqdn = \fIname:port\fR \fB(G)\fR +.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 +hostname = \fIname\fR \fB(G)\fR +.RS 4 +Use this instead of the result from calling hostname for determining which IP address to advertise, therefore the hostname is resolved to an IP which is the advertised\&. This is NOT used for listening and it is also overwritten by +\fBafp listen\fR\&. +.RE +.PP +max connections = \fInumber\fR \fB(G)\fR +.RS 4 +Sets the maximum number of clients that can simultaneously connect to the server (default is 200)\&. +.RE +.PP +server quantum = \fInumber\fR \fB(G)\fR +.RS 4 +This specifies the DSI server quantum\&. The default value is 1 MB\&. The maximum value is 0xFFFFFFFFF, the minimum is 32000\&. If you specify a value that is out of range, the default value will be set\&. Do not change this value unless you\*(Aqre absolutely sure, what you\*(Aqre doing +.RE +.PP +sleep time = \fInumber\fR \fB(G)\fR +.RS 4 +Keep sleeping AFP sessions for +\fInumber\fR +hours before disconnecting clients in sleep mode\&. Default is 10 hours\&. +.RE +.PP +tcprcvbuf = \fInumber\fR \fB(G)\fR +.RS 4 +Try to set TCP receive buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&. +.RE +.PP +tcpsndbuf = \fInumber\fR \fB(G)\fR +.RS 4 +Try to set TCP send buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&. +.RE +.PP +use sendfile = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR +.RS 4 +Whether to use sendfile +syscall for sending file data to clients\&. +.RE +.PP +zeroconf = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR +.RS 4 +Whether to use automatic Zeroconf +service registration if Avahi or mDNSResponder were compiled in\&. +.RE +.SS "Miscellaneous Options" +.PP +admin group = \fIgroup\fR \fB(G)\fR +.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 +afp read locks = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR +.RS 4 +Whether to apply locks to the byte region read in FPRead calls\&. The AFP spec mandates this, but it\*(Aqs not really in line with UNIX semantics and is a performance hug\&. +.RE +.PP +afpstats = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR +.RS 4 +Whether to provide AFP runtime statistics (connected users, open volumes) via dbus\&. +.RE +.PP +basedir regex = \fIregex\fR \fB(H)\fR +.RS 4 +Regular expression which matches the parent directory of the user homes\&. If +\fBbasedir regex\fR +contains symlink, you must set the canonicalized absolute path\&. In the simple case this is just a path ie +\fBbasedir regex = /home\fR +.RE +.PP +close vol = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR +.RS 4 +Whether to close volumes possibly opened by clients when they\*(Aqre removed from the configuration and the configuration is reloaded\&. +.RE +.PP +cnid server = \fIipaddress[:port]\fR \fB(G)/(V)\fR +.RS 4 +Specifies the IP address and port of a cnid_metad server, required for CNID dbd backend\&. Defaults to localhost:4700\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.\- +.RE +.PP +dircachesize = \fInumber\fR \fB(G)\fR +.RS 4 +Maximum possible entries in the directory cache\&. The cache stores directories and files\&. It is used to cache the full path to directories and CNIDs which considerably speeds up directory enumeration\&. +.sp +Default size is 8192, maximum size is 131072\&. Given value is rounded up to nearest power of 2\&. Each entry takes about 100 bytes, which is not much, but remember that every afpd child process for every connected user has its cache\&. +.RE +.PP +extmap file = \fIpath\fR \fB(G)\fR +.RS 4 +Sets the path to the file which defines file extension type/creator mappings\&. (default is @pkgconfdir@/extmap\&.conf)\&. +.RE +.PP +guest account = \fIname\fR \fB(G)\fR +.RS 4 +Specifies the user that guests should use (default is "nobody")\&. The name should be quoted\&. +.RE +.PP +home name = \fIname\fR \fB(H)\fR +.RS 4 +AFP user home volume name\&. The default is +\fIuser\*(Aqs home\fR\&. +.RE +.PP +login message = \fImessage\fR \fB(G)/(V)\fR +.RS 4 +Sets a message to be displayed when clients logon to the server\&. The message should be in +\fBunix charset\fR +and should be quoted\&. Extended characters are allowed\&. +.RE +.PP +mimic model = \fImodel\fR \fB(G)\fR +.RS 4 +Specifies the icon model that appears on clients\&. Defaults to off\&. Note that afpd must support Zeroconf\&. Examples: RackMac (same as Xserve), PowerBook, PowerMac, Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro, AppleTV1,1, AirPort\&. +.RE +.PP +signature = \fB(G)\fR +.RS 4 +Specify a server signature\&. The maximum length is 16 characters\&. This option is useful for clustered environments, to provide fault isolation etc\&. By default, afpd generate signature and saving it to +@localstatedir@/netatalk/afp_signature\&.conf +automatically (based on random number)\&. See also asip\-status\&.pl(1)\&. +.RE +.PP +solaris share reservations = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR +.RS 4 +Use share reservations on Solaris\&. Solaris CIFS server uses this too, so this makes a lock coherent multi protocol server\&. +.RE +.PP +vol dbpath = \fIpath\fR \fB(G)\fR +.RS 4 +Sets the database information to be stored in path\&. You have to specify a writable location, even if the volume is read only\&. The default is +@localstatedir@/netatalk/CNID/\&. +.RE +.PP +volnamelen = \fInumber\fR \fB(G)\fR +.RS 4 +Max length of UTF8\-MAC volume name for Mac OS X\&. Note that Hangul is especially sensitive to this\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + 73: limit of Mac OS X 10\&.1 80: limit of Mac + OS X 10\&.4/10\&.5 (default) 255: limit of recent Mac OS + X +.fi +.if n \{\ +.RE +.\} +.sp +Mac OS 9 and earlier are not influenced by this, because Maccharset volume name is always limited to 27 bytes\&. +.RE +.PP +vol preset = \fIname\fR \fB(G)/(V)\fR +.RS 4 +Use section +\fBname\fR +as option preset for all volumes (when set in the [Global] section) or for one volume (when set in that volume\*(Aqs section)\&. +.RE +.SS "Logging Options" +.PP +log file = \fIlogfile\fR \fB(G)\fR +.RS 4 +If not specified Netatalk logs to syslogs daemon facility\&. Otherwise it logs to +\fBlogfile\fR\&. +.RE +.PP +log level = \fItype:level [type:level \&.\&.\&.]\fR \fB(G)\fR, log level = \fItype:level,[type:level, \&.\&.\&.]\fR \fB(G)\fR +.RS 4 +Specify that any message of a loglevel up to the given +\fBlog level\fR +should be logged\&. +.sp +By default afpd logs to syslog with a default logging setup equivalent to +\fBdefault:note\fR +.sp +logtypes: default, afpdaemon, logger, uamsdaemon +.sp +loglevels: severe, error, warn, note, info, debug, debug6, debug7, debug8, debug9, maxdebug +.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 +Both logtype and loglevels are case insensitive\&. +.sp .5v +.RE +.RE +.SS "Filesystem Change Events (FCE)" +.PP +Netatalk includes a nifty filesystem change event mechanism where afpd processes notify interested listeners about certain filesystem event by UDP network datagrams\&. +.PP +fce listener = \fIhost[:port]\fR \fB(G)\fR +.RS 4 +Enables sending FCE events to the specified +\fIhost\fR, default +\fIport\fR +is 12250 if not specified\&. Specifying multiple listeners is done by having this option once for each of them\&. +.RE +.PP +fce events = \fIfmod,fdel,ddel,fcre,dcre,tmsz\fR \fB(G)\fR +.RS 4 +Specifies which FCE events are active, default is +\fIfmod,fdel,ddel,fcre,dcre\fR\&. +.RE +.PP +fce coalesce = \fIall|delete|create\fR \fB(G)\fR +.RS 4 +Coalesce FCE events\&. +.RE +.PP +fce holdfmod = \fIseconds\fR \fB(G)\fR +.RS 4 +This determines the time delay in seconds which is always waited if another file modification for the same file is done by a client before sending an FCE file modification event (fmod)\&. For example saving a file in Photoshop would generate multiple events by itself because the application is opening, modifying and closing a file multiple times for every "save"\&. Default: 60 seconds\&. +.RE +.SS "Debug Parameters" +.PP +These options are useful for debugging only\&. +.PP +tickleval = \fInumber\fR \fB(G)\fR +.RS 4 +Sets the tickle timeout interval (in seconds)\&. Defaults to 30\&. +.RE +.PP +timeout = \fInumber\fR \fB(G)\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 +.PP +client polling = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR +.RS 4 +With this option enabled, afpd won\*(Aqt 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\*(Aqs speed, this can lead to a significant higher load on your network! +.sp +Do not use this option any longer as present Netatalk correctly supports server notifications, allowing connected clients to update folder listings in case another client changed the contents\&. +.RE +.SS "Options for ACL handling" +.PP +By default, the effective permission of the authenticated user are only mapped to the mentioned UARights permission structure, not the UNIX mode\&. You can adjust this behaviour with the configuration option +\fBmac acls\fR: +.PP +map acls = \fInone|rights|mode\fR \fB(G)\fR +.RS 4 +.PP +none +.RS 4 +no mapping of ACLs +.RE +.PP +rights +.RS 4 +effective permissions are mapped to UARights structure\&. This is the default\&. +.RE +.PP +mode +.RS 4 +ACLs are additionally mapped to the UNIX mode of the filesystem object\&. +.RE +.RE +.PP +If you want to be able to display ACLs on the client, you must setup both client and server as part on a authentication domain (directory service, eg LDAP, Open Directory, Active Directory)\&. The reason is, in OS X ACLs are bound to UUIDs, not just uid\*(Aqs or gid\*(Aqs\&. Therefor Netatalk must be able to map every filesystem uid and gid to a UUID so that it can return the server side ACLs which are bound to UNIX uid and gid mapped to OS X UUIDs\&. +.PP +Netatalk can query a directory server using LDAP queries\&. Either the directory server already provides an UUID attribute for user and groups (Active Directory, Open Directory) or you reuse an unused attribute (or add a new one) to you directory server (eg OpenLDAP)\&. +.PP +The following LDAP options must be configured for Netatalk: +.PP +ldap auth method = \fInone|simple|sasl\fR \fB(G)\fR +.RS 4 +Authentication method: +\fBnone | simple | sasl\fR +.PP +none +.RS 4 +anonymous LDAP bind +.RE +.PP +simple +.RS 4 +simple LDAP bind +.RE +.PP +sasl +.RS 4 +SASL\&. Not yet supported ! +.RE +.RE +.PP +ldap auth dn = \fIdn\fR \fB(G)\fR +.RS 4 +Distinguished Name of the user for simple bind\&. +.RE +.PP +ldap auth pw = \fIpassword\fR \fB(G)\fR +.RS 4 +Distinguished Name of the user for simple bind\&. +.RE +.PP +ldap server = \fIhost\fR \fB(G)\fR +.RS 4 +Name or IP address of your LDAP Server\&. This is only needed for explicit ACL support in order to be able to query LDAP for UUIDs\&. +.sp +You can use +\fBafpldaptest\fR(1) +to syntactically check your config\&. +.RE +.PP +ldap userbase = \fIbase dn\fR \fB(G)\fR +.RS 4 +DN of the user container in LDAP\&. +.RE +.PP +ldap userscope = \fIscope\fR \fB(G)\fR +.RS 4 +Search scope for user search: +\fBbase | one | sub\fR +.RE +.PP +ldap groupbase = \fIbase dn\fR \fB(G)\fR +.RS 4 +DN of the group container in LDAP\&. +.RE +.PP +ldap groupscope = \fIscope\fR \fB(G)\fR +.RS 4 +Search scope for user search: +\fBbase | one | sub\fR +.RE +.PP +ldap uuid attr = \fIdn\fR \fB(G)\fR +.RS 4 +Name of the LDAP attribute with the UUIDs\&. +.sp +Note: this is used both for users and groups\&. +.RE +.PP +ldap name attr = \fIdn\fR \fB(G)\fR +.RS 4 +Name of the LDAP attribute with the users short name\&. +.RE +.PP +ldap uuid string = \fISTRING\fR \fB(G)\fR +.RS 4 +Format of the uuid string in the directory\&. A series of x and \-, where every x denotes a value 0\-9a\-f and every \- is a separator\&. +.sp +Default: xxxxxxxx\-xxxx\-xxxx\-xxxx\-xxxxxxxxxxxx +.RE +.PP +ldap uuid encoding = \fIstring | ms\-guid (default: string)\fR \fB(G)\fR +.RS 4 +Format of the UUID of the LDAP attribute, allows usage of the binary objectGUID fields from Active Directory\&. If left unspecified, string is the default, which passes through the ASCII UUID returned by most other LDAP stores\&. If set to ms\-guid, the internal UUID representation is converted to and from the binary format used in the objectGUID attribute found on objects in Active Directory when interacting with the server\&. +.PP +string +.RS 4 +UUID is a string, use with eg OpenDirectory\&. +.RE +.PP +ms\-guid +.RS 4 +Binary objectGUID from Active Directory +.RE +.RE +.PP +ldap group attr = \fIdn\fR \fB(G)\fR +.RS 4 +Name of the LDAP attribute with the groups short name\&. +.RE +.SH "EXPLANATION OF VOLUME PARAMETERS" +.SS "Parameters" +.PP +The section name defines the volume name\&. No two volumes may have the same name\&. The volume name cannot contain the +\*(Aq:\*(Aq +character\&. The volume name is mangled if it is very long\&. Mac charset volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to volnamelen parameter\&. +.PP +path = \fIPATH\fR \fB(V)\fR +.RS 4 +The path name must be a fully qualified path name\&. +.RE +.PP +appledouble = \fIea|v2\fR \fB(V)\fR +.RS 4 +Specify the format of the metadata files, which are used for saving Mac resource fork as well\&. Earlier versions used AppleDouble v2, the new default format is +\fBea\fR\&. +.RE +.PP +vol size limit = \fIsize in MiB\fR \fB(V)\fR +.RS 4 +Useful for Time Machine: limits the reported volume size, thus preventing Time Machine from using the whole real disk space for backup\&. Example: "vol size limit = 1000" would limit the reported disk space to 1 GB\&. +\fBIMPORTANT: \fR +This is an approximated calculation taking into account the contents of Time Machine sparsebundle images\&. Therefor you MUST NOT use this volume to store other content when using this option, because it would NOT be accounted\&. The calculation works by reading the band size from the Info\&.plist XML file of the sparsebundle, reading the bands/ directory counting the number of band files, and then multiplying one with the other\&. +.RE +.PP +valid users = \fIuser @group\fR \fB(V)\fR +.RS 4 +The allow option allows the users and groups that access a share to be specified\&. Users and groups are specified, delimited by spaces or commas\&. Groups are designated by a @ prefix\&. Names may be quoted in order to allow for spaces in names\&. Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +valid users = user "user 2" @group \(lq@group 2" +.fi +.if n \{\ +.RE +.\} +.RE +.PP +invalid users = \fIusers/groups\fR \fB(V)\fR +.RS 4 +The deny option specifies users and groups who are not allowed access to the share\&. It follows the same format as the "valid users" option\&. +.RE +.PP +hosts allow = \fIIP host address/IP netmask bits [ \&.\&.\&. ]\fR \fB(V)\fR +.RS 4 +Only listed hosts and networks are allowed, all others are rejected\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&. +.sp +Example: hosts allow = 10\&.1\&.0\&.0/16 10\&.2\&.1\&.100 2001:0db8:1234::/48 +.RE +.PP +hosts deny = \fIIP host address/IP netmask bits [ \&.\&.\&. ]\fR \fB(V)\fR +.RS 4 +Listed hosts and nets are rejected, all others are allowed\&. +.sp +Example: hosts deny = 192\&.168\&.100/24 10\&.1\&.1\&.1 2001:db8::1428:57ab +.RE +.PP +cnid scheme = \fIbackend\fR \fB(V)\fR +.RS 4 +set the CNID backend to be used for the volume, default is [@DEFAULT_CNID_SCHEME@] available schemes: [@compiled_backends@] +.RE +.PP +ea = \fInone|auto|sys|ad\fR \fB(V)\fR +.RS 4 +Specify how Extended Attributes +are stored\&. +\fBauto\fR +is the default\&. +.PP +auto +.RS 4 +Try +\fBsys\fR +(by setting an EA on the shared directory itself), fallback to +\fBad\fR\&. Requires writable volume for performing test\&. "\fBread only = yes\fR" overwrites +\fBauto\fR +with +\fBnone\fR\&. Use explicit "\fBea = sys|ad\fR" for read\-only volumes where appropriate\&. +.RE +.PP +sys +.RS 4 +Use filesystem Extended Attributes\&. +.RE +.PP +ad +.RS 4 +Use files in +\fI\&.AppleDouble\fR +directories\&. +.RE +.PP +none +.RS 4 +No Extended Attributes support\&. +.RE +.RE +.PP +mac charset = \fICHARSET\fR \fB(V)\fR +.RS 4 +specifies the Mac client charset for this Volume, e\&.g\&. +\fIMAC_ROMAN\fR, +\fIMAC_CYRILLIC\fR\&. If not specified the global setting is applied\&. This setting is only required if you need volumes, where the Mac charset differs from the one globally set in the [Global] section\&. +.RE +.PP +casefold = \fBoption\fR \fB(V)\fR +.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 +password = \fIpassword\fR \fB(V)\fR +.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 +file perm = \fImode\fR \fB(V)\fR, directory perm = \fImode\fR \fB(V)\fR +.RS 4 +Add(or) with the client requested permissions: +\fBfile perm\fR +is for files only, +\fBdirectory perm\fR +is for directories only\&. Don\*(Aqt use with "\fBunix priv = no\fR"\&. +.PP +\fBExample.\ \&Volume for a collaborative workgroup\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +file perm = 0660 directory perm = + 0770 +.fi +.if n \{\ +.RE +.\} + +.RE +.PP +umask = \fImode\fR \fB(V)\fR +.RS 4 +set perm mask\&. Don\*(Aqt use with "\fBunix priv = no\fR"\&. +.RE +.PP +preexec = \fIcommand\fR \fB(V)\fR +.RS 4 +command to be run when the volume is mounted, ignored for user defined volumes +.RE +.PP +postexec = \fIcommand\fR \fB(V)\fR +.RS 4 +command to be run when the volume is closed, ignored for user defined volumes +.RE +.PP +root preexec = \fIcommand\fR \fB(V)\fR +.RS 4 +command to be run as root when the volume is mounted, ignored for user defined volumes +.RE +.PP +root postexec = \fIcommand\fR \fB(V)\fR +.RS 4 +command to be run as root when the volume is closed, ignored for user defined volumes +.RE +.PP +rolist = \fBusers/groups\fR \fB(V)\fR +.RS 4 +Allows certain users and groups to have read\-only access to a share\&. This follows the allow option format\&. +.RE +.PP +rwlist = \fIusers/groups\fR \fB(V)\fR +.RS 4 +Allows certain users and groups to have read/write access to a share\&. This follows the allow option format\&. +.RE +.PP +veto files = \fIvetoed names\fR \fB(V)\fR +.RS 4 +hide files and directories,where the path matches one of the \*(Aq/\*(Aq delimited vetoed names\&. The veto string must always be terminated with a \*(Aq/\*(Aq, eg\&. "veto1/", "veto1/veto2/"\&. +.RE +.SS "Volume options" +.PP +Boolean volume options\&. +.PP +acls = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR +.RS 4 +Whether to flag volumes as supporting ACLs\&. If ACL support is compiled in, this is yes by default\&. +.RE +.PP +cnid dev = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR +.RS 4 +Whether to use the device number in the CNID backends\&. Helps when the device number is not constant across a reboot, eg cluster, \&.\&.\&. +.RE +.PP +convert appledouble = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR +.RS 4 +Whether automatic conversion from +\fBappledouble = v2\fR +to +\fBappledouble = ea\fR +is performed when accessing filesystems from clients\&. This is generally useful, but costs some performance\&. It\*(Aqs recommendable to run +\fBdbd\fR +on volumes and do the conversion with that\&. Then this option can be set to no\&. +.RE +.PP +follow symlinks = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR +.RS 4 +The default setting is false thus symlinks are not followed on the server\&. This is the same behaviour as OS X\*(Aqs AFP server\&. Setting the option to true causes afpd to follow symlinks on the server\&. symlinks may point outside of the AFP volume, currently afpd doesn\*(Aqt do any checks for "wide symlinks"\&. +.RE +.PP +invisible dots = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR +.RS 4 +make dot files invisible\&. WARNING: enabling this option will lead to unwanted sideeffects were OS X applications when saving files to a temporary file starting with a dot first, then renaming the temp file to its final name, result in the saved file being invisible\&. The only thing this option is useful for is making files that start with a dot invisible on Mac OS 9\&. It\*(Aqs completely useless on Mac OS X, as both in Finder and in Terminal files starting with a dot are hidden anyway\&. +.RE +.PP +network ids = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR +.RS 4 +Whether the server support network ids\&. Setting this to +\fIno\fR +will result in the client not using ACL AFP functions\&. +.RE +.PP +preexec close = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR +.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 +read only = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR +.RS 4 +Specifies the share as being read only for all users\&. Overwrites +\fBea = auto\fR +with +\fBea = none\fR +.RE +.PP +root preexec close= \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR +.RS 4 +A non\-zero return code from root_preexec closes the volume immediately, preventing clients to mount/see the volume in question\&. +.RE +.PP +search db = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR +.RS 4 +Use fast CNID database namesearch instead of slow recursive filesystem search\&. Relies on a consistent CNID database, ie Samba or local filesystem access lead to inaccurate or wrong results\&. Works only for "dbd" CNID db volumes\&. +.RE +.PP +stat vol = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR +.RS 4 +Whether to stat volume path when enumerating volumes list, useful for automounting or volumes created by a preexec script\&. +.RE +.PP +time machine = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR +.RS 4 +Whether to enable Time Machine support for this volume\&. +.RE +.PP +unix priv = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR +.RS 4 +Whether to use AFP3 UNIX privileges\&. This should be set for OS X clients\&. See also: +\fBfile perm\fR, +\fBdirectory perm\fR +and +\fBumask\fR\&. +.RE +.SH "CNID BACKENDS" +.PP +The AFP protocol mostly refers to files and directories by ID and not by name\&. Netatalk needs a way to store these ID\*(Aqs in a persistent way, to achieve this several different CNID backends are available\&. The CNID Databases are by default located in the +@localstatedir@/netatalk/CNID/(volumename)/\&.AppleDB/ +directory\&. +.PP +cdb +.RS 4 +"Concurrent database", backend is based on Oracle Berkley DB\&. With this backend several +\fBafpd\fR +daemons 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 +\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 +.RS 4 +This backend is an exception, in terms of ID persistency\&. ID\*(Aqs 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\&. Starting with Netatalk 3\&.0, it becomes the +\fIread only mode\fR +automatically\&. +.sp +\fBWarning\fR: It is +\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\*(Aqt use them unless you know what you\*(Aqre doing, they may be removed without further notice from future versions\&. +.SH "CHARSET OPTIONS" +.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\&. \*(Aq/\*(Aq will be encoded to +:2f, if +\fBusedots\fR +is not specified, a leading dot \*(Aq\&.\*(Aq will be encoded as +:2e\&. +.PP +This version now uses UTF\-8 as the default encoding for names\&. \*(Aq/\*(Aq will be converted to \*(Aq:\*(Aq\&. +.PP +The +\fBvol charset\fR +option will allow you to select another volume encoding\&. E\&.g\&. for western users another useful setting could be vol charset ISO\-8859\-15\&. +\fBafpd\fR +will accept any +\fBiconv\fR(1) +provided charset\&. If a character cannot be converted from the +\fBmac charset\fR +to the selected +\fBvol charset\fR, afpd will save it as a CAP encoded character\&. For AFP3 clients, +\fBafpd\fR +will convert the UTF\-8 +character to +\fBmac charset\fR +first\&. If this conversion fails, you\*(Aqll receive a \-50 error on the mac\&. +.PP +\fINote\fR: Whenever you can, please stick with the default UTF\-8 volume format\&. +.SH "SEE ALSO" +.PP +\fBafpd\fR(8), +\fBafppasswd\fR(5), +\fBafp_signature.conf\fR(5), +\fBextmap.conf\fR(5), +\fBcnid_metad\fR(8) diff --git a/man/man5/afp.conf.5.tmpl b/man/man5/afp.conf.5.tmpl deleted file mode 100644 index 60ec8d0e..00000000 --- a/man/man5/afp.conf.5.tmpl +++ /dev/null @@ -1,1171 +0,0 @@ -'\" t -.\" Title: afp.conf -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 19 Feb 2013 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "AFP\&.CONF" "5" "19 Feb 2013" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -afp.conf \- Netatalk configuration file -.SH "SYNOPSIS" -.PP -The -afp\&.conf -file is the configuration file for the -\fBNetatalk\fR -AFP file server\&. -.PP -All AFP specific configuration and AFP volume definitions are done via this file\&. -.SH "FILE FORMAT" -.PP -The file consists of sections and parameters\&. A section begins with the name of the section in square brackets and continues until the next section begins\&. Sections contain parameters of the form: -.sp -.if n \{\ -.RS 4 -.\} -.nf - \fIname\fR = \fIvalue \fR - -.fi -.if n \{\ -.RE -.\} -.PP -The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&. -.PP -Section and parameter names are case sensitive\&. -.PP -Only the first equals sign in a parameter is significant\&. Whitespace before or after the first equals sign is discarded\&. Leading, trailing and internal whitespace in section and parameter names is irrelevant\&. Leading and trailing whitespace in a parameter value is discarded\&. Internal whitespace within a parameter value is retained verbatim\&. -.PP -Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&. -.PP -Any line ending in a -\(lq \e \(rq -is continued on the next line in the customary UNIX fashion\&. -.PP -The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 1/0 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&. -.PP -The parameter -\fBinclude = \fR\fB\fIpath\fR\fR -allows you to include one config file inside another\&. The file is included literally, as though typed in place\&. Nested includes are not supported\&. -.SH "SECTION DESCRIPTIONS" -.PP -Each section in the configuration file (except for the [Global] section) describes a shared resource (known as a -\(lqvolume\(rq)\&. The section name is the name of the volume and the parameters within the section define the volume attributes and options\&. -.PP -There are two special sections, [Global] and [Homes], which are described under -\fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&. -.PP -A volume consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service\&. For volumes the -\fBpath\fR -option must specify the directory to share\&. -.PP -Any volume section without -\fBpath\fR -option is considered a -\fIvol preset\fR -which can be selected in other volume sections via the -\fBvol preset\fR -option and constitutes defaults for the volume\&. For any option specified both in a preset -\fIand\fR -in a volume section the volume section setting completely substitutes the preset option\&. -.PP -The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system\&. The server does not grant more access than the host system grants\&. -.PP -The following sample section defines an AFP volume\&. The user has full access to the path -/foo/bar\&. The share is accessed via the share name -baz: -.sp -.if n \{\ -.RS 4 -.\} -.nf - [baz] - path = /foo/bar -.fi -.if n \{\ -.RE -.\} -.SH "SPECIAL SECTIONS" -.SS "The [Global] section" -.PP -Parameters in this section apply to the server as a whole\&. Parameters denoted by a (G) below are must be set in this section\&. -.SS "The [Homes] section" -.PP -This section enable sharing of the UNIX server user home directories\&. Specifying an optional -\fBpath\fR -parameter means that not the whole user home will be shared but the subdirectory -\fBpath\fR\&. It is necessary to define the -\fBbasedir regex\fR -option\&. It should be a regex which matches the parent directory of the user homes\&. Parameters denoted by a (H) belong to volume sections\&. The optional parameter -\fBhome name\fR -can be used to change the AFP volume name which -\fI$u\*(Aqs home\fR -by default\&. See below under VARIABLE SUBSTITUTIONS\&. -.PP -The following example illustrates this\&. Given all user home directories are stored under -/home: -.sp -.if n \{\ -.RS 4 -.\} -.nf - [Homes] - path = afp\-data - basedir regex = /home -.fi -.if n \{\ -.RE -.\} -.sp -For a user -\fIjohn\fR -this results in an AFP home volume with a path of -/home/john/afp\-data\&. -.PP -If -\fBbasedir regex\fR -contains symlink, set the canonicalized absolute path\&. When -/home -links to -/usr/home: -.sp -.if n \{\ -.RS 4 -.\} -.nf - [Homes] - basedir regex = /usr/home -.fi -.if n \{\ -.RE -.\} -.SH "PARAMETERS" -.PP -Parameters define the specific attributes of sections\&. -.PP -Some parameters are specific to the [Global] section (e\&.g\&., -\fIlog type\fR)\&. All others are permissible only in volume sections\&. The letter -\fIG\fR -in parentheses indicates that a parameter is specific to the [Global] section\&. The letter -\fIV\fR -indicates that a parameter can be specified in a volume specific section\&. -.SH "VARIABLE SUBSTITUTIONS" -.PP -You can use variables in volume names\&. The use of variables in paths is not supported for now\&. -.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\*(Aqt have a value, it will get ignored\&. -.RE -.PP -The variables which can be used for substitutions are: -.PP -$b -.RS 4 -basename -.RE -.PP -$c -.RS 4 -client\*(Aqs ip address -.RE -.PP -$d -.RS 4 -volume pathname on server -.RE -.PP -$f -.RS 4 -full name (contents of the gecos field in the passwd file) -.RE -.PP -$g -.RS 4 -group name -.RE -.PP -$h -.RS 4 -hostname -.RE -.PP -$i -.RS 4 -client\*(Aqs ip, without port -.RE -.PP -$s -.RS 4 -server name (this can be the hostname) -.RE -.PP -$u -.RS 4 -user name (if guest, it is the user that guest is running as) -.RE -.PP -$v -.RS 4 -volume name -.RE -.PP -$$ -.RS 4 -prints dollar sign ($) -.RE -.SH "EXPLANATION OF GLOBAL PARAMETERS" -.SS "Authentication Options" -.PP -ad domain = \fIDOMAIN\fR \fB(G)\fR -.RS 4 -Append @DOMAIN to username when authenticating\&. Useful in Active Directory environments that otherwise would require the user to enter the full user@domain string\&. -.RE -.PP -admin auth user = \fIuser\fR \fB(G)\fR -.RS 4 -Specifying eg "\fBadmin auth user = root\fR" whenever a normal user login fails, afpd will try to authenticate as the specified -\fBadmin auth user\fR\&. If this succeeds, a normal session is created for the original connecting user\&. Said differently: if you know the password of -\fBadmin auth user\fR, you can authenticate as any other user\&. -.RE -.PP -k5 keytab = \fIpath\fR \fB(G)\fR, k5 service = \fIservice\fR \fB(G)\fR, k5 realm = \fIrealm\fR \fB(G)\fR -.RS 4 -These are required if the server supports the Kerberos 5 authentication UAM\&. -.RE -.PP -nt domain = \fIDOMAIN\fR \fB(G)\fR, nt separator = \fISEPARATOR\fR \fB(G)\fR -.RS 4 -Use for eg\&. winbind authentication, prepends both strings before the username from login and then tries to authenticate with the result through the available and active UAM authentication modules\&. -.RE -.PP -save password = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR -.RS 4 -Enables or disables the ability of clients to save passwords locally\&. -.RE -.PP -set password = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR -.RS 4 -Enables or disables the ability of clients to change their passwords via chooser or the "connect to server" dialog\&. -.RE -.PP -uam list = \fIuam list\fR \fB(G)\fR -.RS 4 -Space or comma separated list of UAMs\&. (The default is "uams_dhx\&.so uams_dhx2\&.so")\&. -.sp -The most commonly used UAMs are: -.PP -uams_guest\&.so -.RS 4 -allows guest logins -.RE -.PP -uams_clrtxt\&.so -.RS 4 -(uams_pam\&.so or uams_passwd\&.so) Allow logins with passwords transmitted in the clear\&. (legacy) -.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 "\fBpasswd file\fR"\&. See -\fBafppasswd\fR(1) -for details\&. (legacy) -.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 -uams_dhx2\&.so -.RS 4 -(uams_dhx2_pam\&.so or uams_dhx2_passwd\&.so) Allow Diffie\-Hellman eXchange 2 (DHX2) for authentication\&. -.RE -.PP -uam_gss\&.so -.RS 4 -Allow Kerberos V for authentication (optional) -.RE -.RE -.PP -uam path = \fIpath\fR \fB(G)\fR -.RS 4 -Sets the default path for UAMs for this server (default is :LIBDIR:/netatalk)\&. -.RE -.SS "Charset Options" -.PP -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 charsets like MacRoman, MacCentralEurope, etc\&. -.PP -To be able to serve AFP3 and older clients at the same time, -\fBafpd\fR -needs to be able to convert between UTF\-8 and Mac charsets\&. Even OS X clients partly still rely on the mac charset\&. As there\*(Aqs no way, -\fBafpd\fR -can detect the codepage a pre AFP3 client uses, you have to specify it using the -\fBmac charset\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\*(Aqs to be able to convert from UTF8\-MAC / Mac charset to the UNIX charset\&. By default -\fBafpd\fR -uses -\fIUTF8\fR\&. You can set the UNIX charset using the -\fBunix charset\fR -option\&. If you\*(Aqre using extended characters in the configuration files for -\fBafpd\fR, make sure your terminal matches the -\fBunix charset\fR\&. -.PP -mac charset = \fICHARSET\fR \fB(G)/(V)\fR -.RS 4 -Specifies the Mac clients charset, e\&.g\&. -\fIMAC_ROMAN\fR\&. 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 -\fBmac charset\fR\&. Defaults to -\fIMAC_ROMAN\fR\&. -.RE -.PP -unix charset = \fICHARSET\fR \fB(G)\fR -.RS 4 -Specifies the servers unix charset, e\&.g\&. -\fIISO\-8859\-15\fR -or -\fIEUC\-JP\fR\&. This is used to convert strings to/from the systems locale, e\&.g\&. for authentication, server messages and volume names\&. If -\fILOCALE\fR -is set, the systems locale is used\&. Defaults to -\fIUTF8\fR\&. -.RE -.PP -vol charset = \fICHARSET\fR \fB(G)/(V)\fR -.RS 4 -Specifies the encoding of the volumes filesystem\&. By default, it is the same as -\fBunix charset\fR\&. -.RE -.SS "Password Options" -.PP -passwd file = \fIpath\fR \fB(G)\fR -.RS 4 -Sets the path to the Randnum UAM passwd file for this server (default is :ETCDIR:/afppasswd)\&. -.RE -.PP -passwd minlen = \fInumber\fR \fB(G)\fR -.RS 4 -Sets the minimum password length, if supported by the UAM -.RE -.SS "Network Options" -.PP -advertise ssh = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR -.RS 4 -Allows old 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\*(Aqs answers to client\*(Aqs FPGetSrvrInfo requests contain an additional entry\&. It depends on both client\*(Aqs 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 -.ps -1 -.br -Setting this option is not recommended since globally encrypting AFP connections via SSH will increase the server\*(Aqs load significantly\&. On the other hand, Apple\*(Aqs client side implementation of this feature in MacOS X versions prior to 10\&.3\&.4 contained a security flaw\&. -.sp .5v -.RE -.RE -.PP -afp listen = \fIip address[:port] [ip address[:port] \&.\&.\&.]\fR \fB(G)\fR -.RS 4 -Specifies the IP address that the server should advertise -\fBand\fR -listens to\&. The default is advertise the first IP address of the system, but to listen for any incoming request\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&. -.RE -.PP -afp port = \fIport number\fR \fB(G)\fR -.RS 4 -Allows a different TCP port to be used for AFP\&. The default is 548\&. Also sets the default port applied when none specified in an -\fBafp listen\fR -option\&. -.RE -.PP -cnid listen = \fIip address[:port] [ip address[:port] \&.\&.\&.]\fR \fB(G)\fR -.RS 4 -Specifies the IP address that the CNID server should listen on\&. The default is -\fBlocalhost:4700\fR\&. -.RE -.PP -disconnect time = \fInumber\fR \fB(G)\fR -.RS 4 -Keep disconnected AFP sessions for -\fInumber\fR -hours before dropping them\&. Default is 24 hours\&. -.RE -.PP -dsireadbuf = \fInumber\fR \fB(G)\fR -.RS 4 -Scale factor that determines the size of the DSI/TCP readahead buffer, default is 12\&. This is multiplies with the DSI server quantum (default ~300k) to give the size of the buffer\&. Increasing this value might increase throughput in fast local networks for volume to volume copies\&. -\fINote\fR: This buffer is allocated per afpd child process, so specifying large values will eat up large amount of memory (buffer size * number of clients)\&. -.RE -.PP -fqdn = \fIname:port\fR \fB(G)\fR -.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 -hostname = \fIname\fR \fB(G)\fR -.RS 4 -Use this instead of the result from calling hostname for determining which IP address to advertise, therefore the hostname is resolved to an IP which is the advertised\&. This is NOT used for listening and it is also overwritten by -\fBafp listen\fR\&. -.RE -.PP -max connections = \fInumber\fR \fB(G)\fR -.RS 4 -Sets the maximum number of clients that can simultaneously connect to the server (default is 200)\&. -.RE -.PP -server quantum = \fInumber\fR \fB(G)\fR -.RS 4 -This specifies the DSI server quantum\&. The default value is 1 MB\&. The maximum value is 0xFFFFFFFFF, the minimum is 32000\&. If you specify a value that is out of range, the default value will be set\&. Do not change this value unless you\*(Aqre absolutely sure, what you\*(Aqre doing -.RE -.PP -sleep time = \fInumber\fR \fB(G)\fR -.RS 4 -Keep sleeping AFP sessions for -\fInumber\fR -hours before disconnecting clients in sleep mode\&. Default is 10 hours\&. -.RE -.PP -tcprcvbuf = \fInumber\fR \fB(G)\fR -.RS 4 -Try to set TCP receive buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&. -.RE -.PP -tcpsndbuf = \fInumber\fR \fB(G)\fR -.RS 4 -Try to set TCP send buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&. -.RE -.PP -use sendfile = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR -.RS 4 -Whether to use sendfile -syscall for sending file data to clients\&. -.RE -.PP -zeroconf = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR -.RS 4 -Whether to use automatic Zeroconf -service registration if Avahi or mDNSResponder were compiled in\&. -.RE -.SS "Miscellaneous Options" -.PP -admin group = \fIgroup\fR \fB(G)\fR -.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 -afp read locks = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR -.RS 4 -Whether to apply locks to the byte region read in FPRead calls\&. The AFP spec mandates this, but it\*(Aqs not really in line with UNIX semantics and is a performance hug\&. -.RE -.PP -afpstats = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR -.RS 4 -Whether to provide AFP runtime statistics (connected users, open volumes) via dbus\&. -.RE -.PP -basedir regex = \fIregex\fR \fB(H)\fR -.RS 4 -Regular expression which matches the parent directory of the user homes\&. If -\fBbasedir regex\fR -contains symlink, you must set the canonicalized absolute path\&. In the simple case this is just a path ie -\fBbasedir regex = /home\fR -.RE -.PP -close vol = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR -.RS 4 -Whether to close volumes possibly opened by clients when they\*(Aqre removed from the configuration and the configuration is reloaded\&. -.RE -.PP -cnid server = \fIipaddress[:port]\fR \fB(G)/(V)\fR -.RS 4 -Specifies the IP address and port of a cnid_metad server, required for CNID dbd backend\&. Defaults to localhost:4700\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.\- -.RE -.PP -dircachesize = \fInumber\fR \fB(G)\fR -.RS 4 -Maximum possible entries in the directory cache\&. The cache stores directories and files\&. It is used to cache the full path to directories and CNIDs which considerably speeds up directory enumeration\&. -.sp -Default size is 8192, maximum size is 131072\&. Given value is rounded up to nearest power of 2\&. Each entry takes about 100 bytes, which is not much, but remember that every afpd child process for every connected user has its cache\&. -.RE -.PP -extmap file = \fIpath\fR \fB(G)\fR -.RS 4 -Sets the path to the file which defines file extension type/creator mappings\&. (default is :ETCDIR:/extmap\&.conf)\&. -.RE -.PP -guest account = \fIname\fR \fB(G)\fR -.RS 4 -Specifies the user that guests should use (default is "nobody")\&. The name should be quoted\&. -.RE -.PP -home name = \fIname\fR \fB(H)\fR -.RS 4 -AFP user home volume name\&. The default is -\fIuser\*(Aqs home\fR\&. -.RE -.PP -login message = \fImessage\fR \fB(G)/(V)\fR -.RS 4 -Sets a message to be displayed when clients logon to the server\&. The message should be in -\fBunix charset\fR -and should be quoted\&. Extended characters are allowed\&. -.RE -.PP -map acls = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR -.RS 4 -Whether to map filesystem ACLs to effective permissions\&. -.RE -.PP -mimic model = \fImodel\fR \fB(G)\fR -.RS 4 -Specifies the icon model that appears on clients\&. Defaults to off\&. Examples: RackMac (same as Xserve), PowerBook, PowerMac, Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro, AppleTV1,1, AirPort\&. -.RE -.PP -signature = \fB(G)\fR -.RS 4 -Specify a server signature\&. The maximum length is 16 characters\&. This option is useful for clustered environments, to provide fault isolation etc\&. By default, afpd generate signature and saving it to -:STATEDIR:/netatalk/afp_signature\&.conf -automatically (based on random number)\&. See also asip\-status\&.pl(1)\&. -.RE -.PP -solaris share reservations = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR -.RS 4 -Use share reservations on Solaris\&. Solaris CIFS server uses this too, so this makes a lock coherent multi protocol server\&. -.RE -.PP -vol dbpath = \fIpath\fR \fB(G)\fR -.RS 4 -Sets the database information to be stored in path\&. You have to specify a writable location, even if the volume is read only\&. The default is -:STATEDIR:/netatalk/CNID/\&. -.RE -.PP -volnamelen = \fInumber\fR \fB(G)\fR -.RS 4 -Max length of UTF8\-MAC volume name for Mac OS X\&. Note that Hangul is especially sensitive to this\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf - 73: limit of Mac OS X 10\&.1 80: limit of Mac - OS X 10\&.4/10\&.5 (default) 255: limit of recent Mac OS - X -.fi -.if n \{\ -.RE -.\} -.sp -Mac OS 9 and earlier are not influenced by this, because Maccharset volume name is always limited to 27 bytes\&. -.RE -.PP -vol preset = \fIname\fR \fB(G)/(V)\fR -.RS 4 -Use section -\fBname\fR -as option preset for all volumes (when set in the [Global] section) or for one volume (when set in that volume\*(Aqs section)\&. -.RE -.SS "Logging Options" -.PP -log file = \fIlogfile\fR \fB(G)\fR -.RS 4 -If not specified Netatalk logs to syslogs daemon facility\&. Otherwise it logs to -\fBlogfile\fR\&. -.RE -.PP -log level = \fItype:level [type:level \&.\&.\&.]\fR \fB(G)\fR, log level = \fItype:level,[type:level, \&.\&.\&.]\fR \fB(G)\fR -.RS 4 -Specify that any message of a loglevel up to the given -\fBlog level\fR -should be logged\&. -.sp -By default afpd logs to syslog with a default logging setup equivalent to -\fBdefault:note\fR -.sp -logtypes: default, afpdaemon, logger, uamsdaemon -.sp -loglevels: severe, error, warn, note, info, debug, debug6, debug7, debug8, debug9, maxdebug -.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 -Both logtype and loglevels are case insensitive\&. -.sp .5v -.RE -.RE -.SS "Filesystem Change Events (FCE)" -.PP -Netatalk includes a nifty filesystem change event mechanism where afpd processes notify interested listeners about certain filesystem event by UDP network datagrams\&. -.PP -fce listener = \fIhost[:port]\fR \fB(G)\fR -.RS 4 -Enables sending FCE events to the specified -\fIhost\fR, default -\fIport\fR -is 12250 if not specified\&. Specifying multiple listeners is done by having this option once for each of them\&. -.RE -.PP -fce events = \fIfmod,fdel,ddel,fcre,dcre,tmsz\fR \fB(G)\fR -.RS 4 -Specifies which FCE events are active, default is -\fIfmod,fdel,ddel,fcre,dcre\fR\&. -.RE -.PP -fce coalesce = \fIall|delete|create\fR \fB(G)\fR -.RS 4 -Coalesce FCE events\&. -.RE -.PP -fce holdfmod = \fIseconds\fR \fB(G)\fR -.RS 4 -This determines the time delay in seconds which is always waited if another file modification for the same file is done by a client before sending an FCE file modification event (fmod)\&. For example saving a file in Photoshop would generate multiple events by itself because the application is opening, modifying and closing a file multiple times for every "save"\&. Default: 60 seconds\&. -.RE -.SS "Debug Parameters" -.PP -These options are useful for debugging only\&. -.PP -tickleval = \fInumber\fR \fB(G)\fR -.RS 4 -Sets the tickle timeout interval (in seconds)\&. Defaults to 30\&. -.RE -.PP -timeout = \fInumber\fR \fB(G)\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 -.PP -client polling = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR -.RS 4 -With this option enabled, afpd won\*(Aqt 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\*(Aqs speed, this can lead to a significant higher load on your network! -.sp -Do not use this option any longer as present Netatalk correctly supports server notifications, allowing connected clients to update folder listings in case another client changed the contents\&. -.RE -.SS "Options for ACL handling" -.PP -For a basic mode of operation there\*(Aqs nothing to configure\&. afpd reads ACLs on the fly, calculating effective permissions and returning the calculated permissions via the so called UARights permission bits\&. On a Mac the Finder uses these bits to adjust permission in Finder windows\&. For example folder whos UNIX mode would only result in in read\-only permissions for a user will not be displayed with a read\-only icon and the user will be able to write to the folder given the folder has an ACL giving the user write access\&. -.PP -However, neither in Finder "Get Info" windows nor in Terminal will you be able to see the ACLs, that\*(Aqs a result of how ACLs in OS X are designed\&. If you want to be able to display ACLs on the client, things get more involved as you must then setup both client and server to be part on a authentication domain (directory service, eg LDAP, OpenDirectory)\&. The reason is, that in OS X ACLs are bound to UUIDs, not just uid\*(Aqs or gid\*(Aqs\&. Therefor afpd must be able to map every filesystem uid and gid to a UUID so that it can return the server side ACLs which are bound to UNIX uid and gid mapped to OS X UUIDs\&. Get it? Read on\&. -.PP -Netatalk can query a directory server using LDAP queries\&. Either the directory server already provides an UUID attribute for user and groups (Active Directory, Open Directory) or you reuse an unused attribute (or add a new one) to you directory server (eg OpenLDAP)\&. -.PP -The following LDAP options must be configured for Netatalk: -.PP -ldap auth method = \fInone|simple|sasl\fR \fB(G)\fR -.RS 4 -Authentication method: -\fBnone | simple | sasl\fR -.PP -none -.RS 4 -anonymous LDAP bind -.RE -.PP -simple -.RS 4 -simple LDAP bind -.RE -.PP -sasl -.RS 4 -SASL\&. Not yet supported ! -.RE -.RE -.PP -ldap auth dn = \fIdn\fR \fB(G)\fR -.RS 4 -Distinguished Name of the user for simple bind\&. -.RE -.PP -ldap auth pw = \fIpassword\fR \fB(G)\fR -.RS 4 -Distinguished Name of the user for simple bind\&. -.RE -.PP -ldap server = \fIhost\fR \fB(G)\fR -.RS 4 -Name or IP address of your LDAP Server\&. This is only needed for explicit ACL support in order to be able to query LDAP for UUIDs\&. -.sp -You can use -\fBafpldaptest\fR(1) -to syntactically check your config\&. -.RE -.PP -ldap userbase = \fIbase dn\fR \fB(G)\fR -.RS 4 -DN of the user container in LDAP\&. -.RE -.PP -ldap userscope = \fIscope\fR \fB(G)\fR -.RS 4 -Search scope for user search: -\fBbase | one | sub\fR -.RE -.PP -ldap groupbase = \fIbase dn\fR \fB(G)\fR -.RS 4 -DN of the group container in LDAP\&. -.RE -.PP -ldap groupscope = \fIscope\fR \fB(G)\fR -.RS 4 -Search scope for user search: -\fBbase | one | sub\fR -.RE -.PP -ldap uuid attr = \fIdn\fR \fB(G)\fR -.RS 4 -Name of the LDAP attribute with the UUIDs\&. -.sp -Note: this is used both for users and groups\&. -.RE -.PP -ldap name attr = \fIdn\fR \fB(G)\fR -.RS 4 -Name of the LDAP attribute with the users short name\&. -.RE -.PP -ldap uuid string = \fISTRING\fR \fB(G)\fR -.RS 4 -Format of the uuid string in the directory\&. A series of x and \-, where every x denotes a value 0\-9a\-f and every \- is a separator\&. -.sp -Default: xxxxxxxx\-xxxx\-xxxx\-xxxx\-xxxxxxxxxxxx -.RE -.PP -ldap uuid encoding = \fIstring | ms\-guid (default: string)\fR \fB(G)\fR -.RS 4 -Format of the UUID of the LDAP attribute, allows usage of the binary objectGUID fields from Active Directory\&. If left unspecified, string is the default, which passes through the ASCII UUID returned by most other LDAP stores\&. If set to ms\-guid, the internal UUID representation is converted to and from the binary format used in the objectGUID attribute found on objects in Active Directory when interacting with the server\&. -.PP -string -.RS 4 -UUID is a string, use with eg OpenDirectory\&. -.RE -.PP -ms\-guid -.RS 4 -Binary objectGUID from Active Directory -.RE -.RE -.PP -ldap group attr = \fIdn\fR \fB(G)\fR -.RS 4 -Name of the LDAP attribute with the groups short name\&. -.RE -.SH "EXPLANATION OF VOLUME PARAMETERS" -.SS "Parameters" -.PP -The section name defines the volume name which is the name that appears in the Chooser or the "connect to server" dialog on Macintoshes to represent the appropriate share\&. No two volumes may have the same name\&. The volume name cannot contain the -\*(Aq:\*(Aq -character\&. The volume name is mangled if it is very long\&. Mac charset volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to volnamelen parameter\&. -.PP -path = \fIPATH\fR \fB(V)\fR -.RS 4 -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\&. -.sp -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 -\*(Aq:\*(Aq -character\&. The volume name is mangled if it is very long\&. Mac charset volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to volnamelen parameter\&. -.RE -.PP -appledouble = \fIea|v2\fR \fB(V)\fR -.RS 4 -Specify the format of the metadata files, which are used for saving Mac resource fork as well\&. Earlier versions used AppleDouble v2, the new default format is -\fBea\fR\&. -.RE -.PP -vol size limit = \fIsize in MiB\fR \fB(V)\fR -.RS 4 -Useful for Time Machine: limits the reported volume size, thus preventing Time Machine from using the whole real disk space for backup\&. Example: "vol size limit = 1000" would limit the reported disk space to 1 GB\&. -\fBIMPORTANT: \fR -This is an approximated calculation taking into account the contents of Time Machine sparsebundle images\&. Therefor you MUST NOT use this volume to store other content when using this option, because it would NOT be accounted\&. The calculation works by reading the band size from the Info\&.plist XML file of the sparsebundle, reading the bands/ directory counting the number of band files, and then multiplying one with the other\&. -.RE -.PP -valid users = \fIuser @group\fR \fB(V)\fR -.RS 4 -The allow option allows the users and groups that access a share to be specified\&. Users and groups are specified, delimited by spaces or commas\&. Groups are designated by a @ prefix\&. Names may be quoted in order to allow for spaces in names\&. Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -valid users = user "user 2" @group \(lq@group 2" -.fi -.if n \{\ -.RE -.\} -.RE -.PP -invalid users = \fIusers/groups\fR \fB(V)\fR -.RS 4 -The deny option specifies users and groups who are not allowed access to the share\&. It follows the same format as the "valid users" option\&. -.RE -.PP -hosts allow = \fIIP host address/IP netmask bits [ \&.\&.\&. ]\fR \fB(V)\fR -.RS 4 -Only listed hosts and networks are allowed, all others are rejected\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&. -.sp -Example: hosts allow = 10\&.1\&.0\&.0/16 10\&.2\&.1\&.100 2001:0db8:1234::/48 -.RE -.PP -hosts deny = \fIIP host address/IP netmask bits [ \&.\&.\&. ]\fR \fB(V)\fR -.RS 4 -Listed hosts and nets are rejected, all others are allowed\&. -.sp -Example: hosts deny = 192\&.168\&.100/24 10\&.1\&.1\&.1 2001:db8::1428:57ab -.RE -.PP -cnid scheme = \fIbackend\fR \fB(V)\fR -.RS 4 -set the CNID backend to be used for the volume, default is [:DEFAULT_CNID_SCHEME:] available schemes: [:COMPILED_BACKENDS:] -.RE -.PP -ea = \fInone|auto|sys|ad\fR \fB(V)\fR -.RS 4 -Specify how Extended Attributes -are stored\&. -\fBauto\fR -is the default\&. -.PP -auto -.RS 4 -Try -\fBsys\fR -(by setting an EA on the shared directory itself), fallback to -\fBad\fR\&. Requires writable volume for performing test\&. "\fBread only = yes\fR" overwrites -\fBauto\fR -with -\fBnone\fR\&. Use explicit "\fBea = sys|ad\fR" for read\-only volumes where appropriate\&. -.RE -.PP -sys -.RS 4 -Use filesystem Extended Attributes\&. -.RE -.PP -ad -.RS 4 -Use files in -\fI\&.AppleDouble\fR -directories\&. -.RE -.PP -none -.RS 4 -No Extended Attributes support\&. -.RE -.RE -.PP -mac charset = \fICHARSET\fR \fB(V)\fR -.RS 4 -specifies the Mac client charset for this Volume, e\&.g\&. -\fIMAC_ROMAN\fR, -\fIMAC_CYRILLIC\fR\&. If not specified the global setting is applied\&. This setting is only required if you need volumes, where the Mac charset differs from the one globally set in the [Global] section\&. -.RE -.PP -casefold = \fBoption\fR \fB(V)\fR -.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 -password = \fIpassword\fR \fB(V)\fR -.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 -file perm = \fImode\fR \fB(V)\fR, directory perm = \fImode\fR \fB(V)\fR -.RS 4 -Add(or) with the client requested permissions: -\fBfile perm\fR -is for files only, -\fBdirectory perm\fR -is for directories only\&. Don\*(Aqt use with "\fBunix priv = no\fR"\&. -.PP -\fBExample.\ \&Volume for a collaborative workgroup\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -file perm = 0660 directory perm = - 0770 -.fi -.if n \{\ -.RE -.\} - -.RE -.PP -umask = \fImode\fR \fB(V)\fR -.RS 4 -set perm mask\&. Don\*(Aqt use with "\fBunix priv = no\fR"\&. -.RE -.PP -preexec = \fIcommand\fR \fB(V)\fR -.RS 4 -command to be run when the volume is mounted, ignored for user defined volumes -.RE -.PP -postexec = \fIcommand\fR \fB(V)\fR -.RS 4 -command to be run when the volume is closed, ignored for user defined volumes -.RE -.PP -root preexec = \fIcommand\fR \fB(V)\fR -.RS 4 -command to be run as root when the volume is mounted, ignored for user defined volumes -.RE -.PP -root postexec = \fIcommand\fR \fB(V)\fR -.RS 4 -command to be run as root when the volume is closed, ignored for user defined volumes -.RE -.PP -rolist = \fBusers/groups\fR \fB(V)\fR -.RS 4 -Allows certain users and groups to have read\-only access to a share\&. This follows the allow option format\&. -.RE -.PP -rwlist = \fIusers/groups\fR \fB(V)\fR -.RS 4 -Allows certain users and groups to have read/write access to a share\&. This follows the allow option format\&. -.RE -.PP -veto files = \fIvetoed names\fR \fB(V)\fR -.RS 4 -hide files and directories,where the path matches one of the \*(Aq/\*(Aq delimited vetoed names\&. The veto string must always be terminated with a \*(Aq/\*(Aq, eg\&. "veto1/", "veto1/veto2/"\&. -.RE -.SS "Volume options" -.PP -Boolean volume options\&. -.PP -acls = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR -.RS 4 -Whether to flag volumes as supporting ACLs\&. If ACL support is compiled in, this is yes by default\&. -.RE -.PP -cnid dev = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR -.RS 4 -Whether to use the device number in the CNID backends\&. Helps when the device number is not constant across a reboot, eg cluster, \&.\&.\&. -.RE -.PP -convert appledouble = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR -.RS 4 -Whether automatic conversion from -\fBappledouble = v2\fR -to -\fBappledouble = ea\fR -is performed when accessing filesystems from clients\&. This is generally useful, but costs some performance\&. It\*(Aqs recommendable to run -\fBdbd\fR -on volumes and do the conversion with that\&. Then this option can be set to no\&. -.RE -.PP -follow symlinks = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR -.RS 4 -The default setting is false thus symlinks are not followed on the server\&. This is the same behaviour as OS X\*(Aqs AFP server\&. Setting the option to true causes afpd to follow symlinks on the server\&. symlinks may point outside of the AFP volume, currently afpd doesn\*(Aqt do any checks for "wide symlinks"\&. -.RE -.PP -invisible dots = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR -.RS 4 -make dot files invisible\&. WARNING: enabling this option will lead to unwanted sideeffects were OS X applications when saving files to a temporary file starting with a dot first, then renaming the temp file to its final name, result in the saved file being invisible\&. The only thing this option is useful for is making files that start with a dot invisible on Mac OS 9\&. It\*(Aqs completely useless on Mac OS X, as both in Finder and in Terminal files starting with a dot are hidden anyway\&. -.RE -.PP -network ids = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR -.RS 4 -Whether the server support network ids\&. Setting this to -\fIno\fR -will result in the client not using ACL AFP functions\&. -.RE -.PP -preexec close = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR -.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 -read only = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR -.RS 4 -Specifies the share as being read only for all users\&. Overwrites -\fBea = auto\fR -with -\fBea = none\fR -.RE -.PP -root preexec close= \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR -.RS 4 -A non\-zero return code from root_preexec closes the volume immediately, preventing clients to mount/see the volume in question\&. -.RE -.PP -search db = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR -.RS 4 -Use fast CNID database namesearch instead of slow recursive filesystem search\&. Relies on a consistent CNID database, ie Samba or local filesystem access lead to inaccurate or wrong results\&. Works only for "dbd" CNID db volumes\&. -.RE -.PP -stat vol = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR -.RS 4 -Whether to stat volume path when enumerating volumes list, useful for automounting or volumes created by a preexec script\&. -.RE -.PP -time machine = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR -.RS 4 -Whether to enable Time Machine support for this volume\&. -.RE -.PP -unix priv = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR -.RS 4 -Whether to use AFP3 UNIX privileges\&. This should be set for OS X clients\&. See also: -\fBfile perm\fR, -\fBdirectory perm\fR -and -\fBumask\fR\&. -.RE -.SH "CNID BACKENDS" -.PP -The AFP protocol mostly refers to files and directories by ID and not by name\&. Netatalk needs a way to store these ID\*(Aqs in a persistent way, to achieve this several different CNID backends are available\&. The CNID Databases are by default located in the -:STATEDIR:/netatalk/CNID/(volumename)/\&.AppleDB/ -directory\&. -.PP -cdb -.RS 4 -"Concurrent database", backend is based on Oracle Berkley DB\&. With this backend several -\fBafpd\fR -daemons 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 -\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 -.RS 4 -This backend is an exception, in terms of ID persistency\&. ID\*(Aqs 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\&. Starting with Netatalk 3\&.0, it becomes the -\fIread only mode\fR -automatically\&. -.sp -\fBWarning\fR: It is -\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\*(Aqt use them unless you know what you\*(Aqre doing, they may be removed without further notice from future versions\&. -.SH "CHARSET OPTIONS" -.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\&. \*(Aq/\*(Aq will be encoded to -:2f, if -\fBusedots\fR -is not specified, a leading dot \*(Aq\&.\*(Aq will be encoded as -:2e\&. -.PP -This version now uses UTF\-8 as the default encoding for names\&. \*(Aq/\*(Aq will be converted to \*(Aq:\*(Aq\&. -.PP -The -\fBvol charset\fR -option will allow you to select another volume encoding\&. E\&.g\&. for western users another useful setting could be vol charset ISO\-8859\-15\&. -\fBafpd\fR -will accept any -\fBiconv\fR(1) -provided charset\&. If a character cannot be converted from the -\fBmac charset\fR -to the selected -\fBvol charset\fR, afpd will save it as a CAP encoded character\&. For AFP3 clients, -\fBafpd\fR -will convert the UTF\-8 -character to -\fBmac charset\fR -first\&. If this conversion fails, you\*(Aqll receive a \-50 error on the mac\&. -.PP -\fINote\fR: Whenever you can, please stick with the default UTF\-8 volume format\&. -.SH "SEE ALSO" -.PP -\fBafpd\fR(8), -\fBafppasswd\fR(5), -\fBafp_signature.conf\fR(5), -\fBextmap.conf\fR(5), -\fBcnid_metad\fR(8) diff --git a/man/man5/afp_signature.conf.5.in b/man/man5/afp_signature.conf.5.in new file mode 100644 index 00000000..c620ef05 --- /dev/null +++ b/man/man5/afp_signature.conf.5.in @@ -0,0 +1,86 @@ +'\" t +.\" Title: afp_signature.conf +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 23 Mar 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "AFP_SIGNATURE\&.CONF" "5" "23 Mar 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * 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 +@localstatedir@/netatalk/afp_signature\&.conf +is the configuration file used by +\fBafpd\fR +to specify server signature automagically\&. 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 +Current netatalk 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 =" in afp\&.conf\&. In this case, afp_signature\&.conf is not used\&. +.sp .5v +.RE +.PP +.SH "EXAMPLES" +.PP +\fBExample.\ \&afp_signature.conf\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# This is a comment\&. +"My Server" 74A0BB94EC8C13988B2E75042347E528 +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBafpd\fR(8), +\fBafp.conf\fR(5), +\fBasip-status.pl\fR(1) diff --git a/man/man5/afp_signature.conf.5.tmpl b/man/man5/afp_signature.conf.5.tmpl deleted file mode 100644 index 2f5fe403..00000000 --- a/man/man5/afp_signature.conf.5.tmpl +++ /dev/null @@ -1,86 +0,0 @@ -'\" t -.\" Title: afp_signature.conf -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 23 Mar 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "AFP_SIGNATURE\&.CONF" "5" "23 Mar 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * 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 -:STATEDIR:/netatalk/afp_signature\&.conf -is the configuration file used by -\fBafpd\fR -to specify server signature automagically\&. 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 -Current netatalk 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 =" in afp\&.conf\&. In this case, afp_signature\&.conf is not used\&. -.sp .5v -.RE -.PP -.SH "EXAMPLES" -.PP -\fBExample.\ \&afp_signature.conf\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -# This is a comment\&. -"My Server" 74A0BB94EC8C13988B2E75042347E528 -.fi -.if n \{\ -.RE -.\} -.SH "SEE ALSO" -.PP -\fBafpd\fR(8), -\fBafp.conf\fR(5), -\fBasip-status.pl\fR(1) diff --git a/man/man5/afp_voluuid.conf.5.in b/man/man5/afp_voluuid.conf.5.in new file mode 100644 index 00000000..21612dd8 --- /dev/null +++ b/man/man5/afp_voluuid.conf.5.in @@ -0,0 +1,87 @@ +'\" t +.\" Title: afp_voluuid.conf +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 23 Mar 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "AFP_VOLUUID\&.CONF" "5" "23 Mar 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +afp_voluuid.conf \- Configuration file used by afpd(8) to specify UUID for Time Machine volume +.SH "DESCRIPTION" +.PP +@localstatedir@/netatalk/afp_voluuid\&.conf +is the configuration file used by +\fBafpd\fR +to specify UUID of Time Machine volume automagically\&. The configuration lines are composed like: +.PP +\fI"volume name"\fR +\fIuuid\-string\fR +.PP +The first field is volume name\&. Volume names must be quoted if they contain spaces\&. The second field is the 36 character hexadecimal ASCII string representation of a UUID\&. +.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 +This UUID is advertised by Zeroconf in order to provide robust disambiguation of Time Machine volume\&. +.PP +The afpd generates the UUID from random numbers and saves it into afp_voluuid\&.conf, only when setting "time machine = yes" option in afp\&.conf\&. +.PP +This file should not be thoughtlessly edited and be copied onto another server\&. +.sp .5v +.RE +.PP +.SH "EXAMPLES" +.PP +\fBExample.\ \&afp_voluuid.conf three TM volumes on one netatalk\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# This is a comment\&. +"Backup for John Smith" 1573974F\-0ABD\-69CC\-C40A\-8519B681A0E1 +"bob" 39A487F4\-55AA\-8240\-E584\-69AA01800FE9 +mary 6331E2D1\-446C\-B68C\-3066\-D685AADBE911 +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBafpd\fR(8), +\fBafp.conf\fR(5), +\fBavahi-daemon\fR(8), +\fBmDNSResponder\fR(8) diff --git a/man/man5/afp_voluuid.conf.5.tmpl b/man/man5/afp_voluuid.conf.5.tmpl deleted file mode 100644 index a9fb2ddf..00000000 --- a/man/man5/afp_voluuid.conf.5.tmpl +++ /dev/null @@ -1,87 +0,0 @@ -'\" t -.\" Title: afp_voluuid.conf -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 23 Mar 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "AFP_VOLUUID\&.CONF" "5" "23 Mar 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -afp_voluuid.conf \- Configuration file used by afpd(8) to specify UUID for Time Machine volume -.SH "DESCRIPTION" -.PP -:STATEDIR:/netatalk/afp_voluuid\&.conf -is the configuration file used by -\fBafpd\fR -to specify UUID of Time Machine volume automagically\&. The configuration lines are composed like: -.PP -\fI"volume name"\fR -\fIuuid\-string\fR -.PP -The first field is volume name\&. Volume names must be quoted if they contain spaces\&. The second field is the 36 character hexadecimal ASCII string representation of a UUID\&. -.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 -This UUID is advertised by Zeroconf in order to provide robust disambiguation of Time Machine volume\&. -.PP -The afpd generates the UUID from random numbers and saves it into afp_voluuid\&.conf, only when setting "time machine = yes" option in afp\&.conf\&. -.PP -This file should not be thoughtlessly edited and be copied onto another server\&. -.sp .5v -.RE -.PP -.SH "EXAMPLES" -.PP -\fBExample.\ \&afp_voluuid.conf three TM volumes on one netatalk\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -# This is a comment\&. -"Backup for John Smith" 1573974F\-0ABD\-69CC\-C40A\-8519B681A0E1 -"bob" 39A487F4\-55AA\-8240\-E584\-69AA01800FE9 -mary 6331E2D1\-446C\-B68C\-3066\-D685AADBE911 -.fi -.if n \{\ -.RE -.\} -.SH "SEE ALSO" -.PP -\fBafpd\fR(8), -\fBafp.conf\fR(5), -\fBavahi-daemon\fR(8), -\fBmDNSResponder\fR(8) diff --git a/man/man5/extmap.conf.5.in b/man/man5/extmap.conf.5.in new file mode 100644 index 00000000..9e0abfaa --- /dev/null +++ b/man/man5/extmap.conf.5.in @@ -0,0 +1,77 @@ +'\" t +.\" Title: extmap.conf +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 19 Jan 2013 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "EXTMAP\&.CONF" "5" "19 Jan 2013" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +extmap.conf \- Configuration file used by afpd(8) to specify file name extension mappings\&. +.SH "SYNOPSIS" +.HP \w'\fB@pkgconfdir@/extmap\&.conf\fR\fB\fR\ 'u +\fB@pkgconfdir@/extmap\&.conf\fR\fB\fR +.SH "DESCRIPTION" +.PP + +@pkgconfdir@/extmap\&.conf +is the configuration file used by +\fBafpd\fR +to specify file name extension mappings\&. +.PP +The configuration lines are composed like: +.PP +\&.extension +\fI[ type [ creator ] ]\fR +.PP +Any line beginning with a hash (\(lq#\(rq) character is ignored\&. The leading\-dot lines specify file name extension mappings\&. The extension \*(Aq\&.\*(Aq sets the default creator and type for otherwise untyped Unix files\&. +.SH "EXAMPLES" +.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 +\fBafp.conf\fR(5), +\fBafpd\fR(8) diff --git a/man/man5/extmap.conf.5.tmpl b/man/man5/extmap.conf.5.tmpl deleted file mode 100644 index 9c6679fa..00000000 --- a/man/man5/extmap.conf.5.tmpl +++ /dev/null @@ -1,77 +0,0 @@ -'\" t -.\" Title: extmap.conf -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 19 Jan 2013 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "EXTMAP\&.CONF" "5" "19 Jan 2013" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -extmap.conf \- Configuration file used by afpd(8) to specify file name extension mappings\&. -.SH "SYNOPSIS" -.HP \w'\fB:ETCDIR:/extmap\&.conf\fR\fB\fR\ 'u -\fB:ETCDIR:/extmap\&.conf\fR\fB\fR -.SH "DESCRIPTION" -.PP - -:ETCDIR:/extmap\&.conf -is the configuration file used by -\fBafpd\fR -to specify file name extension mappings\&. -.PP -The configuration lines are composed like: -.PP -\&.extension -\fI[ type [ creator ] ]\fR -.PP -Any line beginning with a hash (\(lq#\(rq) character is ignored\&. The leading\-dot lines specify file name extension mappings\&. The extension \*(Aq\&.\*(Aq sets the default creator and type for otherwise untyped Unix files\&. -.SH "EXAMPLES" -.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 -\fBafp.conf\fR(5), -\fBafpd\fR(8) diff --git a/man/man8/.gitignore b/man/man8/.gitignore index 711b8c36..29043a09 100644 --- a/man/man8/.gitignore +++ b/man/man8/.gitignore @@ -1,12 +1,3 @@ Makefile Makefile.in -afpd.8 -afp_acls.8 -atalkd.8 -cnid_dbd.8 -cnid_metad.8 -netatalk.8 -papd.8 -papstatus.8 -psf.8 -*.o +*.8 diff --git a/man/man8/Makefile.am b/man/man8/Makefile.am index eb112ab3..f93850e3 100644 --- a/man/man8/Makefile.am +++ b/man/man8/Makefile.am @@ -1,24 +1,9 @@ ## Makefile.am for man/man8/ -pkgconfdir = @PKGCONFDIR@ +man_MANS = \ + afpd.8 \ + cnid_dbd.8 \ + cnid_metad.8 \ + netatalk.8 -SUFFIXES = .tmpl . - -.tmpl: - sed -e s@:SBINDIR:@${sbindir}@ \ - -e s@:BINDIR:@${bindir}@ \ - -e s@:ETCDIR:@${pkgconfdir}@ \ - -e s@:LIBDIR:@${libdir}@ \ - -e s@:LIBEXECDIR:@${libexecdir}@ \ - -e "s@:STATEDIR:@${localstatedir}@g" \ - -e s@:NETATALK_VERSION:@${NETATALK_VERSION}@ \ - <$< >$@ - -GENERATED_MANS = afpd.8 cnid_dbd.8 cnid_metad.8 netatalk.8 -TEMPLATE_FILES = afpd.8.tmpl cnid_dbd.8.tmpl cnid_metad.8.tmpl netatalk.8.tmpl - -man_MANS = $(GENERATED_MANS) - -CLEANFILES = $(GENERATED_MANS) - -EXTRA_DIST = $(TEMPLATE_FILES) +CLEANFILES = $(man_MANS) diff --git a/man/man8/afpd.8.in b/man/man8/afpd.8.in new file mode 100644 index 00000000..ab40fa3d --- /dev/null +++ b/man/man8/afpd.8.in @@ -0,0 +1,171 @@ +'\" t +.\" Title: afpd +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 19 Jan 2013 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "AFPD" "8" "19 Jan 2013" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +afpd \- Apple Filing Protocol daemon +.SH "SYNOPSIS" +.HP \w'\fBafpd\fR\fB\fR\fBafpd\fR\fB\fR\ 'u +\fBafpd\fR\fB\fR [\-d] [\-F\ \fIconfigfile\fR] +.br +\fBafpd\fR\fB\fR \-v | \-V | \-h +.SH "DESCRIPTION" +.PP +\fBafpd\fR +provides an Apple Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time by +\fBnetatalk\fR(8)\&. +.PP +@pkgconfdir@/afp\&.conf +is the configuration file used by +\fBafpd\fR +to determine the behavior and configuration of a file server\&. +.SH "OPTIONS" +.PP +\-d +.RS 4 +Specifies that the daemon should not fork\&. +.RE +.PP +\-v +.RS 4 +Print version information and exit\&. +.RE +.PP +\-V +.RS 4 +Print verbose information and exit\&. +.RE +.PP +\-h +.RS 4 +Print help and exit\&. +.RE +.PP +\-F \fIconfigfile\fR +.RS 4 +Specifies the configuration file to use\&. (Defaults to +@pkgconfdir@/afp\&.conf\&.) +.RE +.SH "SIGNALS" +.PP +To shut down a user\*(Aqs +\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\&. +.PP +SIGTERM and SIGUSR1 signals that are sent to the main +\fBafpd\fR +process are propagated to the children, so all will be affected\&. +.PP +SIGTERM +.RS 4 +Clean exit\&. Propagates from master to childs\&. +.RE +.PP +SIGQUIT +.RS 4 +Send this to the master +\fBafpd\fR, it will exit leaving all children running! Can be used to implement AFP service without downtime\&. +.RE +.PP +SIGHUP +.RS 4 +Sending a +\fBSIGHUP\fR +to afpd will cause it to reload its configuration files\&. +.RE +.PP +SIGINT +.RS 4 +Sending a +\fBSIGINT\fR +to a child +\fBafpd\fR +enables +\fImax_debug\fR +logging for this process\&. The log is sent to the file +/tmp/afpd\&.PID\&.XXXXXX\&. Sending another +\fBSIGINT\fR +will revert to the original log settings\&. +.RE +.PP +SIGUSR1 +.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 +.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\&. +.RE +.SH "FILES" +.PP +@pkgconfdir@/afp\&.conf +.RS 4 +configuration file used by afpd +.RE +.PP +@localstatedir@/netatalk/afp_signature\&.conf +.RS 4 +list of server signature +.RE +.PP +@localstatedir@/netatalk/afp_voluuid\&.conf +.RS 4 +list of UUID for Time Machine volume +.RE +.PP +@pkgconfdir@/extmap\&.conf +.RS 4 +file name extension mapping +.RE +.PP +@pkgconfdir@/msg/message\&.pid +.RS 4 +contains messages to be sent to users\&. +.RE +.SH "SEE ALSO" +.PP +\fBnetatalk\fR(8), +\fBhosts_access\fR(5), +\fBafp.conf\fR(5), +\fBafp_signature.conf\fR(5), +\fBafp_voluuid.conf\fR(5), +\fBextmap.conf\fR(5), +\fBdbd\fR(1)\&. diff --git a/man/man8/afpd.8.tmpl b/man/man8/afpd.8.tmpl deleted file mode 100644 index 9f09a64b..00000000 --- a/man/man8/afpd.8.tmpl +++ /dev/null @@ -1,171 +0,0 @@ -'\" t -.\" Title: afpd -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 19 Jan 2013 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "AFPD" "8" "19 Jan 2013" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -afpd \- Apple Filing Protocol daemon -.SH "SYNOPSIS" -.HP \w'\fBafpd\fR\fB\fR\fBafpd\fR\fB\fR\ 'u -\fBafpd\fR\fB\fR [\-d] [\-F\ \fIconfigfile\fR] -.br -\fBafpd\fR\fB\fR \-v | \-V | \-h -.SH "DESCRIPTION" -.PP -\fBafpd\fR -provides an Apple Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time by -\fBnetatalk\fR(8)\&. -.PP -:ETCDIR:/afp\&.conf -is the configuration file used by -\fBafpd\fR -to determine the behavior and configuration of a file server\&. -.SH "OPTIONS" -.PP -\-d -.RS 4 -Specifies that the daemon should not fork\&. -.RE -.PP -\-v -.RS 4 -Print version information and exit\&. -.RE -.PP -\-V -.RS 4 -Print verbose information and exit\&. -.RE -.PP -\-h -.RS 4 -Print help and exit\&. -.RE -.PP -\-F \fIconfigfile\fR -.RS 4 -Specifies the configuration file to use\&. (Defaults to -:ETCDIR:/afp\&.conf\&.) -.RE -.SH "SIGNALS" -.PP -To shut down a user\*(Aqs -\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\&. -.PP -SIGTERM and SIGUSR1 signals that are sent to the main -\fBafpd\fR -process are propagated to the children, so all will be affected\&. -.PP -SIGTERM -.RS 4 -Clean exit\&. Propagates from master to childs\&. -.RE -.PP -SIGQUIT -.RS 4 -Send this to the master -\fBafpd\fR, it will exit leaving all children running! Can be used to implement AFP service without downtime\&. -.RE -.PP -SIGHUP -.RS 4 -Sending a -\fBSIGHUP\fR -to afpd will cause it to reload its configuration files\&. -.RE -.PP -SIGINT -.RS 4 -Sending a -\fBSIGINT\fR -to a child -\fBafpd\fR -enables -\fImax_debug\fR -logging for this process\&. The log is sent to the file -/tmp/afpd\&.PID\&.XXXXXX\&. Sending another -\fBSIGINT\fR -will revert to the original log settings\&. -.RE -.PP -SIGUSR1 -.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 -.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\&. -.RE -.SH "FILES" -.PP -:ETCDIR:/afp\&.conf -.RS 4 -configuration file used by afpd -.RE -.PP -:STATEDIR:/netatalk/afp_signature\&.conf -.RS 4 -list of server signature -.RE -.PP -:STATEDIR:/netatalk/afp_voluuid\&.conf -.RS 4 -list of UUID for Time Machine volume -.RE -.PP -:ETCDIR:/extmap\&.conf -.RS 4 -file name extension mapping -.RE -.PP -:ETCDIR:/msg/message\&.pid -.RS 4 -contains messages to be sent to users\&. -.RE -.SH "SEE ALSO" -.PP -\fBnetatalk\fR(8), -\fBhosts_access\fR(5), -\fBafp.conf\fR(5), -\fBafp_signature.conf\fR(5), -\fBafp_voluuid.conf\fR(5), -\fBextmap.conf\fR(5), -\fBdbd\fR(1)\&. diff --git a/man/man8/cnid_dbd.8.in b/man/man8/cnid_dbd.8.in new file mode 100644 index 00000000..3b5b68a2 --- /dev/null +++ b/man/man8/cnid_dbd.8.in @@ -0,0 +1,249 @@ +'\" t +.\" Title: cnid_dbd +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 01 Jan 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "CNID_DBD" "8" "01 Jan 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * 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" +.HP \w'\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR\fBcnid_dbd\fR\fB\fR\ 'u +\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR +.br +\fBcnid_dbd\fR\fB\fR \-v | \-V +.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 one instance of +\fBcnid_dbd\fR +per netatalk volume\&. +.PP +\fBcnid_dbd\fR +uses the +\fBBerkeley DB\fR +database library and uses transactionally protected updates\&. The +\fBdbd\fR +backend with transactions will avoid corruption of the CNID database even if the system crashes unexpectedly\&. +.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 +\fBBerkeley 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 +\fBBerkeley 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 +The +\fBBerkeley 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 the transactional database changes\&. They will be removed regularly, unless the +\fBlogfile_autoremove\fR +option is specified in the +\fIdb_param\fR +configuration file (see below) with a value of 0 (default 1)\&. +.SH "OPTIONS" +.PP +\fB\-v, \-V\fR +.RS 4 +Show version and exit\&. +.RE +.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 +If set to 0, unused Berkeley DB transactional logfiles (log\&.xxxxxxxxxx in the database home directory) are not removed on startup of +\fBcnid_dbd\fR +and on a regular basis\&. Default: 1\&. +.RE +.PP +\fBcachesize\fR +.RS 4 +Determines the size of the Berkeley DB cache in kilobytes\&. Default: 8192\&. 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 Berkley DB can help you determine ether 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 +\fBflush_frequency\fR, \fBflush_interval\fR +.RS 4 +\fIflush_frequency\fR +(Default: 1000) and +\fIflush_interval\fR +(Default: 1800) control how often changes to the database are checkpointed\&. 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\&. 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: 512\&. 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 +\fBcnid_dbd\fR +exits\&. Default: 600\&. Set this to 0 to disable the timeout\&. +.RE +.SH "UPDATING" +.PP +Note that the first version to appear +\fIafter\fR +Netatalk 2\&.1 ie Netatalk 2\&.1\&.1, will support BerkeleyDB updates on the fly without manual intervention\&. In other words Netatalk 2\&.1 does contain code to prepare the BerkeleyDB database for upgrades and to upgrade it in case it has been prepared before\&. That means it can\*(Aqt upgrade a 2\&.0\&.x version because that one didn\*(Aqt prepare the database\&. +.PP +In order to update between older Netatalk releases using different BerkeleyDB library versions, follow this steps: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Stop the to be upgraded old version of Netatalk +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Using the old BerkeleyDB utilities run +\fBdb_recover \-h \fR +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Using the new BerkeleyDB utilities run +\fBdb_upgrade \-v \-h \-f cnid2\&.db\fR +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Again using the new BerkeleyDB utilities run +\fBdb_checkpoint \-1 \-h \fR +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Start the the new version of Netatalk +.RE +.SH "SEE ALSO" +.PP +\fBcnid_metad\fR(8), +\fBafpd\fR(8), +\fBdbd\fR(1) diff --git a/man/man8/cnid_dbd.8.tmpl b/man/man8/cnid_dbd.8.tmpl deleted file mode 100644 index b5d8bc5d..00000000 --- a/man/man8/cnid_dbd.8.tmpl +++ /dev/null @@ -1,249 +0,0 @@ -'\" t -.\" Title: cnid_dbd -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 01 Jan 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "CNID_DBD" "8" "01 Jan 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * 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" -.HP \w'\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR\fBcnid_dbd\fR\fB\fR\ 'u -\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR -.br -\fBcnid_dbd\fR\fB\fR \-v | \-V -.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 one instance of -\fBcnid_dbd\fR -per netatalk volume\&. -.PP -\fBcnid_dbd\fR -uses the -\fBBerkeley DB\fR -database library and uses transactionally protected updates\&. The -\fBdbd\fR -backend with transactions will avoid corruption of the CNID database even if the system crashes unexpectedly\&. -.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 -\fBBerkeley 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 -\fBBerkeley 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 -The -\fBBerkeley 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 the transactional database changes\&. They will be removed regularly, unless the -\fBlogfile_autoremove\fR -option is specified in the -\fIdb_param\fR -configuration file (see below) with a value of 0 (default 1)\&. -.SH "OPTIONS" -.PP -\fB\-v, \-V\fR -.RS 4 -Show version and exit\&. -.RE -.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 -If set to 0, unused Berkeley DB transactional logfiles (log\&.xxxxxxxxxx in the database home directory) are not removed on startup of -\fBcnid_dbd\fR -and on a regular basis\&. Default: 1\&. -.RE -.PP -\fBcachesize\fR -.RS 4 -Determines the size of the Berkeley DB cache in kilobytes\&. Default: 8192\&. 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 Berkley DB can help you determine ether 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 -\fBflush_frequency\fR, \fBflush_interval\fR -.RS 4 -\fIflush_frequency\fR -(Default: 1000) and -\fIflush_interval\fR -(Default: 1800) control how often changes to the database are checkpointed\&. 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\&. 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: 512\&. 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 -\fBcnid_dbd\fR -exits\&. Default: 600\&. Set this to 0 to disable the timeout\&. -.RE -.SH "UPDATING" -.PP -Note that the first version to appear -\fIafter\fR -Netatalk 2\&.1 ie Netatalk 2\&.1\&.1, will support BerkeleyDB updates on the fly without manual intervention\&. In other words Netatalk 2\&.1 does contain code to prepare the BerkeleyDB database for upgrades and to upgrade it in case it has been prepared before\&. That means it can\*(Aqt upgrade a 2\&.0\&.x version because that one didn\*(Aqt prepare the database\&. -.PP -In order to update between older Netatalk releases using different BerkeleyDB library versions, follow this steps: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Stop the to be upgraded old version of Netatalk -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Using the old BerkeleyDB utilities run -\fBdb_recover \-h \fR -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Using the new BerkeleyDB utilities run -\fBdb_upgrade \-v \-h \-f cnid2\&.db\fR -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Again using the new BerkeleyDB utilities run -\fBdb_checkpoint \-1 \-h \fR -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Start the the new version of Netatalk -.RE -.SH "SEE ALSO" -.PP -\fBcnid_metad\fR(8), -\fBafpd\fR(8), -\fBdbd\fR(1) diff --git a/man/man8/cnid_metad.8.in b/man/man8/cnid_metad.8.in new file mode 100644 index 00000000..0a0d559e --- /dev/null +++ b/man/man8/cnid_metad.8.in @@ -0,0 +1,90 @@ +'\" t +.\" Title: cnid_metad +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 23 Mar 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "CNID_METAD" "8" "23 Mar 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * 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" +.HP \w'\fBcnid_metad\fR\fB\fR\fBcnid_metad\fR\fB\fR\ 'u +\fBcnid_metad\fR\fB\fR [\-d] [\-F\ \fIconfiguration\ file\fR] +.br +\fBcnid_metad\fR\fB\fR \-v | \-V +.SH "DESCRIPTION" +.PP +\fBcnid_metad\fR +waits for requests from +\fBafpd\fR +to start up instances of the +\fBcnid_dbd\fR +daemon\&. It keeps track of the status of a +\fBcnid_dbd\fR +instance once started and will restart it if necessary\&. +\fBcnid_metad\fR +is normally started at boot time by +\fBnetatalk\fR(8) and runs until shutdown\&. +.SH "OPTIONS" +.PP +\fB\-d\fR +.RS 4 +\fBcnid_metad will remain in the foreground and\fR +will also leave the standard input, standard output and standard error file descriptors open\&. Useful for debugging\&. +.RE +.PP +\fB\-F\fR \fIconfiguration file\fR +.RS 4 +Use +\fIconfiguration file\fR +as the configuration file\&. The default is +\fI@pkgconfdir@/afp\&.conf\fR\&. +.RE +.PP +\fB\-v, \-V\fR +.RS 4 +Show version and exit\&. +.RE +.SH "CAVEATS" +.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\*(Aqs\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 +\fBnetatalk\fR(8), +\fBcnid_dbd\fR(8), +\fBafpd\fR(8), +\fBdbd\fR(1), +\fBafp.conf\fR(5) diff --git a/man/man8/cnid_metad.8.tmpl b/man/man8/cnid_metad.8.tmpl deleted file mode 100644 index 4007a7ca..00000000 --- a/man/man8/cnid_metad.8.tmpl +++ /dev/null @@ -1,90 +0,0 @@ -'\" t -.\" Title: cnid_metad -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 23 Mar 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "CNID_METAD" "8" "23 Mar 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * 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" -.HP \w'\fBcnid_metad\fR\fB\fR\fBcnid_metad\fR\fB\fR\ 'u -\fBcnid_metad\fR\fB\fR [\-d] [\-F\ \fIconfiguration\ file\fR] -.br -\fBcnid_metad\fR\fB\fR \-v | \-V -.SH "DESCRIPTION" -.PP -\fBcnid_metad\fR -waits for requests from -\fBafpd\fR -to start up instances of the -\fBcnid_dbd\fR -daemon\&. It keeps track of the status of a -\fBcnid_dbd\fR -instance once started and will restart it if necessary\&. -\fBcnid_metad\fR -is normally started at boot time by -\fBnetatalk\fR(8) and runs until shutdown\&. -.SH "OPTIONS" -.PP -\fB\-d\fR -.RS 4 -\fBcnid_metad will remain in the foreground and\fR -will also leave the standard input, standard output and standard error file descriptors open\&. Useful for debugging\&. -.RE -.PP -\fB\-F\fR \fIconfiguration file\fR -.RS 4 -Use -\fIconfiguration file\fR -as the configuration file\&. The default is -\fI:ETCDIR:/afp\&.conf\fR\&. -.RE -.PP -\fB\-v, \-V\fR -.RS 4 -Show version and exit\&. -.RE -.SH "CAVEATS" -.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\*(Aqs\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 -\fBnetatalk\fR(8), -\fBcnid_dbd\fR(8), -\fBafpd\fR(8), -\fBdbd\fR(1), -\fBafp.conf\fR(5) diff --git a/man/man8/netatalk.8.in b/man/man8/netatalk.8.in new file mode 100644 index 00000000..39790ffc --- /dev/null +++ b/man/man8/netatalk.8.in @@ -0,0 +1,67 @@ +'\" t +.\" Title: netatalk +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 22 Mar 2012 +.\" Manual: @NETATALK_VERSION@ +.\" Source: @NETATALK_VERSION@ +.\" Language: English +.\" +.TH "NETATALK" "8" "22 Mar 2012" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +netatalk \- Netatalk AFP server service controller daemon +.SH "SYNOPSIS" +.HP \w'\fBnetatalk\fR\fB\fR\fBnetatalk\fR\fB\fR\ 'u +\fBnetatalk\fR\fB\fR +.br +\fBnetatalk\fR\fB\fR +.SH "DESCRIPTION" +.PP +\fBnetatalk\fR +is the service controller daemon responsible for starting and restarting the AFP daemon +\fBafpd\fR +and the CNID daemon +\fBcnid_metad\fR\&. It is normally started at boot time from /etc/rc\&. +.SH "SIGNALS" +.PP +SIGTERM +.RS 4 +Stop Netatalk service, AFP and CNID daemons +.RE +.PP +SIGHUP +.RS 4 +Sending a +\fBSIGHUP\fR +will cause the AFP daemon reload its configuration file\&. +.RE +.SH "FILES" +.PP +@pkgconfdir@/afp\&.conf +.RS 4 +configuration file used by afpd and cnid_metad +.RE +.SH "SEE ALSO" +.PP +\fBafpd\fR(8), +\fBcnid_metad\fR(8), +\fBafp.conf\fR(5)\&. diff --git a/man/man8/netatalk.8.tmpl b/man/man8/netatalk.8.tmpl deleted file mode 100644 index 06878da5..00000000 --- a/man/man8/netatalk.8.tmpl +++ /dev/null @@ -1,67 +0,0 @@ -'\" t -.\" Title: netatalk -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 22 Mar 2012 -.\" Manual: Netatalk 3.0 -.\" Source: Netatalk 3.0 -.\" Language: English -.\" -.TH "NETATALK" "8" "22 Mar 2012" "Netatalk 3.0" "Netatalk 3.0" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -netatalk \- Netatalk AFP server service controller daemon -.SH "SYNOPSIS" -.HP \w'\fBnetatalk\fR\fB\fR\fBnetatalk\fR\fB\fR\ 'u -\fBnetatalk\fR\fB\fR -.br -\fBnetatalk\fR\fB\fR -.SH "DESCRIPTION" -.PP -\fBnetatalk\fR -is the service controller daemon responsible for starting and restarting the AFP daemon -\fBafpd\fR -and the CNID daemon -\fBcnid_metad\fR\&. It is normally started at boot time from /etc/rc\&. -.SH "SIGNALS" -.PP -SIGTERM -.RS 4 -Stop Netatalk service, AFP and CNID daemons -.RE -.PP -SIGHUP -.RS 4 -Sending a -\fBSIGHUP\fR -will cause the AFP daemon reload its configuration file\&. -.RE -.SH "FILES" -.PP -:ETCDIR:/afp\&.conf -.RS 4 -configuration file used by afpd and cnid_metad -.RE -.SH "SEE ALSO" -.PP -\fBafpd\fR(8), -\fBcnid_metad\fR(8), -\fBafp.conf\fR(5)\&.