summaryrefslogtreecommitdiffstats
path: root/doc/sch-configuration.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sch-configuration.txt')
-rw-r--r--doc/sch-configuration.txt21
1 files changed, 15 insertions, 6 deletions
diff --git a/doc/sch-configuration.txt b/doc/sch-configuration.txt
index 93e5298..e07a4af 100644
--- a/doc/sch-configuration.txt
+++ b/doc/sch-configuration.txt
@@ -20,24 +20,33 @@ look like this:
Configuration for individual sets should be stored in entries directly
beneath the plugin's entry. These attributes are recognized:
- * schema-compat-container-group
+ * schema-compat-container-group (required)
The top-level container DN under which this container's entry
appears. This level of grouping is primarily useful when using the
''referred'' function.
- * schema-compat-container-rdn
+ * schema-compat-container-rdn (optional)
The RDN of this particular container. If it's omitted, generated
entries will show up directly in the container group.
- * schema-compat-search-base
+ * schema-compat-search-base (required, multivalued)
One or more locations in the directory where candidate entries can be
found.
- * schema-compat-search-filter
+ * schema-compat-search-filter (required)
A filter used to select which candidate entries should have new
entries created for them in this container.
- * schema-compat-entry-rdn
+ * schema-compat-entry-rdn (required)
The RDN to give to generated entries, which will be stored as
children of this container.
- * schema-compat-entry-attribute
+ * schema-compat-entry-attribute (optional, multivalued)
Additional attributes to add to each entry in this container.
+ * schema-compat-ignore-subtree (optional, multivalued)
+ An optional set of subtrees under which the plugin will ignore all
+ content and updates. By default, this is set to "cn=tasks,cn=config".
+ * schema-compat-restrict-subtree (optional, multivalued)
+ An optional set of subtrees from under which the plugin will only
+ consider content and updates. If you have a large DIT and many
+ maps, using this setting may reduce the amount of work the plugin
+ has to do, by short-circuiting possibly-expensive checks to see if
+ an entry being modified affects the contents of various maps.
An pair of example definitions might look like this: