document the configuration directives for directories.

1 files changed, 53 insertions, 2 deletions

diff --git a/usr.sbin/ypldap/ypldap.conf.5 b/usr.sbin/ypldap/ypldap.conf.5
index 1751217f22d..3ab16f46b2b 100644
--- a/usr.sbin/ypldap/ypldap.conf.5
+++ b/usr.sbin/ypldap/ypldap.conf.5
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: ypldap.conf.5,v 1.2 2008/06/26 21:24:34 jmc Exp $
+.\"	$OpenBSD: ypldap.conf.5,v 1.3 2008/06/29 10:44:47 pyr Exp $
 .\"
 .\" Copyright (c) 2008 Pierre-Yves Ritschard <pyr@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: June 26 2008 $
+.Dd $Mdocdate: June 29 2008 $
 .Dt YPLDAP.CONF 5
 .Os
 .Sh NAME
@@ -75,6 +75,57 @@ The currently implemented maps are: passwd.byname, passwd.byid,
 group.byname, group.byid.
 .El
 .Sh DIRECTORIES
+Directories are used to describe the LDAP schema and help
+.Nm
+convert LDAP entries to
+.Xr passwd 5, master.passwd 5
+and 
+.Xr group 5
+lines.
+A directory declaration is of the following form:
+.Bd -literal -offset indent
+directory "some.host" {
+	# directives
+}
+.Ed
+Valid directives for directories are:
+.Bl -tag -width Ds
+.It Xo
+.Ic attribute Ar name Ic maps to Ar string
+.Xc
+Map the
+.Xr passwd 5, master.passwd 5
+or 
+.Xr group 5
+attribute to the LDAP attribute name supplied.
+Valid attributes are:
+.Bl -tag -width groupmembers -offset indent -compact
+.It Ic uid
+.It Ic passwd
+.It Ic uid
+.It Ic gid
+.It Ic gecos
+.It Ic home
+.It Ic shell
+.It Ic change
+.It Ic expire
+.It Ic class
+.It Ic groupname
+.It Ic grouppasswd
+.It Ic groupgid
+.It Ic groupmembers
+.El
+.It Ic binddn Ar string
+Use the supplied credentials to bind to the directory.
+.It Ic fixed attribute Ar attribute string
+Do not retrieve the specified attribute from LDAP but
+instead set it unconditionnaly to the supplied value for
+every entry.
+.It Ic group filter Ar string
+use the supplied LDAP filter to retrieve group entries.
+.It Ic passwd filter Ar string
+use the supplied LDAP filter to retrieve password entries.
+.El
 .Sh FILES
 .Bl -tag -width "/etc/ypldap.conf" -compact
 .It Pa /etc/ypldap.conf