- note that NIS is a postop plugin, not object

- note that the defaults at the bottom of getting-started actually work

1 files changed, 21 insertions, 15 deletions

diff --git a/doc/nis-getting-started.txt b/doc/nis-getting-started.txt
index a3756f4..9c35a2f 100644
--- a/doc/nis-getting-started.txt
+++ b/doc/nis-getting-started.txt
@@ -6,8 +6,8 @@ information for a domain named "example.com".
 Because NIS servers need to listen on privileged ports, and because the
 directory server is usually configured to drop privileges at startup,
 getting the plugin running is usually a two-step process.  First, the
-server must be configured to load, and then the server must be restarted
-to actually get the plugin loaded.
+server must be configured to load the plugin, and then the server must
+be restarted to actually get the plugin loaded.
 
 == Loading the plugin ==
 
@@ -21,7 +21,7 @@ cn=config tree:
     cn: NIS Server
     nsslapd-pluginPath: /usr/lib/dirsrv/plugins/nisserver-plugin.so
     nsslapd-pluginInitfunc: nis_plugin_init
-    nsslapd-pluginType: object
+    nsslapd-pluginType: postoperation
     nsslapd-pluginEnabled: on
     nsslapd-pluginDescription: NIS Server Plugin
     nsslapd-pluginVendor: redhat.com
@@ -33,12 +33,15 @@ cn=config tree:
 The name of the entry can be anything you like, but the path to the
 plugin itself needs to be correct for your system.
 
-In this example, we set two options -- the name used when evaluating the
-tcp_wrappers (/etc/hosts.allow and /etc/hosts.deny) configuration, and
-the port number on which we want the server to listen.  We could leave
-the port number unset and let the server select a port at startup-time,
-but my example system is firewalled, and I need to know which port it'll
-be using in order to punch a hole in the firewall for it.
+In this example, we set the options that are required for loading a
+plugin (the path, init function, the type of object, and so on) and two
+options which are specific to the module -- the name used when
+evaluating the tcp_wrappers (/etc/hosts.allow and /etc/hosts.deny)
+configuration, and the port number on which we want the server to
+listen.  We could leave the port number unset and let the server select
+a port at startup-time, but my example system is firewalled, and I need
+to know which port it'll be using in order to punch a hole in the
+firewall for it.
 
 If the entry was added to a running server, then the server should be
 restarted.  Running the "/usr/sbin/rpcinfo -p | grep ypserv" command
@@ -73,9 +76,9 @@ something like this:
 In order to expose data from directory server entries via a NIS map, the
 plugin needs to be provided with enough information to let it find the
 set of directory entries which need to be exposed, and it needs to be
-provided with instructions for building key/value pairs using those
-entries.  Of course, it also needs to know the name of the NIS domain
-and the map's name.
+provided with instructions for building the key/value pairs which
+constitute the map by using the contents of those entries.  Of course,
+it also needs to know the name of the NIS domain and the map's name.
 
 The plugin expects that information to be provided in an entry which is
 an immediate child of the entry which caused the plugin to be loaded.
@@ -101,9 +104,9 @@ search, the "uid" attribute will be used as the key in the NIS map, and
 the corresponding value will also be the value of the "uid" attribute.
 
 And just like that, our NIS server is serving the domain, and the
-"ypbind" service running on a client system will be able to find it.
-Of course, that domain contains only one marginally-useful map, but
-that's a different problem.
+"ypbind" service running on a client system will be able to find it.  Of
+course, that domain contains only one not-very-useful map, but that's a
+different problem.
 
 == Formatting Entries ==
 
@@ -306,3 +309,6 @@ from the configuration:
     nis-map: passwd.byuid
     nis-base: ou=People, dc=example, dc=com
 
+The above configuration sets up both the "passwd.byname" and
+"passwd.byuid" maps using the default key and value specifiers, which
+should work correctly for most cases.