README for diffmk

Norman Walsh

Staff Engineer
Sun Microsystems, XML Technology Center
$Id: README.xml,v 1.5 2000/11/28 16:26:11 ndw Exp $

09 Nov 2000


Table of Contents

Requirements
Manifest
Installing diffmk
Running diffmk

Requirements

Before attempting to install diffmk, make sure that you have installed the following:

Manifest

Programs and Documentation

README.html

This document.

article.html

The Sun XML Developer Connection article that I wrote about this program.

diffmk

The diffmk program.

diffmk.xml

The diffmk Control File.

diffmk.html

Reference documentation for diffmk

diffmk.dtd

The DTD for the format of the diffmk Control File.

diffmk.xsd

The XML Schema for the format of the diffmk Control File.

Documentation Sources

README.xml

The XML source for this document.

refentry.xml

The XML source for the reference documentation.

Examples

test1.xml

A test document.

test2.xml

A revision of the test document.

diff.txt

The text-based diff-version of the differences between test1.xml and test2.xml.

out.xml

The diffmk-version of the differences between test1.xml and test2.xml.

test1.html

An HTML rendering of test1.xml.

test2.html

An HTML rendering of test2.xml.

out.html

An HTML rendering of out.xml.

frames.html

An HTML frames driver that shows test1.html, test2.html, and out.html side-by-side.

Installing diffmk

  1. Install the diffmk script somewhere in your path. If you don't want to put it in your path, you can install it anywhere you like and use its fully-qualified path name to execute it.

  2. Place the diffmk.xml Control File somewhere that diffmk will find it. You can put it in the same directory as the diffmk script, in your home directory, or anywhere on your Perl @INC path. If you put it in your home directory, rename it .diffmk.xml.

Running diffmk

On Unix systems, you can simply run the script like any other command from the shell prompt:

$ diffmk --doctype docbook file1.xml file2.xml output.xml

On Windows, you will probably have to explicitly invoke Perl:

C:\>perl \path\where\you\installed\it\diffmk --doctype docbook file1.xml file2.xml output.xml

See the reference documentation for a complete summary of the options available.