From 1601dd4a9bfaae67310bf28de6093f7372ac8b3d Mon Sep 17 00:00:00 2001 From: Mark Craig <mark.craig@forgerock.com> Date: Mon, 31 Mar 2014 07:09:23 +0000 Subject: [PATCH] SDK docs patch for OPENDJ-980: Allow copy/paste of formatted shell commands; OPENDJ-1376: Add <userinput> and potential <computeroutput> to <screen> content --- src/main/docbkx/dev-guide/man-ldapcompare.xml | 30 +++++++++++++++++++----------- 1 files changed, 19 insertions(+), 11 deletions(-) diff --git a/src/main/docbkx/dev-guide/man-ldapcompare.xml b/src/main/docbkx/dev-guide/man-ldapcompare.xml index 61c7e17..1c2ecc3 100644 --- a/src/main/docbkx/dev-guide/man-ldapcompare.xml +++ b/src/main/docbkx/dev-guide/man-ldapcompare.xml @@ -20,17 +20,17 @@ ! ! CCPL HEADER END ! - ! Copyright 2011-2013 ForgeRock AS + ! Copyright 2011-2014 ForgeRock AS ! --> <refentry xml:id='ldapcompare-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>ldapcompare</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -311,17 +311,25 @@ <refsect1> <title>Examples</title> <para>The following examples demonstrate comparing Babs Jensen's UID.</para> + <para>The following example uses a matching UID value.</para> - <screen>$ ldapcompare -p 1389 uid:bjensen uid=bjensen,ou=people,dc=example,dc=com -Comparing type uid with value bjensen in entry + + <screen> +$ <userinput>ldapcompare -p 1389 uid:bjensen uid=bjensen,ou=people,dc=example,dc=com</userinput> +<computeroutput>Comparing type uid with value bjensen in entry uid=bjensen,ou=people,dc=example,dc=com Compare operation returned true for entry -uid=bjensen,ou=people,dc=example,dc=com</screen> +uid=bjensen,ou=people,dc=example,dc=com</computeroutput> + </screen> + <para>The following example uses a UID value that does not match.</para> - <screen>$ ldapcompare -p 1389 uid:beavis uid=bjensen,ou=people,dc=example,dc=com -Comparing type uid with value beavis in entry + + <screen> +$ <userinput>ldapcompare -p 1389 uid:beavis uid=bjensen,ou=people,dc=example,dc=com</userinput> +<computeroutput>Comparing type uid with value beavis in entry uid=bjensen,ou=people,dc=example,dc=com Compare operation returned false for entry -uid=bjensen,ou=people,dc=example,dc=com</screen> +uid=bjensen,ou=people,dc=example,dc=com</computeroutput> + </screen> </refsect1> </refentry> -- Gitblit v1.10.0