]> arthur.barton.de Git - netatalk.git/blobdiff - man/man5/netatalk.conf.5.tmpl
Rev versions to 2.1beta2, checkin changed manpages
[netatalk.git] / man / man5 / netatalk.conf.5.tmpl
index 7639d156b8763f35ebc1dec95fee28c8dbbf2113..499bd6b57d406101dba8f32813716043345c1b08 100644 (file)
-.\" $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 ]
-
+'\" t
+.\"     Title: netatalk.conf
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 9 Jun 2009
+.\"    Manual: Netatalk 2.1
+.\"    Source: Netatalk 2.1
+.\"  Language: English
+.\"
+.TH "NETATALK\&.CONF" "5" "9 Jun 2009" "Netatalk 2.1" "Netatalk 2.1"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+netatalk.conf \- Configuration file used by netatalk(8) to determine its general configuration
+.SH "DESCRIPTION"
+.PP
+\fB:ETCDIR:/netatalk\&.conf\fR
+is the configuration file used by afpd to determine what portions of the file system will be shared via AFP, as well as their behaviors\&.
+.PP
+Any line not prefixed with
+\fB#\fR
+is interpreted\&. The configuration lines are composed like:
+.PP
+\fIoption\fR
+\fB=\fR
+\fIvalue\fR
+.PP
+The possible options and their meanings are:
+.PP
+\fBAFPD_GUEST\fR
+.RS 4
+Sets the id of the guest user to a local user on the system\&.
+.RE
+.PP
+\fBAFPD_MAX_CLIENTS\fR
+.RS 4
+Sets the maximum number of clients that can simultaneously connect to the server\&.
+.RE
+.PP
+\fBAFPD_RUN\fR
+.RS 4
+Enables the afpd daemon if set to "yes"\&. This should be enabled if you are planning on using netatalk as a file server\&.
+.RE
+.PP
+\fBAFPD_UAM_LIST\fR
+.RS 4
+Sets the default UAMs for afpd (and papd, if printer authentication is compiled in) to use\&.
 .sp
+\fIExample:\fR
+\fBAFPD_UAMLIST\fR=\fB"\-U uams_guest\&.so,uams_randnum\&.so"\fR
 .RE
-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)
+.PP
+\fBCNID_METAD_RUN\fR
+.RS 4
+Enables the cnid_metad daemon if set to "yes"\&. This should be enabled if you are going to use the dbd CNID backend\&.
+.RE
+.PP
+\fBCNID_CONFIG\fR
+.RS 4
+Configuration options for cnid_metad\&. See:
+\fBcnid_metad\fR(8)
+.RE
+.PP
+\fBATALK_BGROUND\fR
+.RS 4
+"yes" will set netatalk to initialize in the background, and "no" will cause normal initialization\&.
+.RE
+.PP
+\fBATALK_NAME\fR
+.RS 4
+Sets the machines\' Appletalk name\&.
+.RE
+.PP
+\fBATALK_ZONE\fR
+.RS 4
+Sets the machines\' Appletalk zone\&.
+.RE
+.PP
+\fBATALKD_RUN\fR
+.RS 4
+Enables the atalkd daemon if set to "yes"\&. This should be enabled if you are planning on providing Appletalk services\&.
+.RE
+.PP
+\fBPAPD_RUN\fR
+.RS 4
+Enables the papd daemon if set to "yes"\&. This should be enabled if you are planning on using netatalk as a print server\&.
+.RE
+.PP
+\fBATALK_MAC_CHARSET\fR
+.RS 4
+Set the Mac client codepage, used by atalkd and papd to convert extended characters from the Unix to the Mac codepage\&.
+.RE
+.PP
+\fBATALK_UNIX_CHARSET\fR
+.RS 4
+Set the Unix codepage, used by atalkd and papd to convert extended characters from the Unix to the Mac codepage\&. Has to match the codepage of the configuration files\&.
+.RE
+.SH "SEE ALSO"
+.PP
+\fBatalkd\fR(8),
+\fBatalkd.conf\fR(5)