Copyright 06/15/98 Sun Microsystems, Inc., All Rights Reserved.
@(#)README 1.2 on 98/06/15 10:37:44
Author: Lawrence Crowl

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
See the file COPYING.

Commands:

   cd to this directory

   make SRC=source_dir TGT=target_dir TMP=temp_file_dir verify

      The files backslash.dif and dotline.dif should be empty.  If they
      are not, something is wrong with the conversion scripts, the
      troff source, or the reference (.ref) files.

   make SRC=source_dir TGT=target_dir TMP=temp_file_dir html

      No verification is done, but the HTML files are updated.

   The default target is verify.

Directories:

   SRC defaults to ../c++roff
   TGT defaults to ../c++html
   TMP defaults to ../c++temp

Files:

   README -- this file
   COPYING -- the GNU General Public License

   Makefile -- rules for converting troff files to html files

   protoindex.html -- the top-level table of contents, copied to index.html
   $(TGT)/contents.html -- the detailed table of contents

   contents.sh -- conversion script for contents
   textbody.sh -- conversion script for main text body

   anchor.sed -- convert headers to crossreference sed script (below)
   charfont.sed -- convert character escapes and fonts
   contents.sed -- format for the detailed table of contents
   paragraph.sed -- number (numbered) paragraphs
   section[1-6].sed -- number sections
   textbody.sed -- convert the nroff tags (lines beginning with dot)

   dotline.ref -- lines starting with dot expected in the html files
   $(TMP)/dotline.fnd -- lines starting with dot found in the html files
   $(TMP)/dotline.dif -- difference in lines starting with dot

   backslash.ref -- backshash characters expected in the html files
   $(TMP)/backslash.fnd -- backshash characters found in the html files
   $(TMP)/backslash.dif -- difference in backshash characters

   dollar.ref -- dollar characters expected in the html files
   $(TMP)/dollar.fnd -- dollar characters found in the html files
   $(TMP)/dollar.dif -- difference in dollar characters

   $(SRC)/* -- troff sources
   $(TGT)/*.html -- derived html files

   $(TMP)/*.cnts -- the contents for a single chapter
   $(TMP)/*.newh -- the newest headings for a chapter
   $(TMP)/*.oldh -- the oldest _identical_ headings for a chapter
   $(TMP)/*.xref -- crossreference conversion scripts, per chapter
   $(TMP)/*.xref.a[ab] -- split crossreference conversion scripts

Development:

   If you do find bugs when applying these scripts to the C++
   standard's troff sources, please send me context diffs ("diff -c")
   for your fixes.  Likewise, if you make formatting improvements,
   please send me the diffs.  My email address is
   Lawrence.Crowl@Eng.Sun.Com.

   If you are modifying these scripts for use with other documents,
   you are on your own.  I cannot support you.