a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac<?xml version="1.0" encoding="UTF-8"?>

815a836ed89f450f9949d1a40bb99ec3e7889e2eJean-Noël Rouvignac<refentry xml:id="ldapcompare-1" xmlns="http://docbook.org/ns/docbook"

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac version="5.0" xml:lang="en"

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac xmlns:xlink="http://www.w3.org/1999/xlink"

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac xmlns:xi="http://www.w3.org/2001/XInclude">

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac <refmeta>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac <refentrytitle><application>ldapcompare</application></refentrytitle>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac </refmeta>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac <refnamediv>

815a836ed89f450f9949d1a40bb99ec3e7889e2eJean-Noël Rouvignac <refname><application>ldapcompare</application></refname>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac <refpurpose>perform LDAP compare operations</refpurpose>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac </refnamediv>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac <refsynopsisdiv>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac <cmdsynopsis>

a0c5d844897894f20544288aa010623829ba12c4Jean-Noel Rouvignac <command>ldapcompare</command>

<arg>-m</arg>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-ops"]/*)'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-proto"]/*)'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-remote"]/*)'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-auth"]/*)'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-props"]/*)'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-misc"]/*[not(@name="sc-quiet")])'/>

<arg>--version</arg>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-general"]/*[@name="sc-help"])'/>

<sbr/><sbr/>

<arg>

<replaceable>attribute</replaceable>:<replaceable>value</replaceable>

</arg>

<arg rep="repeat">DN</arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsection>

<title>Description</title>

<para>

This utility can be used to perform LDAP compare operations in the directory.

</para>

</refsection>

<refsection>

<title>Options</title>

<para>

The following options are supported.

</para>

<variablelist>

<varlistentry>

<term><option>-m, --useCompareResultCode</option></term>

<listitem>

<para>

Use the LDAP compare result as an exit code for reporting differences between

the two LDIF files.

</para>

</listitem>

</varlistentry>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-ops"]/*)'/>

</variablelist>

<refsection>

<title>LDAP Connection Options</title>

<variablelist>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-proto"]/*)'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-remote"]/*)'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-auth"]/*)'/>

</variablelist>

</refsection>

<refsection>

<title>Utility Input/Output Options</title>

<variablelist>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-props"]/*)'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-misc"]/*[not(@name="lc-quiet")])'/>

</variablelist>

</refsection>

<refsection>

<title>General Options</title>

<variablelist>

<varlistentry>

<term><option>--version</option></term>

<listitem>

<para>

Display version information.

</para>

</listitem>

</varlistentry>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-general"]/*[@name="lc-help"])'/>

</variablelist>

</refsection>

</refsection>

<refsection>

<title>Examples</title>

<informalexample>

<para>

The following examples demonstrate comparing Babs Jensen's UID. It uses a

matching UID value.

</para>

<literallayout><prompt

>$ </prompt><command>ldapcompare -p 1389 uid:bjensen \

uid=bjensen,ou=people,dc=example,dc=com</command></literallayout>

<screen>

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>

</informalexample>

<informalexample>

<para>

The following example uses a UID value that does not match.

</para>

<literallayout><prompt

>$ </prompt><command>ldapcompare -p 1389 uid:beavis \

uid=bjensen,ou=people,dc=example,dc=com</command></literallayout>

<screen>

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>

</informalexample>

</refsection>

<xi:include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>

<refsection name='exit-ops'>

<title>Exit Codes</title>

<variablelist>

<xi:include href="common.xml"

xpointer='xpointer(//refsection[@name="exit-ops"]/variablelist/varlistentry[position()=1])'/>

<varlistentry>

<term><errorcode>5</errorcode></term>

<listitem>

<para>

The <option>-m</option> option was used, and no differences are reported.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><errorcode>6</errorcode></term>

<listitem>

<para>

The <option>-m</option> option was used, and differences are reported.

</para>

</listitem>

</varlistentry>

<xi:include href="common.xml"

xpointer='xpointer(//refsection[@name="exit-ops"]/variablelist/varlistentry[position()!=1])'/>

</variablelist>

</refsection>

<xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>

</refentry>