From 9b5347e3f702b433a21e2d02c3a3cbe62ee6c99d Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Wed, 21 Mar 2012 15:13:16 +0000
Subject: [PATCH] Rewind on ldifdiff --> ldif-diff for now
---
opendj3/src/main/docbkx/shared/man-ldif-diff.xml | 188 +++++++++++++++++++++++++++++++++++++++++++++++
opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml | 4
opendj3/src/main/docbkx/admin-guide/index.xml | 2
opendj3/src/main/docbkx/release-notes/chap-compatibility.xml | 14 ++-
4 files changed, 200 insertions(+), 8 deletions(-)
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml b/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
index 3e9e7ce..7835473 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
@@ -336,8 +336,8 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldifdiff-1"
- xlink:role="http://docbook.org/xlink/role/olink">ldifdiff</link></term>
+ <term><link xlink:href="admin-guide#ldif-diff-1"
+ xlink:role="http://docbook.org/xlink/role/olink">ldif-diff</link></term>
<listitem>
<para>Display differences between two LDIF files, with the resulting output
having LDIF format.</para>
diff --git a/opendj3/src/main/docbkx/admin-guide/index.xml b/opendj3/src/main/docbkx/admin-guide/index.xml
index 12bf6c6..147f09c 100644
--- a/opendj3/src/main/docbkx/admin-guide/index.xml
+++ b/opendj3/src/main/docbkx/admin-guide/index.xml
@@ -105,7 +105,7 @@
<xinclude:include href='../shared/man-ldapmodify.xml' />
<xinclude:include href='../shared/man-ldappasswordmodify.xml' />
<xinclude:include href='../shared/man-ldapsearch.xml' />
- <xinclude:include href='../shared/man-ldifdiff.xml' />
+ <xinclude:include href='../shared/man-ldif-diff.xml' />
<xinclude:include href='../shared/man-ldifmodify.xml' />
<xinclude:include href='../shared/man-ldifsearch.xml' />
<xinclude:include href='../shared/man-list-backends.xml' />
diff --git a/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml b/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
index 661e9be..c294017 100644
--- a/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
+++ b/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<chapter xml:id='chap-compatibility'
@@ -36,12 +36,16 @@
<section xml:id="changed-functionality">
<title>Major Changes to Existing Functionality</title>
-
+
+ <para>TODO</para>
+
+<!-- Not yet for OpenDJ 2.5.
<para>The <command>ldif-diff</command> command has been renamed
- <command>ldifdiff</command>, and the <option>--outputLDIF</option>,
- <option>--overwriteExisting</option>, <option>--sourceLDIF</option>,
- <option>--targetLDIF</option> options have been dropped in favor of a
+ <command>ldifdiff</command>, and the <option>-\-outputLDIF</option>,
+ <option>-\-overwriteExisting</option>, <option>-\-sourceLDIF</option>,
+ <option>-\-targetLDIF</option> options have been dropped in favor of a
format closer to that of the <command>diff</command> command.</para>
+-->
</section>
<section xml:id="deprecated-functionality">
diff --git a/opendj3/src/main/docbkx/shared/man-ldif-diff.xml b/opendj3/src/main/docbkx/shared/man-ldif-diff.xml
new file mode 100644
index 0000000..8440922
--- /dev/null
+++ b/opendj3/src/main/docbkx/shared/man-ldif-diff.xml
@@ -0,0 +1,188 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2011-2012 ForgeRock AS
+ !
+-->
+<refentry xml:id='ldif-diff-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-2012</year><holder>ForgeRock AS</holder></copyright></info>
+ <refmeta>
+ <refentrytitle>ldif-diff</refentrytitle><manvolnum>1</manvolnum>
+ <refmiscinfo class="software">OpenDJ</refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>ldif-diff</refname>
+ <refpurpose>compare small LDIF files</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ldif-diff</command>
+ <arg choice="req">options</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This utility can be used to compare two LDIF files and report the
+ differences in LDIF format.</para>
+ </refsect1>
+ <refsect1>
+ <title>Options</title>
+ <para>The following options are supported.</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>-a, --ignoreAttrs {file}</option></term>
+ <listitem>
+ <para>File containing a list of attributes to ignore when computing the
+ difference.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--checkSchema</option></term>
+ <listitem>
+ <para>Takes into account the syntax of the attributes as defined in the
+ schema to make the value comparison. The provided LDIF files must conform
+ to the server schema.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-e, --ignoreEntries {file}</option></term>
+ <listitem>
+ <para>File containing a list of entries (DN) to ignore when computing the
+ difference.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-o, --outputLDIF {file}</option></term>
+ <listitem>
+ <para>File to which the output should be written.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-O, --overwriteExisting</option></term>
+ <listitem>
+ <para>Any existing output file should be overwritten rather than appending
+ to it.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-s, --sourceLDIF {file}</option></term>
+ <listitem>
+ <para>LDIF file to use as the source data.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-S, --singleValueChanges</option></term>
+ <listitem>
+ <para>Each attribute-level change should be written as a separate
+ modification per attribute value rather than one modification per
+ entry.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-t, --targetLDIF {file}</option></term>
+ <listitem>
+ <para>LDIF file to use as the target data.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-V, --version</option></term>
+ <listitem>
+ <para>Display version information.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-?, -H, --help</option></term>
+ <listitem>
+ <para>Display usage information.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>Exit Codes</title>
+ <variablelist>
+ <varlistentry>
+ <term>0</term>
+ <listitem>
+ <para>The command completed successfully.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>> 0</term>
+ <listitem>
+ <para>An error occurred.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>Examples</title>
+ <para>The following example demonstrates use of the command with two
+ small LDIF files.</para>
+ <screen>$ cat /path/to/newuser.ldif
+dn: uid=newuser,ou=People,dc=example,dc=com
+uid: newuser
+objectClass: person
+objectClass: organizationalPerson
+objectClass: inetOrgPerson
+objectClass: top
+cn: New User
+sn: User
+ou: People
+mail: newuser@example.com
+userPassword: changeme
+
+$ cat /path/to/neweruser.ldif
+dn: uid=newuser,ou=People,dc=example,dc=com
+uid: newuser
+objectClass: person
+objectClass: organizationalPerson
+objectClass: inetOrgPerson
+objectClass: top
+cn: New User
+sn: User
+ou: People
+mail: newuser@example.com
+userPassword: secret12
+description: A new description.
+
+$ ldif-diff -s /path/to/newuser.ldif -t /path/to/neweruser.ldif
+dn: uid=newuser,ou=People,dc=example,dc=com
+changetype: modify
+add: userPassword
+userPassword: secret12
+-
+delete: userPassword
+userPassword: changeme
+-
+add: description
+description: A new description.
+</screen>
+ </refsect1>
+</refentry>
\ No newline at end of file
--
Gitblit v1.10.0