- add a couple of examples

1 files changed, 38 insertions, 3 deletions

diff --git a/doc/configuration.txt b/doc/configuration.txt
index c7bb825..08376b0 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -33,6 +33,28 @@ recognized:
    privileged port, but this option is provided to allow administrators
    to run the service on systems which have firewalls configured.
 
+In combination with the settings the directory server itself needs in
+order to be able to load a postoperation plugin, an example entry might
+look like this:
+
+  dn: cn=NIS Server, cn=plugins, cn=config
+  objectclass: top
+  objectclass: nsSlapdPlugin
+  objectclass: extensibleObject
+  cn: NIS Server
+  nsslapd-pluginpath: /usr/lib/dirsrv/plugins/nisserver-plugin.so
+  nsslapd-plugininitfunc: nis_plugin_init
+  nsslapd-plugintype: postoperation
+  nsslapd-pluginenabled: on
+  nsslapd-pluginid: nis-server
+  nsslapd-version: 0.0
+  nsslapd-pluginvendor: redhat.com
+  nsslapd-plugindescription: NIS Server Plugin
+  nsslapd-pluginarg0: 876
+  nis-tcp-wrappers-name: nis-server
+  nis-max-dgram-size: 2048
+  nis-max-value-size: 1048576
+
 Configuration for individual maps should be stored in entries directly
 beneath the plugin's entry.  These attributes are recognized:
 
@@ -65,6 +87,19 @@ beneath the plugin's entry.  These attributes are recognized:
    A format specifier which the plugin will use to convert the contents
    of the directory server entry into the corresponding value in the NIS
    map.
- The nis-filter, nis-key-format, and nis-value-format all have default
- settings which vary based on the name of the NIS map, but they can be
- overridden.
+
+The nis-filter, nis-key-format, and nis-value-format all have default
+settings which vary based on the name of the NIS map, but they can be
+overridden.  An example map definition might look like this:
+
+  dn: nis-domain=example.com+map=email.byname,cn=NIS Server,cn=plugins,cn=config
+  objectclass: top
+  objectclass: extensibleObject
+  nis-domain: example.com
+  nis-map: email.byname
+  nis-base: cn=Users, cn=Accounts, dc=example, dc=com
+  nis-filter: (&(mail=*)(uid=*))
+  nis-key-format: %{uid}
+  nis-value-format: %{uid}:%{mail}
+  nis-secure: no
+