From 37320035f8c15634f9bbe5cf8762c3793a09eee3 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 27 Jan 2015 11:08:33 +0000
Subject: [PATCH] CR-5899 OPENDJ-1748 Document psearch control in ldapsearch
---
opends/src/main/docbkx/admin-guide/man-ldapsearch.xml | 133 +++++++++++++++++++++++++++++++++++++++++++
1 files changed, 131 insertions(+), 2 deletions(-)
diff --git a/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml b/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml
index eed6b0a..4d1d69c 100644
--- a/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml
+++ b/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<refentry xml:id='ldapsearch-1'
@@ -30,7 +30,7 @@
xsi:schemaLocation='http://docbook.org/ns/docbook
http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
<refmeta>
<refentrytitle>ldapsearch</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
@@ -92,6 +92,135 @@
<term><option>-C, --persistentSearch ps[:changetype[:changesonly[:entrychgcontrols]]]</option></term>
<listitem>
<para>Use the persistent search control</para>
+
+ <para>
+ A persistent search allows the client to continue receiving new results
+ whenever changes are made to data that is in the scope of the search,
+ thus using the search as a form of change notification.
+ </para>
+
+ <variablelist>
+ <para>
+ The optional <literal>changetype</literal> setting defines
+ the kinds of updates that result in notification.
+ By default the <literal>changetype</literal> is not set.
+ </para>
+
+ <varlistentry>
+ <term><literal>add</literal></term>
+ <listitem>
+ <para>
+ Send notifications for LDAP add operations.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>del</literal></term>
+ <term><literal>delete</literal></term>
+ <listitem>
+ <para>
+ Send notifications for LDAP delete operations.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>mod</literal></term>
+ <term><literal>modify</literal></term>
+ <listitem>
+ <para>
+ Send notifications for LDAP modify operations.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>moddn</literal></term>
+ <term><literal>modrdn</literal></term>
+ <term><literal>modifydn</literal></term>
+ <listitem>
+ <para>
+ Send notifications for LDAP modify DN (rename and move) operations.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>all</literal></term>
+ <term><literal>any</literal></term>
+ <listitem>
+ <para>
+ Send notifications for all LDAP update operations.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <para>
+ The optional <literal>changesonly</literal> setting defines
+ whether the server returns existing entries as well as changes.
+ </para>
+
+ <varlistentry>
+ <term><literal>true</literal></term>
+ <listitem>
+ <para>
+ Do not return existing entries,
+ but instead only notifications about changes.
+ </para>
+
+ <para>
+ This is the default setting.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>false</literal></term>
+ <listitem>
+ <para>
+ Also return existing entries.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <para>
+ The optional <literal>entrychgcontrols</literal> setting defines
+ whether the server returns an Entry Change Notification control
+ with each entry notification.
+ The Entry Change Notification control provides additional information
+ about the change that caused the entry to be returned as by the search.
+ In particular, it indicates the change type,
+ the change number if available,
+ and the previous DN if the change type was a modify DN operation.
+ </para>
+
+ <varlistentry>
+ <term><literal>true</literal></term>
+ <listitem>
+ <para>
+ Do request the Entry Change Notification control.
+ </para>
+
+ <para>
+ This is the default setting.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>false</literal></term>
+ <listitem>
+ <para>
+ Do not request the Entry Change Notification control.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
<varlistentry>
--
Gitblit v1.10.0