mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Mark Craig
12.46.2015 a8398cd75c6fc288aab762e70d026ce51a6bfe5d
opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
@@ -186,7 +186,8 @@
INFO_SEARCH_DESCRIPTION_TIME_LIMIT=Maximum length of time in seconds to \
 allow for the search
INFO_SEARCH_DESCRIPTION_SEARCH_SCOPE=Search scope ('base', 'one', 'sub', \
 or 'subordinate')
 or 'subordinate'). Note: 'subordinate' is an LDAP extension \
 that might not work with all LDAP servers
INFO_SEARCH_DESCRIPTION_DEREFERENCE_POLICY=Alias dereference policy \
 ('never', 'always', 'search', or 'find')
ERR_LDAPAUTH_UNSUPPORTED_SASL_MECHANISM=The requested SASL mechanism \
@@ -251,7 +252,14 @@
INFO_BIND_GRACE_LOGINS_REMAINING=# You have %d grace logins remaining
INFO_DESCRIPTION_USE_PWP_CONTROL=Use the password policy request control
INFO_LDAPPWMOD_DESCRIPTION_AUTHZID=Authorization ID for the \
 user entry whose password should be changed
 user entry whose password should be changed. \
 The authorization ID is a string having either \
 the prefix "dn:" followed by the user's distinguished name, or \
 the prefix "u:" followed by a user identifier \
 that depends on the identity mapping used \
 to match the user identifier to an entry in the directory. \
 Examples include "dn:uid=bjensen,ou=People,dc=example,dc=com", and, \
 if we assume that "bjensen" is mapped to Barbara Jensen's entry, "u:bjensen"
INFO_LDAPPWMOD_DESCRIPTION_NEWPW=New password to provide \
 for the target user
INFO_LDAPPWMOD_DESCRIPTION_NEWPWFILE=Path to a file \
@@ -539,3 +547,214 @@
ERR_ADDRATE_SIZE_THRESHOLD_LOWER_THAN_ITERATIONS=The size threshold must be lower than \
 the maximum number of add operations
INFO_ADDRATE_DESCRIPTION_NOPURGE=Disable the purge phase when the tool stops.
# Supplements to descriptions for generated reference documentation.
SUPPLEMENT_DESCRIPTION_PSEARCH_INFO=<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.                           \
       If you do not set the <literal>changetype</literal>,                        \
       the default behavior is to send notifications for all updates.              \
      </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 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>
SUPPLEMENT_DESCRIPTION_CONTROLS=<para>                                             \
    For some <replaceable>controloid</replaceable> values,                         \
    you can replace object identifiers with user-friendly strings.                 \
                                                                                   \
    The strings are listed here in lower case, but the case is not important.      \
    You can use camelCase if you prefer, for example.                              \
   </para>                                                                         \
                                                                                   \
   <variablelist>                                                                  \
    <varlistentry>                                                                 \
     <term><literal>accountusable</literal></term>                                 \
     <term><literal>accountusability</literal></term>                              \
     <listitem>                                                                    \
      <para>Account Usability Control, Object Identifier: 1.3.6.1.4.1.42.2.27.9.5.8</para> \
     </listitem>                                                                   \
    </varlistentry>                                                                \
                                                                                   \
    <varlistentry>                                                                 \
     <term><literal>authzid</literal></term>                                       \
     <term><literal>authorizationidentity</literal></term>                         \
     <listitem>                                                                    \
      <para>Authorization Identity Request Control, Object Identifier: 2.16.840.1.113730.3.4.16</para> \
     </listitem>                                                                   \
    </varlistentry>                                                                \
                                                                                   \
    <varlistentry>                                                                 \
     <term><literal>effectiverights</literal></term>                               \
     <term><literal>geteffectiverights</literal></term>                            \
     <listitem>                                                                    \
      <para>Get Effective Rights Request Control, Object Identifier: 1.3.6.1.4.1.42.2.27.9.5.2</para> \
     </listitem>                                                                   \
    </varlistentry>                                                                \
                                                                                   \
    <varlistentry>                                                                 \
     <term><literal>managedsait</literal></term>                                   \
     <listitem>                                                                    \
      <para>Manage DSAIT Request Control, Object Identifier: 2.16.840.1.113730.3.4.2</para> \
     </listitem>                                                                   \
    </varlistentry>                                                                \
                                                                                   \
    <varlistentry>                                                                 \
     <term><literal>noop</literal></term>                                          \
     <term><literal>no-op</literal></term>                                         \
     <listitem>                                                                    \
      <para>No-Op Control, Object Identifier: 1.3.6.1.4.1.4203.1.10.2</para>       \
     </listitem>                                                                   \
    </varlistentry>                                                                \
                                                                                   \
    <varlistentry>                                                                 \
     <term><literal>pwpolicy</literal></term>                                      \
     <term><literal>passwordpolicy</literal></term>                                \
     <listitem>                                                                    \
      <para>Password Policy Control, Object Identifier: 1.3.6.1.4.1.42.2.27.8.5.1</para> \
     </listitem>                                                                   \
    </varlistentry>                                                                \
                                                                                   \
    <varlistentry>                                                                 \
     <term><literal>realattrsonly</literal></term>                                 \
     <term><literal>realattributesonly</literal></term>                            \
     <listitem>                                                                    \
      <para>Real Attributes Only Request Control, Object Identifier: 2.16.840.1.113730.3.4.17</para> \
     </listitem>                                                                   \
    </varlistentry>                                                                \
                                                                                   \
    <varlistentry>                                                                 \
     <term><literal>subtreedelete</literal></term>                                 \
     <term><literal>treedelete</literal></term>                                    \
     <listitem>                                                                    \
      <para>Subtree Delete Request Control, Object Identifier: 1.2.840.113556.1.4.805</para> \
     </listitem>                                                                   \
    </varlistentry>                                                                \
                                                                                   \
    <varlistentry>                                                                 \
     <term><literal>virtualattrsonly</literal></term>                              \
     <term><literal>virtualattributesonly</literal></term>                         \
     <listitem>                                                                    \
      <para>Virtual Attributes Only Request Control, Object Identifier: 2.16.840.1.113730.3.4.19</para> \
     </listitem>                                                                   \
    </varlistentry>                                                                \
   </variablelist>