From: arichard Date: Fri, 22 Sep 2000 15:18:44 +0000 (+0000) Subject: Make man5 man pages independent of configure scripts paths. X-Git-Tag: netatalk-1-5-rc1~644 X-Git-Url: https://arthur.barton.de/gitweb/?a=commitdiff_plain;h=cefb85a2ff8ef613eda7fa706512d2de2ade2f49;p=netatalk.git Make man5 man pages independent of configure scripts paths. --- diff --git a/man/man5/AppleVolumes.default.5 b/man/man5/AppleVolumes.default.5 deleted file mode 100644 index 1d05f956..00000000 --- a/man/man5/AppleVolumes.default.5 +++ /dev/null @@ -1,155 +0,0 @@ -.\" $Id: AppleVolumes.default.5,v 1.1 2000-09-20 19:24:22 rufustfirefly Exp $ -.TH AppleVolumes.default 5 "20 September 2000" "netatalk 1.5" -.UC 4 -.SH NAME -AppleVolumes.default \- Configuration file used by \fBafpd\fR(8) -to determine the shares made available through Appletalk - -.SH DESCRIPTION -\fB/etc/atalk/AppleVolumes.default\fR is the configuration file used -by afpd to determine what portions of the file system will be shared via -Appletalk, as well as their behaviors. - -Any line not prefixed with \fB#\fR is interpreted. The configuration lines -are composed like: - -.RS -.sp -.I path -.B [ -.I chooser name -.B ] [ -.I options -.B ] - -.sp -.RE -The path name must be a fully qualified path name, or a path name using -either the \fB~\fR shell shorthand or any of the substitution variables, -which are listed below. - -The chooser name is the name that appears in the Chooser on Macintoshes -to represent the appropriate share. If there are spaces in the name, it -should be in quotes (i.e. \fB"File Share"\fR). The chooser name may not -exceed 27 characters in length, and cannot contain the \fB:\fR character. - -The possible options and their meanings are: - -.TP -.B allow:[users/groups] -The allow option allows the users and groups that access a share to -be specified. Users and groups are specified, delimited by commas. Groups -are designated by a \fB@\fR prefix. - -\fIExample:\fR \fBallow:user1,user2,@group\fR - -.TP -.B casefold:[option] -The casefold option handles how casenames should be mangled. The available -options are: - -\fBtolower\fR - Lowercases names in both directions. - -\fBtoupper\fR - Uppercases names in both directions. - -\fBxlatelower\fR - Client sees lowercase, server sees uppercase. - -\fBxlateupper\fR - Client sees uppercase, server sees lowercase. - -.TP -.B codepage:[nls file] -The codepage option loads a specific codepage from the nls directory. - -.TP -.B dbpath:[path] -Sets the database information to be stored in \fBpath\fR. - -.TP -.B deny:[users/groups] -The deny option specifies users and groups who are not allowed access -to the share. It follows the same format as the \fBallow\fR option. - -.TP -.B options:[option] -This allows multiple options to be specified in a comma delimited format. -The available options are: - -\fBcrlf\fR - Enables crlf translation for TEXT files. - -\fBlimitsize\fR - Hack for older Macintoshes using newer Appleshare -clients to limit the disk size reporting to 2 GB. - -\fBmswindows\fR - Forces filename restrictions imposed by MS WinXX, and -invokes the MS default codepage (iso8859-1) if one is not already -specified. - -\fBnoadouble\fR - Forces afpd to not create .AppleDouble unless a resource -fork needs to be created. - -\fBnohex\fR - Disables :hex translations for anything except dot files. -This option makes the \fB/\fR character illegal. - -\fBprodos\fR - Provides compatibility with Apple II clients. - -\fBro\fR - Specifies the share as being read only for all users. - -\fBusedots\fR - Don't do :hex translation for dot files. This makes all -files such as .Parent, .Apple* illegal. Dot files created on the server -side will be invisible to the client. - -.TP -.B password:[password] -This option allows you to set a volume password, which can be a maximum -of 8 characters long. - -.TP -.B rolist:[users/groups] -Allows certain users and groups to have read-only access to a share. -This follows the \fBallow\fR option format. - -.TP -.B rwlist:[users/groups] -Allows certain users and groups to have read/write access to a share. -This follows the \fBallow\fR option format. - -.P -The variables which can be used for subsitutions are: - -.TP -.B $c -client's ip or appletalk address - -.TP -.B $f -full name (contents of the gecos field in the passwd file) - -.TP -.B $g -group name - -.TP -.B $h -hostname - -.TP -.B $s -server name (this can be the hostname) - -.TP -.B $u -user name (if guest, it is the user that guest is running as) - -.TP -.B $v -volume name (either ADEID_NAME or basename of path) - -.TP -.B $z -appletalk zone (may not exist) - -.TP -.B $$ -prints dollar sign (\fb$\fR) - -.SH SEE ALSO -afpd(8) diff --git a/man/man5/AppleVolumes.default.5.tmpl b/man/man5/AppleVolumes.default.5.tmpl new file mode 100644 index 00000000..2b361f75 --- /dev/null +++ b/man/man5/AppleVolumes.default.5.tmpl @@ -0,0 +1,155 @@ +.\" $Id: AppleVolumes.default.5.tmpl,v 1.1 2000-09-22 15:18:44 arichard Exp $ +.TH AppleVolumes.default 5 "20 September 2000" "netatalk 1.5" +.UC 4 +.SH NAME +AppleVolumes.default \- Configuration file used by \fBafpd\fR(8) +to determine the shares made available through Appletalk + +.SH DESCRIPTION +\fB:ETCDIR:/AppleVolumes.default\fR is the configuration file used +by afpd to determine what portions of the file system will be shared via +Appletalk, as well as their behaviors. + +Any line not prefixed with \fB#\fR is interpreted. The configuration lines +are composed like: + +.RS +.sp +.I path +.B [ +.I chooser name +.B ] [ +.I options +.B ] + +.sp +.RE +The path name must be a fully qualified path name, or a path name using +either the \fB~\fR shell shorthand or any of the substitution variables, +which are listed below. + +The chooser name is the name that appears in the Chooser on Macintoshes +to represent the appropriate share. If there are spaces in the name, it +should be in quotes (i.e. \fB"File Share"\fR). The chooser name may not +exceed 27 characters in length, and cannot contain the \fB:\fR character. + +The possible options and their meanings are: + +.TP +.B allow:[users/groups] +The allow option allows the users and groups that access a share to +be specified. Users and groups are specified, delimited by commas. Groups +are designated by a \fB@\fR prefix. + +\fIExample:\fR \fBallow:user1,user2,@group\fR + +.TP +.B casefold:[option] +The casefold option handles how casenames should be mangled. The available +options are: + +\fBtolower\fR - Lowercases names in both directions. + +\fBtoupper\fR - Uppercases names in both directions. + +\fBxlatelower\fR - Client sees lowercase, server sees uppercase. + +\fBxlateupper\fR - Client sees uppercase, server sees lowercase. + +.TP +.B codepage:[nls file] +The codepage option loads a specific codepage from the nls directory. + +.TP +.B dbpath:[path] +Sets the database information to be stored in \fBpath\fR. + +.TP +.B deny:[users/groups] +The deny option specifies users and groups who are not allowed access +to the share. It follows the same format as the \fBallow\fR option. + +.TP +.B options:[option] +This allows multiple options to be specified in a comma delimited format. +The available options are: + +\fBcrlf\fR - Enables crlf translation for TEXT files. + +\fBlimitsize\fR - Hack for older Macintoshes using newer Appleshare +clients to limit the disk size reporting to 2 GB. + +\fBmswindows\fR - Forces filename restrictions imposed by MS WinXX, and +invokes the MS default codepage (iso8859-1) if one is not already +specified. + +\fBnoadouble\fR - Forces afpd to not create .AppleDouble unless a resource +fork needs to be created. + +\fBnohex\fR - Disables :hex translations for anything except dot files. +This option makes the \fB/\fR character illegal. + +\fBprodos\fR - Provides compatibility with Apple II clients. + +\fBro\fR - Specifies the share as being read only for all users. + +\fBusedots\fR - Don't do :hex translation for dot files. This makes all +files such as .Parent, .Apple* illegal. Dot files created on the server +side will be invisible to the client. + +.TP +.B password:[password] +This option allows you to set a volume password, which can be a maximum +of 8 characters long. + +.TP +.B rolist:[users/groups] +Allows certain users and groups to have read-only access to a share. +This follows the \fBallow\fR option format. + +.TP +.B rwlist:[users/groups] +Allows certain users and groups to have read/write access to a share. +This follows the \fBallow\fR option format. + +.P +The variables which can be used for subsitutions are: + +.TP +.B $c +client's ip or appletalk address + +.TP +.B $f +full name (contents of the gecos field in the passwd file) + +.TP +.B $g +group name + +.TP +.B $h +hostname + +.TP +.B $s +server name (this can be the hostname) + +.TP +.B $u +user name (if guest, it is the user that guest is running as) + +.TP +.B $v +volume name (either ADEID_NAME or basename of path) + +.TP +.B $z +appletalk zone (may not exist) + +.TP +.B $$ +prints dollar sign (\fb$\fR) + +.SH SEE ALSO +afpd(8) diff --git a/man/man5/Makefile.am b/man/man5/Makefile.am index 82aedd2b..ade9f9a4 100644 --- a/man/man5/Makefile.am +++ b/man/man5/Makefile.am @@ -1,5 +1,16 @@ -# Makefile.am for man/man5/ +## Makefile.am for man/man5/ + +SUFFIXES = .tmpl . + +.tmpl: + sed -e s@:SBINDIR:@${sbindir}@ \ + -e s@:BINDIR:@${bindir}@ \ + -e s@:ETCDIR:@${CONFIG_DIR}@ \ + -e s@:LIBDIR:@${libdir}@ \ + <$^ >$@ man_MANS = AppleVolumes.default.5 netatalk.conf.5 +CLEANFILES = AppleVolumes.default.5 netatalk.conf.5 + EXTRA_DIST = $(man_MANS) diff --git a/man/man5/netatalk.conf.5 b/man/man5/netatalk.conf.5 deleted file mode 100644 index 18dc9780..00000000 --- a/man/man5/netatalk.conf.5 +++ /dev/null @@ -1,74 +0,0 @@ -.\" $Id: netatalk.conf.5,v 1.1 2000-09-20 19:24:22 rufustfirefly Exp $ -.TH NETATALK.CONF 5 "18 September 2000" "netatalk 1.5" -.UC 4 -.SH NAME -netatalk.conf \- Configuration file used by \fBafpd\fR(8), -\fBpapd\fR(8) and \fBatalkd\fR(8) as part of netatalk. - -.SH DESCRIPTION -\fB/etc/atalk/netatalk.conf\fR is the main configuration file for netatalk. -It consists of a series of bash-style assignments. The possible variables -and their meanings are: - -.TP -.B ATALK_NAME -This is the machines' Appletalk name. Note that spaces in this name may cause -problems due to passing in the shell scripts. The default value of -\fB`echo ${HOSTNAME}|cut -d. -f1`\fR produces a name based on the host name -of the machine (example: \fBmybox.foo.com\fR becomes \fBmybox\fR). - -.TP -.B ATALK_ZONE -The Appletalk "zone" that the server should be visible in, preceded with -the "@" (example: \fBATALK_ZONE=@Donuts\fR). If omitted, it will automatically -detect the current zone. - -.TP -.B AFPD_GUEST -This is the user account that guest runs as. The default should be set to -\fBnobody\fR or another unpriviledged account on the system. - -.TP -.B AFPD_MAX_CLIENTS -This should be set to the maximum number of clients you want to be able to -connect to the \fBafpd\fR daemon concurrently. If you are having problems -with connections being refused during high load, you should probably increase -this number (example: \fBAFPD_MAX_CLIENTS=50\fR). - -.TP -.B AFPD_UAMLIST -AFPD_UAMLIST contains the list of the UAMs that should be forced to be -loaded, prefixed by a "-U", delimited by commas -(example: \fBAFPD_UAMLIST="-U uams_guest.so,uams_randnum.so"\fR would load -the Randnum and Guest authentication modules). If this is omitted, the -default modules will load. - -.TP -.B ATALK_BGROUND -This controls whether the daemons are started in the background or in the -foreground. It is recommended that the daemons be started in the foreground -so that any dependent programs will load properly. The options are \fByes\fR -and \fBno\fR (example: \fBATALK_BGROUND=no\fR). - -.TP -.B ATALKD_RUN -\fBatalkd\fR is the master Appletalk daemon. This should always be set to -\fBon\fR. The options are \fByes\fR and \fBno\fR. - -.TP -.B AFPD_RUN -\fBafpd\fR is the Appletalk file server daemon. This should be enabled if you -are planning on using netatalk to serve files over Appletalk. The options are -\fByes\fR and \fBno\fR. - -.TP -.B PAPD_RUN -\fBpapd\fR is the Appletalk printing daemon. This should be enabled if you -wish to serve printers using Appletalk. The options are \fByes\fR and \fBno\fR. - -.P -The options in this file control the behavior of the init script(s) for -netatalk, which vary by distribution. - -.SH SEE ALSO -afpd(8), atalkd(8), papd(8) diff --git a/man/man5/netatalk.conf.5.tmpl b/man/man5/netatalk.conf.5.tmpl new file mode 100644 index 00000000..7639d156 --- /dev/null +++ b/man/man5/netatalk.conf.5.tmpl @@ -0,0 +1,155 @@ +.\" $Id: netatalk.conf.5.tmpl,v 1.1 2000-09-22 15:18:44 arichard Exp $ +.TH AppleVolumes.default 5 "20 September 2000" "netatalk 1.5" +.UC 4 +.SH NAME +AppleVolumes.default \- Configuration file used by \fBafpd\fR(8) +to determine the shares made available through Appletalk + +.SH DESCRIPTION +\fB:ETCDIR:/AppleVolumes.default\fR is the configuration file used +by afpd to determine what portions of the file system will be shared via +Appletalk, as well as their behaviors. + +Any line not prefixed with \fB#\fR is interpreted. The configuration lines +are composed like: + +.RS +.sp +.I path +.B [ +.I chooser name +.B ] [ +.I options +.B ] + +.sp +.RE +The path name must be a fully qualified path name, or a path name using +either the \fB~\fR shell shorthand or any of the substitution variables, +which are listed below. + +The chooser name is the name that appears in the Chooser on Macintoshes +to represent the appropriate share. If there are spaces in the name, it +should be in quotes (i.e. \fB"File Share"\fR). The chooser name may not +exceed 27 characters in length, and cannot contain the \fB:\fR character. + +The possible options and their meanings are: + +.TP +.B allow:[users/groups] +The allow option allows the users and groups that access a share to +be specified. Users and groups are specified, delimited by commas. Groups +are designated by a \fB@\fR prefix. + +\fIExample:\fR \fBallow:user1,user2,@group\fR + +.TP +.B casefold:[option] +The casefold option handles how casenames should be mangled. The available +options are: + +\fBtolower\fR - Lowercases names in both directions. + +\fBtoupper\fR - Uppercases names in both directions. + +\fBxlatelower\fR - Client sees lowercase, server sees uppercase. + +\fBxlateupper\fR - Client sees uppercase, server sees lowercase. + +.TP +.B codepage:[nls file] +The codepage option loads a specific codepage from the nls directory. + +.TP +.B dbpath:[path] +Sets the database information to be stored in \fBpath\fR. + +.TP +.B deny:[users/groups] +The deny option specifies users and groups who are not allowed access +to the share. It follows the same format as the \fBallow\fR option. + +.TP +.B options:[option] +This allows multiple options to be specified in a comma delimited format. +The available options are: + +\fBcrlf\fR - Enables crlf translation for TEXT files. + +\fBlimitsize\fR - Hack for older Macintoshes using newer Appleshare +clients to limit the disk size reporting to 2 GB. + +\fBmswindows\fR - Forces filename restrictions imposed by MS WinXX, and +invokes the MS default codepage (iso8859-1) if one is not already +specified. + +\fBnoadouble\fR - Forces afpd to not create .AppleDouble unless a resource +fork needs to be created. + +\fBnohex\fR - Disables :hex translations for anything except dot files. +This option makes the \fB/\fR character illegal. + +\fBprodos\fR - Provides compatibility with Apple II clients. + +\fBro\fR - Specifies the share as being read only for all users. + +\fBusedots\fR - Don't do :hex translation for dot files. This makes all +files such as .Parent, .Apple* illegal. Dot files created on the server +side will be invisible to the client. + +.TP +.B password:[password] +This option allows you to set a volume password, which can be a maximum +of 8 characters long. + +.TP +.B rolist:[users/groups] +Allows certain users and groups to have read-only access to a share. +This follows the \fBallow\fR option format. + +.TP +.B rwlist:[users/groups] +Allows certain users and groups to have read/write access to a share. +This follows the \fBallow\fR option format. + +.P +The variables which can be used for subsitutions are: + +.TP +.B $c +client's ip or appletalk address + +.TP +.B $f +full name (contents of the gecos field in the passwd file) + +.TP +.B $g +group name + +.TP +.B $h +hostname + +.TP +.B $s +server name (this can be the hostname) + +.TP +.B $u +user name (if guest, it is the user that guest is running as) + +.TP +.B $v +volume name (either ADEID_NAME or basename of path) + +.TP +.B $z +appletalk zone (may not exist) + +.TP +.B $$ +prints dollar sign (\fb$\fR) + +.SH SEE ALSO +afpd(8)