mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git
parent: 55065c75 | patch | commit | ignore whitespace
Mark Craig
23.39.2013 2e2be1e27a820308b7cf904e0e20aa4677b3d731 
OPENDJ-1144: Document recognized control names

Thanks to Chris Ridd for reviewing the patch I posted to the issue and letting me know by IM.
3 files modified
225 ■■■■■ changed files
opendj3/src/main/docbkx/dev-guide/man-ldapsearch.xml 83 ●●●●● patch | view | raw | blame | history
opends/resource/man/man1/ldapsearch.1 57 ●●●●● patch | view | raw | blame | history
opends/src/main/docbkx/admin-guide/man-ldapsearch.xml 85 ●●●●● patch | view | raw | blame | history 
 opendj3/src/main/docbkx/dev-guide/man-ldapsearch.xml


@@ -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'


 xmlns:xinclude='http://www.w3.org/2001/XInclude'>


 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>


 <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>


 <refmeta>


  <refentrytitle>ldapsearch</refentrytitle><manvolnum>1</manvolnum>


  <refmiscinfo class="software">OpenDJ</refmiscinfo>


@@ -128,6 +128,87 @@


    <term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>


    <listitem>


     <para>Use a request control with the provided information</para>




      <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>


    </listitem>


   </varlistentry>


   <varlistentry>




 opends/resource/man/man1/ldapsearch.1


@@ -2,12 +2,12 @@


.\"     Title: ldapsearch


.\"    Author: 


.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>


.\"      Date: 10/16/2012


.\"      Date: 10/23/2013


.\"    Manual: Tools Reference


.\"    Source: OpenDJ 2.5.0


.\"    Source: OpenDJ 2.7.0-SNAPSHOT


.\"  Language: English


.\"


.TH "LDAPSEARCH" "1" "10/16/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"


.TH "LDAPSEARCH" "1" "10/23/2013" "OpenDJ 2\&.7\&.0\-SNAPSHOT" "Tools Reference"


.\" -----------------------------------------------------------------


.\" * Define some portability stuff


.\" -----------------------------------------------------------------


@@ -99,6 +99,55 @@


\fB\-J, \-\-control {controloid[:criticality[:value|::b64value|:<filePath]]}\fR


.RS 4


Use a request control with the provided information


.sp


For some


\fIcontroloid\fR


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\&.


.PP


accountusable, accountusability


.RS 4


Account Usability Control, Object Identifier: 1\&.3\&.6\&.1\&.4\&.1\&.42\&.2\&.27\&.9\&.5\&.8


.RE


.PP


authzid, authorizationidentity


.RS 4


Authorization Identity Request Control, Object Identifier: 2\&.16\&.840\&.1\&.113730\&.3\&.4\&.16


.RE


.PP


effectiverights, geteffectiverights


.RS 4


Get Effective Rights Request Control, Object Identifier: 1\&.3\&.6\&.1\&.4\&.1\&.42\&.2\&.27\&.9\&.5\&.2


.RE


.PP


managedsait


.RS 4


Manage DSAIT Request Control, Object Identifier: 2\&.16\&.840\&.1\&.113730\&.3\&.4\&.2


.RE


.PP


noop, no\-op


.RS 4


No\-Op Control, Object Identifier: 1\&.3\&.6\&.1\&.4\&.1\&.4203\&.1\&.10\&.2


.RE


.PP


pwpolicy, passwordpolicy


.RS 4


Password Policy Control, Object Identifier: 1\&.3\&.6\&.1\&.4\&.1\&.42\&.2\&.27\&.8\&.5\&.1


.RE


.PP


realattrsonly, realattributesonly


.RS 4


Real Attributes Only Request Control, Object Identifier: 2\&.16\&.840\&.1\&.113730\&.3\&.4\&.17


.RE


.PP


subtreedelete, treedelete


.RS 4


Subtree Delete Request Control, Object Identifier: 1\&.2\&.840\&.113556\&.1\&.4\&.805


.RE


.PP


virtualattrsonly, virtualattributesonly


.RS 4


Virtual Attributes Only Request Control, Object Identifier: 2\&.16\&.840\&.1\&.113730\&.3\&.4\&.19


.RE


.RE


.PP


\fB\-l, \-\-timeLimit {timeLimit}\fR


@@ -481,5 +530,5 @@


.\}


.SH "COPYRIGHT"


.br


Copyright \(co 2011-2012 ForgeRock AS


Copyright \(co 2011-2013 ForgeRock AS


.br




 opends/src/main/docbkx/admin-guide/man-ldapsearch.xml


@@ -20,7 +20,7 @@


  !


  ! CCPL HEADER END


  !


  !      Copyright 2011-2012 ForgeRock AS


  !      Copyright 2011-2013 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'


 xmlns:xinclude='http://www.w3.org/2001/XInclude'>


 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>


 <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>


 <refmeta>


  <refentrytitle>ldapsearch</refentrytitle><manvolnum>1</manvolnum>


  <refmiscinfo class="software">OpenDJ</refmiscinfo>


@@ -128,6 +128,87 @@


    <term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>


    <listitem>


     <para>Use a request control with the provided information</para>




     <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>


    </listitem>


   </varlistentry>


   <varlistentry>