<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>AKIRA</firstname>">
  <!ENTITY dhsurname   "<surname>YAMADA</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>5 15, 2004</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>akira@debian.org</email>">
  <!ENTITY dhusername  "akira yamada">
  <!ENTITY dhucpackage "<refentrytitle>DOCDIFF</refentrytitle>">
  <!ENTITY dhpackage   "docdiff">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2004</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>character/word-oriented diff</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>


      <arg><option>options</option></arg>

      <arg choice="req"><replaceable>file1</replaceable></arg>

      <arg choice="req"><replaceable>file2</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command>
      commands.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.
      Instead, it has documentation in the HTML
      format; see below.</para>

    <para><command>&dhpackage;</command> is a program that
      compares two files and shows the difference. 
      It can compare files word by word, char by char, or line by line. 
      It has several output formats such as 
      HTML/XHTML, tty, Manued, or user-defined markup.</para>

    <para>It supports several encodings and end-of-line characters, 
      including ASCII, UTF-8, EUC-JP, Shift_JIS, CR, LF, and CRLF.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
	<term><option>--resolution=<replaceable>RESOLUTION</replaceable></option></term>
	<listitem>
	  <para>specify resolution (granularity)
	    line|word|char (default is word)</para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term><option>--line</option></term>
	<listitem>
	  <para>set resolution to line</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--word</option></term>
	<listitem>
	  <para>set resolution to word</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--char</option></term>
	<listitem>
	  <para>set resolution to char</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--encoding=<replaceable>ENCODING</replaceable></option></term>
	<listitem>
	  <para>specify character encoding
	    ASCII|EUC-JP|Shift_JIS|UTF-8|auto
	    (default is auto)</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--ascii</option></term>
	<listitem>
	  <para>same as --encoding=ASCII</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--eucjp</option></term>
	<listitem>
	  <para>same as --encoding=EUC-JP</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--sjis</option></term>
	<listitem>
	  <para>same as --encoding=Shift_JIS</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--utf8</option></term>
	<listitem>
	  <para>same as --encoding=UTF-8</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--eol=<replaceable>EOL</replaceable></option></term>
	<listitem>
	  <para>specify end-of-line character
	    CR|LF|CRLF|auto
	    (default is auto)</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--cr</option></term>
	<listitem>
	  <para>same as --eol=CR</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--lf</option></term>
	<listitem>
	  <para>same as --eol=LF</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--crlf</option></term>
	<listitem>
	  <para>same as --eol=CRLF</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--format=FORMAT</option></term>
	<listitem>
	  <para>specify output format
	    tty|manued|html|wdiff|user
	    (default is html; 
	    user tags have to be described in config file)</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--tty</option></term>
	<listitem>
	  <para>same as --format=tty</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--manued</option></term>
	<listitem>
	  <para>same as --format=manued</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--html</option></term>
	<listitem>
	  <para>same as --format=html</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--wdiff</option></term>
	<listitem>
	  <para>same as --format=wdiff</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--digest</option></term>
	<listitem>
	  <para>digest output, do not show all</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--cache</option></term>
	<listitem>
	  <para>use file cache</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--no-config-file</option></term>
	<listitem>
	  <para>do not read config files</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--verbose</option></term>
	<listitem>
	  <para>run verbosely</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--help</option></term>
	<listitem>
	  <para>show usage</para>
	</listitem>
      </varlistentry>
                             
      <varlistentry>
	<term><option>--version</option></term>
	<listitem>
	  <para>show version</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--license</option></term>
	<listitem>
	  <para>show license</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--author</option></term>
	<listitem>
	  <para>show author(s)</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>/usr/share/doc/docdiff/readme.html.</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


