Description: overview of abnff, its installation and use
abnff READ_ME.txt	version 0.19	2005/05/20 02:30:49

Introduction:
Abnff is a preprocessor used to format ABNF in RFCs and Internet Drafts.

This software is OSI Certified Open Source Software.
OSI Certified is a certification mark of the Open Source Initiative.

The software is distributed under the zlib/libpng license; see the file
LICENSE included with the distribution.

Prerequisites:
To rebuild after modifying the grammar or lexical analyzer files, you will
need GNU bison 1.33 or later and flex 2.5.31 (beta) or later.  To rebuild
after modifying the core rule names, you will need gperf 3.0 or later.
To build from the source without modifying the grammar or lexical analyzer
or core rule names, these are not required, as the corresponding C source
files are provided.  You will of course need a C compiler and something
resembling a POSIX-compliant operating system.

Configuration:
Edit the lines near the top of the makefile to configure for local conditions.
See the comments in the makefile for details.  When you have finished editing
the makefile, run make.  You should end up with an executable named abnff.

If no files are specified on the command line, standard input is read.
If multiple files are specified, the results will be concatenated on stdout,

Output:
Output is intended to be processed with rfc macros for formatting an RFC or
Internet Draft document.

Detailed documentation is available in the files abnff.1 and abnff.pdf.

Bug reports: If you think that you have found a bug, please supply a test
case (a minimal set of input that demonstrates the bug), a description
of what you expected and why what you got didn't meet your expectations,
and optionally (if you think you know how to fix the problem) a patch to
the relevant source file(s).  Send bug reports to blilly@erols.com. Please
include "abnff" in the Subject header field.

Feedback other than bug reports is also welcome. Use the same email address
as above.  Including "abnff" in the Subject header field would be appreciated.