                                                              -*- Text -*-
jargon-fpw 2.0
FreePWING script for The Jargon File

                               Copyright (C) 2000-2004 <satomi@ring.gr.jp>
                           http://homepage3.nifty.ne.jp/satomii/freepwing/

  This document is mainly for those who have obtained the source tarball
  of the jargon-fpw (jargon-fpwX.X-src.tar.gz).

  If you have obtained the pre-converted book package (jargon-fpwX.X.zip),
  you would not need to read the rest of this document. Proceed to enjoy
  the book!

WHAT IS THIS
============

  Jargon-fpw is a set of Perl/FreePWING scripts which converts "The Jargon
  File" into a JIS X 4081 formatted e-book.

IMPORTANT CHANGES FROM THE PREVIOUS VERSION
===========================================

  * Jargon-fpw 2.0 (or later) no longer support the plain-text version of
    The Jargon File. It now requires "jargon.xml" as input, which should
    be included in the Jargon master tarball.

  * Jargon-fpw 2.0 (or later) supports embedding graphics into the book.
    This feature cannot be turned off at least for now, because the
    original Jargon files are always distributed with the graphics. You
    will need some external programs to generate BMP files from JPEG and
    PNG graphics.

SOFTWARE REQUIREMENT
====================

  To run the jargon-fpw scripts, you will need to install the following
  software:

  * The Jargon File
    http://catb.org/~esr/jargon/
    Obtain the master tarball distributed as jargsrc.tar.gz, not the HTML
    tarball.

  * FreePWING
    http://www.sra.co.jp/people/m-kasahr/freepwing/

  * Perl XML::LibXML module
    http://www.cpan.org/modules/by-module/XML/

  * JPEG to BMP converter (djpeg by default)
  * PNG to BMP converter (png2bmp by default)
  * BMP quantitization program (ypadie by default)

HOW TO MAKE
===========

  1. Extract files from the jargon-fpw source tarball
     (jargon-fpwX.X-src.tar.gz) to some directory (you should have already
     done).

  2. Create a subdirectory named "jargsrc" under the directory you have
     used in the previous step. Cd to "jargsrc" and extract files from the
     Jargon master tarball (jargsrc.tar.gz).

  3. Run Makefile using fpwmake or GNU make.

  There are some makefile variables that can be customized according to
  your preferences. See the CUSTOMIZABLE VARIABLES section in Makefile for
  more information.

THANKS
======

  Special Thanks to Mr. Motoyuki Kasahara, the author of FreePWING, who
  had the kindness to write the first version of Makefile.

HISTORY
=======

2004-08-25 (jargon-fpw 2.0)

  * Rewritten from scratch, using jargon.xml as input.

-- EOF --
