From 550f1b534995e089632dd7d91f049b5cb3c82a2c Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Wed, 22 Oct 2014 15:16:27 +0000
Subject: [PATCH] Backport CR-4936 OPENDJ-1593 Fix problems in Understanding LDAP chapters
---
opends/src/main/docbkx/admin-guide/man-ldifsearch.xml | 10 +++++
opends/src/main/docbkx/admin-guide/chap-understanding-ldap.xml | 28 +++++++++++++-
opends/resource/man/man1/ldifsearch.1 | 23 +++++++----
opends/resource/man/man1/ldapsearch.1 | 25 ++++++++----
opends/src/main/docbkx/admin-guide/man-ldapsearch.xml | 10 +++++
5 files changed, 78 insertions(+), 18 deletions(-)
diff --git a/opends/resource/man/man1/ldapsearch.1 b/opends/resource/man/man1/ldapsearch.1
index a3962c4..01495e5 100644
--- a/opends/resource/man/man1/ldapsearch.1
+++ b/opends/resource/man/man1/ldapsearch.1
@@ -1,13 +1,13 @@
'\" t
.\" Title: ldapsearch
.\" Author:
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 10/23/2013
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\" Date: 10/22/2014
.\" Manual: Tools Reference
-.\" Source: OpenDJ 2.7.0-SNAPSHOT
+.\" Source: OpenDJ 3.0.0
.\" Language: English
.\"
-.TH "LDAPSEARCH" "1" "10/23/2013" "OpenDJ 2\&.7\&.0\-SNAPSHOT" "Tools Reference"
+.TH "LDAPSEARCH" "1" "10/22/2014" "OpenDJ 3\&.0\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -392,6 +392,11 @@
\fIobjectclass\fR
is one of the object classes on the entries returned by the search\&.
.RE
+.PP
+1\&.1
+.RS 4
+Return no attributes, only the DNs of matching entries\&.
+.RE
.SH "EXIT CODES"
.PP
0
@@ -430,6 +435,7 @@
ldapmodify\&.port=1389
ldappasswordmodify\&.port=1389
ldapsearch\&.port=1389
+
.fi
.if n \{\
.RE
@@ -443,7 +449,7 @@
.RS 4
.\}
.nf
-$ ldapsearch \-p 1389 \-b dc=example,dc=com "(uid=*jensen*)" uid
+$ \fBldapsearch \-p 1389 \-b dc=example,dc=com "(uid=*jensen*)" uid\fR
dn: uid=ajensen,ou=People,dc=example,dc=com
uid: ajensen
@@ -467,6 +473,7 @@
Result Code: 0 (Success)
+
.fi
.if n \{\
.RE
@@ -482,7 +489,7 @@
.RS 4
.\}
.nf
-$ ldapsearch \-p 1389 \-b dc=example,dc=com "(uid=bjensen)" @inetorgperson
+$ \fBldapsearch \-p 1389 \-b dc=example,dc=com "(uid=bjensen)" @inetorgperson\fR
dn: uid=bjensen,ou=People,dc=example,dc=com
givenName: Barbara
objectClass: person
@@ -501,6 +508,7 @@
ou: Product Development
ou: People
facsimileTelephoneNumber: +1 408 555 1992
+
.fi
.if n \{\
.RE
@@ -514,7 +522,7 @@
.RS 4
.\}
.nf
-$ ldapsearch \-p 1389 \-b dc=example,dc=com "(uid=bjensen)" +
+$ \fBldapsearch \-p 1389 \-b dc=example,dc=com "(uid=bjensen)" +\fR
dn: uid=bjensen,ou=People,dc=example,dc=com
numSubordinates: 0
structuralObjectClass: inetOrgPerson
@@ -524,11 +532,12 @@
hasSubordinates: false
entryDN: uid=bjensen,ou=people,dc=example,dc=com
entryUUID: fc252fd9\-b982\-3ed6\-b42a\-c76d2546312c
+
.fi
.if n \{\
.RE
.\}
.SH "COPYRIGHT"
.br
-Copyright \(co 2011-2013 ForgeRock AS
+Copyright \(co 2011-2014 ForgeRock AS
.br
diff --git a/opends/resource/man/man1/ldifsearch.1 b/opends/resource/man/man1/ldifsearch.1
index 682c089..7cc19e2 100644
--- a/opends/resource/man/man1/ldifsearch.1
+++ b/opends/resource/man/man1/ldifsearch.1
@@ -1,13 +1,13 @@
'\" t
.\" Title: ldifsearch
.\" Author:
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 10/16/2012
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\" Date: 10/22/2014
.\" Manual: Tools Reference
-.\" Source: OpenDJ 2.5.0
+.\" Source: OpenDJ 3.0.0
.\" Language: English
.\"
-.TH "LDIFSEARCH" "1" "10/16/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
+.TH "LDIFSEARCH" "1" "10/22/2014" "OpenDJ 3\&.0\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -131,6 +131,11 @@
\fIobjectclass\fR
is one of the object classes on the entries returned by the search\&.
.RE
+.PP
+1\&.1
+.RS 4
+Return no attributes, only the DNs of matching entries\&.
+.RE
.SH "EXIT CODES"
.PP
0
@@ -150,7 +155,7 @@
.RS 4
.\}
.nf
-$ ldifsearch \-l /path/to/Example\&.ldif \-b dc=example,dc=com uid=bjensen
+$ \fBldifsearch \-l /path/to/Example\&.ldif \-b dc=example,dc=com uid=bjensen\fR
dn: uid=bjensen,ou=People,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
@@ -173,6 +178,7 @@
ou: People
uidNumber: 1076
gidNumber: 1000
+
.fi
.if n \{\
.RE
@@ -188,8 +194,8 @@
.RS 4
.\}
.nf
-$ ldifsearch \-\-ldifFile /path/to/Example\&.ldif
- \-\-baseDN dc=example,dc=com "(uid=bjensen)" @posixaccount
+$ \fBldifsearch \-\-ldifFile /path/to/Example\&.ldif \e
+ \-\-baseDN dc=example,dc=com "(uid=bjensen)" @posixaccount\fR
dn: uid=bjensen,ou=People,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
@@ -203,11 +209,12 @@
homeDirectory: /home/bjensen
uidNumber: 1076
gidNumber: 1000
+
.fi
.if n \{\
.RE
.\}
.SH "COPYRIGHT"
.br
-Copyright \(co 2011-2012 ForgeRock AS
+Copyright \(co 2011-2014 ForgeRock AS
.br
diff --git a/opends/src/main/docbkx/admin-guide/chap-understanding-ldap.xml b/opends/src/main/docbkx/admin-guide/chap-understanding-ldap.xml
index df8a574..0de2fd3 100644
--- a/opends/src/main/docbkx/admin-guide/chap-understanding-ldap.xml
+++ b/opends/src/main/docbkx/admin-guide/chap-understanding-ldap.xml
@@ -117,7 +117,7 @@
for words in the dictionary, or for subscriber names in the phone book.
A sample entry follows.</para>
- <programlisting language="LDIF">
+ <programlisting language="ldif">
dn: uid=bjensen,ou=People,dc=example,dc=com
uid: bjensen
cn: Babs Jensen
@@ -219,6 +219,30 @@
<literal>""</literal> (the empty string), is called the root DSE, and
contains information about what the server supports, including the other
base DNs it serves.</para></footnote></para>
+
+ <para>
+ A directory server stores two kinds of attributes in a directory entry:
+ <firstterm>user attributes</firstterm>
+ and <firstterm>operational attributes</firstterm>.
+ User attributes hold the information for users of the directory.
+ All of the attributes shown in the entry at the outset of this section
+ are user attributes.
+ Operational attributes hold information used by the directory itself.
+ Examples of operational attributes include
+ <literal>entryUUID</literal>, <literal>modifyTimestamp</literal>,
+ and <literal>subschemaSubentry</literal>.
+ When an LDAP search operation finds an entry in the directory,
+ the directory server returns all the visible user attributes
+ unless the search request restricts the list of attributes
+ by specifying those attributes explicitly.
+ The directory server does not however return any operational attributes
+ unless the search request specifically asks for them.
+ Generally speaking, applications should change only user attributes,
+ and leave updates of operational attributes to the server,
+ relying on public directory server interfaces to change server behavior.
+ An exception is access control instruction (<literal>aci</literal>) attributes,
+ which are operational attributes used to control access to directory data.
+ </para>
</section>
<section xml:id="ldap-client-server-communication">
@@ -281,7 +305,7 @@
else, her DN would have to change. For another example, if you decide
to consolidate <literal>ou=Customers</literal> and
<literal>ou=Employees</literal> under <literal>ou=People</literal>
- instead, all the entries underneath much change distinguished names.
+ instead, all the entries underneath must change distinguished names.
<footnote><para>Renaming entire branches of entries can be a major
operation for the directory, so avoid moving entire branches if you
can.</para></footnote></para>
diff --git a/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml b/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml
index cfb6979..eed6b0a 100644
--- a/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml
+++ b/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml
@@ -500,6 +500,16 @@
on the entries returned by the search.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><literal>1.1</literal></term>
+ <listitem>
+ <para>
+ Return no attributes, only the DNs of matching entries.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</refsect1>
<refsect1>
diff --git a/opends/src/main/docbkx/admin-guide/man-ldifsearch.xml b/opends/src/main/docbkx/admin-guide/man-ldifsearch.xml
index d198561..23509cc 100644
--- a/opends/src/main/docbkx/admin-guide/man-ldifsearch.xml
+++ b/opends/src/main/docbkx/admin-guide/man-ldifsearch.xml
@@ -172,6 +172,16 @@
on the entries returned by the search.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><literal>1.1</literal></term>
+ <listitem>
+ <para>
+ Return no attributes, only the DNs of matching entries.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</refsect1>
<refsect1>
--
Gitblit v1.10.0