pasdoc README
-------------

Written by Marco Schmidt
Last modification August 4, 1999

Introduction
------------

Pasdoc is a command-line application to create documentation of Pascal units.
For detailed information, consult the manual, which is available as
PostScript, PDF or LaTeX source from the homepage.
For a list of available program parameters, run the pasdoc application with
'--help' (without quotes) as sole parameter.
Send feedback on pasdoc to Marco Schmidt <marcoschmidt@geocities.com>.
Visit the pasdoc homepage at
http://www.geocities.com/SiliconValley/Lakes/6686/pasdoc.html.

List of all files that cannot be generated automatically
--------------------------------------------------------

 Pascal source code
  appinfo.pas - some constant strings on pasdoc
  arrays.pas - basic operations on arrays
  compver.pas - some constant strings on the compiler used
  filestre.pas - file streams
  gendoc.pas - basic documentation generator
  html.pas - HTML documentation generator
  items.pas - objects for all items that can be found when parsing
  numbers.pas - basic number types
  objects.pas - modified version of the Objects unit
  parsing.pas - Pascal parser
  pasdoc.pas - application file
  platform.inc - defines some conditional directives
  scanning.pas - Pascal source scanner
  streams.pas - basic stream objects
  tex.pas - TeX documentation generator
  texts.pas - dynamic length text object
  time.pas - object to measure time intervals
  tokenizi.pas - Pascal tokenizer

 Batch files (Win32, DOS, etc.)
  bp.bat - run Borland Pascal 7.0 IDE
  c.bat - compile with FPC
  d.bat - compile with Delphi
  makezip.bat - create zip archives
  r.bat - run pasdoc on its own sources
  renwin32.bat - renames 8+3 file names to standard names

 Other files
  bp70real.dir - Borland Pascal 7.0 standard directives (real mode)
  HISTORY - chronological list of changes to pasdoc
  LICENSE - copyright information
  Makefile - to be used with the make application
  pasdoc.tex - the manual
  README - you're reading it
  TODO - things yet to be modified

Archives
--------

  The following archives are available for download on the homepage.
  X, Y and Z denote the current major version, minor version and patch level.

  To extract ZIP archives, type 'unzip archive-name.zip'.
  Add the -a parameter on Unix or Macintosh platforms to get right line
  endings.
  To exclude the batch files from being extracted on the Linux platform, type
  'unzip archive-name.zip -x "*.bat"' without single quotes; note the
  double quotes.
  To extract tar.gz archives, type 'tar xvzf archive-name.tar.gz'.

  pasdoc-X.Y.Z-bin-linuxx86.tar.gz - pasdoc (Linux x86 binary), README,
    LICENSE, all directive files (*.dir)
  pasdoc-X.Y.Z-bin-win32.zip - pasdoc.exe (Win32 binary), README, LICENSE, all
    directive files (*.dir)
  pasdoc-X.Y.Z-manual-pdf.gz - PDF version of manual
  pasdoc-X.Y.Z-manual-ps.gz - PostScript version of manual
  pasdoc-X.Y.Z-manual-src.tar.gz - pasdoc.tex and all other files necessary
    to create the manual using latex
  pasdoc-X.Y.Z-samples-html.zip - HTML documentation of pasdoc's output on
    itself
  pasdoc-X.Y.Z-src.zip - all files that cannot be generated automatically (see
    previous section of this README file), including pasdoc sources (Pascal),
    several batch files, text files and manual sources (LaTeX)
