# proof v1.2 readme file #

$Id: README,v 1.2 2002/09/30$

#################################################################
# proof v1.2 readme file #
#################################################################

DESCRIPTION
Proof is a shell based auxiliary program that's able to
process and view TeX, LaTeX, METAFONT and MetaPost sources
and thus can be used to quickly produce snapshots of TeX
related documents whenever necessary. Its main purpose
however is to act as a completion to an ordinary word pro-
cessing program which normally lacks appropriate facili-
ties to process TeX sources within a common TeX/LaTeX
environment. Here, Proof completely relieves the author of
doing shell related work and thus simplifies the process
of preparing PostScript/PDF documents particularly in
those cases where various different sources are involved.
Besides Proof offers a handy control mechanism that may be
accessed from within the editor being used, an interface
to common METAFONT font test algorithms and a simple back-
up facility ensuring that sourcefiles can easily be
restored when accidentally overwritten or deleted. For
further information on how to use this program see section
EXAMPLE please.

INSTALLATION
To install Proof to your system, simply type './install'.
This will install the files proof (shellscript), .proofrc
(config file) and proof.1.gz (manual page) and hence
should be done by the system admin unless you want to
change the default locations for the files referred to.
('install' will prompt you, if you want to do so.) When
successfully installed, you should take a look at your
Proof configuration file .proofrc, located in your home
directory, which you may wish to modify to suit it to your
own needs. Finally, to ensure that the program works fine
in this environment, you should try to process the sample
files example.tex, example.mf and example.mp which are
also part of the distribution. (Use the sample editing
script 'edit' if you like. To do so, simply type "edit
example.tex", "edit example.mf" etc. on the commandline.
You may enter the name of your favourite word processing
program into the script prior to that.) Please consult
Proof manual page for further information on how to use
this program.

REQUIREMENTS
Proof should work properly on UNIX conformable platforms
(i. e. Linux, BSD etc.) provided that there's an intact
TeX/LaTeX environment (http://www.ctan.org) and GNU bash
(Bourne Again Shell), version 2.03 or later
(http://www.gnu.org/software/bash/bash.html). The install
script provided with Proof will show some useful informa-
tion on this topic. See also this list of auxiliary pro-
grams Proof is known to work fine with: TeX (Web2C 7.3.1)
3.14159, e-TeX (Web2C 7.3.1) 3.14159-2.1, pdfTeX (Web2C
7.3.1) 3.14159-0.13d, pdfeTeX (Web2C 7.3.1)
3.14159-0.13d-2.1, Metafont (Web2C 7.3.1) 2.7182, MetaPost
(Web2C 7.3.1) 0.641, dvips v5.86, dvipdfm version 0.13.2c,
GNU ghostscript 7.05, gv 3.5.8, ghostview v1.5, xdvi(k)
version 22.05d-k, RCS version 5.7.

COPYRIGHT
Copyright (C) 2002 Klaus Bosau

This program can be redistributed and/or modified under
the terms of the GNU General Public License as published
by the Free Software Foundation. (The exact wording can be
found at http://www.gnu.org/copyleft/gpl.html.)

Happy TeX'ing!

Klaus Bosau <[email protected]>