- more on nis-key-format vs. nis-keys-format

2 files changed, 21 insertions, 7 deletions

diff --git a/doc/configuration.txt b/doc/configuration.txt
index 63c33fc..de8ed55 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -82,9 +82,16 @@ beneath the plugin's entry.  These attributes are recognized:
  * nis-key-format
    A format specifier which the plugin will use to convert the contents
    of the directory server entry into the corresponding key in the NIS
+   map.  If this attribute has no or more than one value, it will be
+   ignored.  This can be used to ensure a 1-to-1 mapping between entries
+   in the directory server and a NIS map.
+ * nis-keys-format
+   A format specifier which the plugin will use to convert the contents
+   of the directory server entry into the corresponding key in the NIS
    map.  If this attribute has more than one value, the resulting NIS
    map will include each resulting key with the same corresponding
-   value.
+   value.  This can be used to allow for an arbitrary number of NIS map
+   entries to be created for a given directory server entry.
  * nis-value-format
    A format specifier which the plugin will use to convert the contents
    of the directory server entry into the corresponding value in the NIS
@@ -94,9 +101,10 @@ beneath the plugin's entry.  These attributes are recognized:
    cause that attribute value to be ignored when evaluating keys and
    values.
 
-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:
+The nis-filter, nis-key-format, nis-keys-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
diff --git a/doc/design.txt b/doc/design.txt
index 069c011..140c1a1 100644
--- a/doc/design.txt
+++ b/doc/design.txt
@@ -185,6 +185,7 @@ plugin's entry, the backend checks for entries with these attributes:
  * nis-base
  * nis-filter
  * nis-key-format
+ * nis-keys-format
  * nis-value-format
 The backend then instructs the map cache to prepare to hold a map in the
 given domain (or domains) with the given map name (or names), and then
@@ -197,11 +198,16 @@ using the format specifier given as the "nis-value-format".  The map is
 marked as a "secure" map according to the "nis-secure" attribute, if
 so set.
 
+For each "nis-key-format" value, exactly one entry will be created in a
+NIS map.  For each "nis-keys-format" value, any number of entries will
+be created in a NIS map.
+
 Should one of the directory server entries which was used to construct
 one or more NIS map entries be modified or removed, the corresponding
-entry in every applicable NIS map is updated or removed.  Likewise, if
-an entry is added to the directory server which would correspond to an
-entry in a NIS map, an entry is created in that NIS map.
+entries in every applicable NIS map are updated or removed.  Likewise,
+if an entry is added to the directory server which would correspond to
+an entry in a NIS map, entries are created in the corresponding NIS
+maps.
 
 == Formatting Data for NIS ==