From 3ef562d2eb067eb7dfdbd7cc355d9bbfd054f4d6 Mon Sep 17 00:00:00 2001 From: Mark Craig <mark.craig@forgerock.com> Date: Fri, 13 Feb 2015 07:00:36 +0000 Subject: [PATCH] CR-6068 OPENDJ-1785 Add "extra" doc into code for generated content --- opendj-sdk/opendj-cli/src/main/resources/com/forgerock/opendj/cli/cli.properties | 83 +++++++++++++++++++++++++++++++++++++++++ 1 files changed, 82 insertions(+), 1 deletions(-) diff --git a/opendj-sdk/opendj-cli/src/main/resources/com/forgerock/opendj/cli/cli.properties b/opendj-sdk/opendj-cli/src/main/resources/com/forgerock/opendj/cli/cli.properties index 3460ca2..1d1c969 100755 --- a/opendj-sdk/opendj-cli/src/main/resources/com/forgerock/opendj/cli/cli.properties +++ b/opendj-sdk/opendj-cli/src/main/resources/com/forgerock/opendj/cli/cli.properties @@ -972,4 +972,85 @@ ERR_ERROR_CANNOT_READ_PASSWORD=Unable to read password ERR_ERROR_CANNOT_READ_BIND_NAME=Unable to read bind name ERR_ERROR_CANNOT_READ_HOST_NAME=Cannot read the host name - \ No newline at end of file + +# Supplements to descriptions for generated reference documentation. +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> -- Gitblit v1.10.0