From ae57abea41b1a1c805fee27ffcfeabc0ae07e969 Mon Sep 17 00:00:00 2001 From: Mark Craig <mark.craig@forgerock.com> Date: Mon, 31 Mar 2014 07:17:12 +0000 Subject: [PATCH] Backport CR-3283 Fix for Server docs patch for OPENDJ-980: Allow copy/ paste of formatted shell commands; OPENDJ-1376: Add <userinput> and potential <computeroutput> to <screen> content --- opends/src/main/docbkx/admin-guide/man-ldapsearch.xml | 41 +++++++++++++++++++++++++---------------- 1 files changed, 25 insertions(+), 16 deletions(-) diff --git a/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml b/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml index 733162c..cfb6979 100644 --- a/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml +++ b/opends/src/main/docbkx/admin-guide/man-ldapsearch.xml @@ -20,17 +20,17 @@ ! ! CCPL HEADER END ! - ! Copyright 2011-2013 ForgeRock AS + ! Copyright 2011-2014 ForgeRock AS ! --> <refentry xml:id='ldapsearch-1' xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' - 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-2013</year><holder>ForgeRock AS</holder></copyright></info> + 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> <refmeta> <refentrytitle>ldapsearch</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -533,7 +533,8 @@ <para>You can use <filename>~/.opendj/tools.properties</filename> to set the defaults for bind DN, host name, and port number as in the following example.</para> - <programlisting language="ini">hostname=directory.example.com + <programlisting language="ini"> +hostname=directory.example.com port=1389 bindDN=uid=kvaughan,ou=People,dc=example,dc=com @@ -541,14 +542,17 @@ ldapdelete.port=1389 ldapmodify.port=1389 ldappasswordmodify.port=1389 -ldapsearch.port=1389</programlisting> +ldapsearch.port=1389 + </programlisting> </refsect1> <refsect1> <title>Examples</title> <para>The following example searches for entries with UID containing <literal>jensen</literal>, returning only DNs and uid values.</para> - <screen>$ ldapsearch -p 1389 -b dc=example,dc=com "(uid=*jensen*)" uid -dn: uid=ajensen,ou=People,dc=example,dc=com + + <screen> +$ <userinput>ldapsearch -p 1389 -b dc=example,dc=com "(uid=*jensen*)" uid</userinput> +<computeroutput>dn: uid=ajensen,ou=People,dc=example,dc=com uid: ajensen dn: uid=bjensen,ou=People,dc=example,dc=com @@ -570,7 +574,8 @@ uid: tjensen -Result Code: 0 (Success)</screen> +Result Code: 0 (Success)</computeroutput> + </screen> <para>You can also use <literal>@<replaceable >objectclass</replaceable></literal> notation in the attribute list to return @@ -578,8 +583,9 @@ how to return attributes of the <literal>inetOrgPerson</literal> object class.</para> - <screen>$ ldapsearch -p 1389 -b dc=example,dc=com "(uid=bjensen)" @inetorgperson -dn: uid=bjensen,ou=People,dc=example,dc=com + <screen> +$ <userinput>ldapsearch -p 1389 -b dc=example,dc=com "(uid=bjensen)" @inetorgperson</userinput> +<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com givenName: Barbara objectClass: person objectClass: organizationalPerson @@ -596,13 +602,15 @@ l: Cupertino ou: Product Development ou: People -facsimileTelephoneNumber: +1 408 555 1992</screen> +facsimileTelephoneNumber: +1 408 555 1992</computeroutput> + </screen> <para>You can use <literal>+</literal> in the attribute list to return all operational attributes, as in the following example.</para> - <screen>$ ldapsearch -p 1389 -b dc=example,dc=com "(uid=bjensen)" + -dn: uid=bjensen,ou=People,dc=example,dc=com + <screen> +$ <userinput>ldapsearch -p 1389 -b dc=example,dc=com "(uid=bjensen)" +</userinput> +<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com numSubordinates: 0 structuralObjectClass: inetOrgPerson etag: 0000000073c29972 @@ -610,6 +618,7 @@ subschemaSubentry: cn=schema hasSubordinates: false entryDN: uid=bjensen,ou=people,dc=example,dc=com -entryUUID: fc252fd9-b982-3ed6-b42a-c76d2546312c</screen> +entryUUID: fc252fd9-b982-3ed6-b42a-c76d2546312c</computeroutput> + </screen> </refsect1> </refentry> -- Gitblit v1.10.0