Rtfdtohtml User's Guide
			-=====================-


What rtfdtohtml can do for you:
===============================

rtfdtohtml is a simple tool designed to convert RTF and RTFD documents
created on a NeXTSTEP or OPENSTEP system to the HTML format of the
World Wide Web. It will try to reproduce most of the text attributes
such as font style, indentation, size and color as similarly as possible.


I will try to explain in short the basic procedure necessary:

Let's take a look at the text "Example.rtfd" from the distribution archive:

    $ ls Example.rtfd
    TXT.rtf            build.tiff         paste.eps
    amiga.gif          button_smile.jpeg

You can see the actual RTF text and four inline image files in different
formats (GIF, TIFF, JPEG and EPS).


First, we start with the command:

    $ rtfdtohtml -href -blue Example.rtfd

    rtfdtohtml: Processing Example.rtfd...
    $ ls Example.rtfd
    TXT.rtf            build.tiff         button_smile.jpeg  paste.eps
    amiga.gif          build.tiff.gif     index.html         paste.eps.gif

As you can see, "rtfdtohtml" has created three new files:

    index.html		this is the HTML version of the TXT.rtf file
    build.tiff.gif	the TIFF image has been converted to GIF format
    paste.eps.gif	the EPS image has also been converted


If you use the non-LZW enabled version of ImageMagick for image conversions,
you may want to run "compress_gifs" to compress the GIF files:

    $ compress_gifs Example.rtfd
    compress_gifs: Compressing GIF images for Example.rtfd...
    ppmtogif: computing colormap...
    ppmtogif: 4 colors found
    ppmtogif: computing colormap...
    ppmtogif: 183 colors found

This step is NOT required (and not recommended) if you have an LZW enabled
version of ImageMagick, do not use ImageMagick at all, or use the PNG format.
(Read http://www.w3.org/pub/WWW/Graphics/PNG/ for details on the PNG format
and why PNG is better than GIF.)


Finally, the "rmrtfd" program will delete the source files from the sample
directory (assuming that you have a copy elsewhere!):

    $ rmrtfd Example.rtfd
    rmrtfd: Removing RTF for Example.rtfd...
    $ ls Example.rtfd
    amiga.gif          button_smile.jpeg  paste.eps.gif
    build.tiff.gif     index.html

What remains now is the HTML version of the sample RTFD document, the file
"index.html" contains <IMG> references to each of the image files.
Optionally, "rmrtfd" can collect image files from many different directories
and store them in a single shared directory. See the man page for details.

A "rmhtml" program to remove all files created by rtfdtohtml is also
available.


Where can I get more information?
=================================

The doc/man1 subdirectory contains manual pages for all programs,
they will normally be installed in /usr/local/man/man1.

Sample Documents can also be found on the rtfdtohtml home page
(see the file README).