6330N/A<?xml version="1.0" encoding="UTF-8"?>
6330N/A<!--
6330N/A ! CCPL HEADER START
6330N/A !
6330N/A ! This work is licensed under the Creative Commons
6330N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
6330N/A ! To view a copy of this license, visit
6330N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
6330N/A ! or send a letter to Creative Commons, 444 Castro Street,
6330N/A ! Suite 900, Mountain View, California, 94041, USA.
6330N/A !
6330N/A ! You can also obtain a copy of the license at
6330N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
6330N/A ! See the License for the specific language governing permissions
6330N/A ! and limitations under the License.
6330N/A !
6330N/A ! If applicable, add the following below this CCPL HEADER, with the fields
6330N/A ! enclosed by brackets "[]" replaced with your own identifying information:
6330N/A ! Portions Copyright [yyyy] [name of copyright owner]
6330N/A !
6330N/A ! CCPL HEADER END
6330N/A !
6330N/A ! Copyright 2011-2012 ForgeRock AS
6330N/A ! Portions Copyright 2013 Jens Elkner
6330N/A !
6330N/A-->
6330N/A<refentry xml:id="ldapcompare-1" xmlns="http://docbook.org/ns/docbook"
6330N/A version="5.0" xml:lang="en"
6330N/A xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6330N/A xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
6330N/A xmlns:xlink="http://www.w3.org/1999/xlink"
6330N/A xmlns:xi="http://www.w3.org/2001/XInclude">
6330N/A <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
6330N/A <refmeta>
6330N/A <refentrytitle><application>ldapcompare</application></refentrytitle>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
6330N/A </refmeta>
6330N/A <refnamediv>
6330N/A <refname><application>ldapcompare</application></refname>
6330N/A <refpurpose>perform LDAP compare operations</refpurpose>
6330N/A </refnamediv>
6330N/A <refsynopsisdiv>
6330N/A <cmdsynopsis>
6330N/A <command>ldapcompare</command>
6330N/A <arg>-m</arg>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="s-ops"]/*[not(@name="sc-authz")])'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="s-proto"]/*[@name="sc-ssl-tls"
6331N/A or @name="sc-lver"])'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-remote"]/*)'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-auth"]/*)'/>
6331N/A <arg>-r</arg>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-props"]/*)'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-misc"]/*[not(@name="sc-quiet")])'/>
6330N/A <arg>--version</arg>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-general"]/*[@name="sc-help"])'/>
6330N/A <sbr/><sbr/>
6330N/A <arg>
6330N/A <replaceable>attribute</replaceable>:<replaceable>value</replaceable>
6330N/A </arg>
6330N/A <arg rep="repeat">DN</arg>
6330N/A </cmdsynopsis>
6330N/A </refsynopsisdiv>
6330N/A <refsection>
6330N/A <title>Description</title>
6330N/A <para>
6330N/AThis utility can be used to perform LDAP compare operations in the directory.
6330N/A </para>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Options</title>
6330N/A <para>
6330N/AThe following options are supported.
6330N/A </para>
6330N/A <variablelist>
6330N/A <varlistentry>
6330N/A <term><option>-m, --useCompareResultCode</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/AUse the LDAP compare result as an exit code for reporting differences between
6330N/Athe two LDIF files.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="l-ops"]/*[not(@name="lc-authz")])'/>
6330N/A </variablelist>
6330N/A <refsection>
6330N/A <title>LDAP Connection Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="l-proto"]/*[@name="lc-ssl"
6331N/A or @name="lc-tls" or @name="lc-lver"])'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-remote"]/*)'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-auth"]/*)'/>
6331N/A <varlistentry>
6331N/A <term><option>-r, --useSASLExternal</option></term>
6331N/A <listitem>
6331N/A <para>
6331N/AUse the SASL EXTERNAL authentication mechanism.
6331N/A </para>
6331N/A </listitem>
6331N/A </varlistentry>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Utility Input/Output Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-props"]/*)'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-misc"]/*[not(@name="lc-quiet")])'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>General Options</title>
6330N/A <variablelist>
6330N/A <varlistentry>
6330N/A <term><option>--version</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/ADisplay version information.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-general"]/*[@name="lc-help"])'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Examples</title>
6330N/A <informalexample>
6330N/A <para>
6330N/AThe following examples demonstrate comparing Babs Jensen's UID. It uses a
6330N/Amatching UID value.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>ldapcompare -p 1389 uid:bjensen \
6330N/A uid=bjensen,ou=people,dc=example,dc=com</command></literallayout>
6330N/A <screen>
6330N/AComparing type uid with value bjensen in entry
6330N/Auid=bjensen,ou=people,dc=example,dc=com
6330N/ACompare operation returned true for entry
6330N/Auid=bjensen,ou=people,dc=example,dc=com
6330N/A</screen>
6330N/A </informalexample>
6330N/A <informalexample>
6330N/A <para>
6330N/AThe following example uses a UID value that does not match.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>ldapcompare -p 1389 uid:beavis \
6330N/A uid=bjensen,ou=people,dc=example,dc=com</command></literallayout>
6330N/A <screen>
6330N/AComparing type uid with value beavis in entry
6330N/Auid=bjensen,ou=people,dc=example,dc=com
6330N/ACompare operation returned false for entry
6330N/Auid=bjensen,ou=people,dc=example,dc=com
6330N/A</screen>
6330N/A </informalexample>
6330N/A </refsection>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
6330N/A <refsection name='exit-ops'>
6330N/A <title>Exit Codes</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//refsection[@name="exit-ops"]/variablelist/varlistentry[position()=1])'/>
6330N/A <varlistentry>
6330N/A <term><errorcode>5</errorcode></term>
6330N/A <listitem>
6330N/A <para>
6330N/AThe <option>-m</option> option was used, and no differences are reported.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><errorcode>6</errorcode></term>
6330N/A <listitem>
6330N/A <para>
6330N/AThe <option>-m</option> option was used, and differences are reported.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//refsection[@name="exit-ops"]/variablelist/varlistentry[position()!=1])'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
6330N/A</refentry>