Last manpage checkin from XML sources before 2.1beta1 release

[netatalk.git] / man / man5 / afp_ldap.conf.5.tmpl

diff --git a/man/man5/afp_ldap.conf.5.tmpl b/man/man5/afp_ldap.conf.5.tmpl
index cabe336b26bc7d5e955dc4dfe2377d2fea621495..3076edc9135ea8d7ad71bb88bc61f03c298274c3 100644 (file)
--- a/man/man5/afp_ldap.conf.5.tmpl
+++ b/man/man5/afp_ldap.conf.5.tmpl
@@ -1,83 +1,13 @@
+'\" t
 .\"     Title: afp_ldap.conf
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
-.\"      Date: 31-01-2009
-.\"    Manual: Netatalk 2.0 Manual
-.\"    Source: :NETATALK_VERSION:
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 28 November 2009
+.\"    Manual: Netatalk 2.1
+.\"    Source: Netatalk 2.1
 .\"  Language: English
 .\"
-.TH "LDAP\&.CONF" "5" "31-01-2009" ":NETATALK_VERSION:" "Netatalk 2.0 Manual"
-.\" -----------------------------------------------------------------
-.\" * (re)Define some macros
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BB/BE - put background/screen (filled box) around block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BB
-.if t \{\
-.sp -.5
-.br
-.in +2n
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EB
-.if t \{\
-.if "\\$2"adjust-for-leading-newline" \{\
-.sp -1
-.\}
-.br
-.di
-.in
-.ll
-.gcolor
-.nr BW \\n(.lu-\\n(.i
-.nr BH \\n(dn+.5v
-.ne \\n(BHu+.5v
-.ie "\\$2"adjust-for-leading-newline" \{\
-\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.el \{\
-\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.in 0
-.sp -.5v
-.nf
-.BX
-.in
-.sp .5v
-.fi
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BM/EM - put colored marker in margin next to block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BM
-.if t \{\
-.br
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EM
-.if t \{\
-.br
-.di
-.ll
-.gcolor
-.nr BH \\n(dn
-.ne \\n(BHu
-\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
-.in 0
-.nf
-.BX
-.in
-.fi
-.\}
-..
+.TH "AFP_LDAP\&.CONF" "5" "28 November 2009" "Netatalk 2.1" "Netatalk 2.1"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -88,11 +18,11 @@
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
-.SH "Name"
+.SH "NAME"
 afp_ldap.conf \- Configuration file used by afpd(8) to configure a LDAP connection to an LDAP server\&. That is needed for ACL support in order to be able to query LDAP for UUIDs\&.
-.SH "Description"
+.SH "DESCRIPTION"
 .PP
-\FC:ETCDIR:/ldap\&.conf\F[]
+:ETCDIR:/afp_ldap\&.conf
 is the configuration file used by
 \fBafpd\fR
 to set up an LDAP connection to an LDAP server\&.
@@ -103,7 +33,6 @@ Any line not prefixed with # is interpreted\&.
 .sp
 .\}
 .RS 4
-.BM yellow
 .it 1 an-trap
 .nr an-no-space-flag 1
 .nr an-break-flag 1
@@ -117,10 +46,9 @@ You can use
 \fBafpldaptest\fR(1)
 to syntactically check your config
 .sp .5v
-.EM yellow
 .RE
 The required parameters and their meanings are:
-.SH "Parameter"
+.SH "PARAMETER"
 .PP
 ldap_server
 .RS 4
@@ -130,7 +58,8 @@ Name or IP address of your LDAP Server
 .PP
 ldap_auth_method
 .RS 4
-<none|simple|sasl>
+Authentication method:
+\fBnone | simple | sasl\fR
 .PP
 none
 .RS 4
@@ -166,12 +95,26 @@ DN of the user container in LDAP\&.
 .sp
 .RE
 .PP
+ldap_userscope
+.RS 4
+Search scope for user search:
+\fBbase | one | sub\fR
+.sp
+.RE
+.PP
 ldap_groupbase
 .RS 4
 DN of the group container in LDAP\&.
 .sp
 .RE
 .PP
+ldap_groupscope
+.RS 4
+Search scope for user search:
+\fBbase | one |\ \&sub\fR
+.sp
+.RE
+.PP
 ldap_uuuid_attr
 .RS 4
 Name of the LDAP attribute with the UUIDs\&.
@@ -191,34 +134,30 @@ ldap_group_attr
 Name of the LDAP attribute with the groups short name\&.
 .sp
 .RE
-.SH "Examples"
+.SH "EXAMPLES"
 .PP
 \fBExample.\ \&afp_ldap.conf setup with simple bind\fR
 .sp
 .if n \{\
 .RS 4
 .\}
-.fam C
-.ps -1
 .nf
-.BB lightgray
 ldap_server      = localhost
 ldap_auth_method = simple
 ldap_auth_dn     = cn=admin,dc=domain,dc=org
 ldap_auth_pw     = notthisone
 ldap_userbase    = ou=users,dc=domain,dc=org
+ldap_userscope   = one
 ldap_groupbase   = ou=groups,dc=domain,dc=org
+ldap_groupscope  = one
 ldap_uuid_attr   = some_attribute
 ldap_name_attr   = cn
 ldap_group_attr  = cn
-.EB lightgray
 .fi
-.fam
-.ps +1
 .if n \{\
 .RE
 .\}
-.SH "See also"
+.SH "SEE ALSO"
 .PP
 \fBafpd\fR(8),
 \fBAppleVolumes.default\fR(5),\fBafpldaptest\fR(1)