SCCS-info %W% %E% 
$Id: README,v 1.6 1994/06/03 20:39:03 sander Exp $


This directory contains the documentation of the VCG tool.


FILES IN THIS DIRECTORY
-----------------------
        README        - this file
	README.KEYS   - description of the keyboard commands the tool
		        understands. 
	README.SYS    - installation protocoll for different Unix
			types. 
        grammar.txt   - textual representation of the grammar of VCG,
			(generated by some of my tools, the result may
			 be ugly).

	Makefile      - Makefile to make the documentation
	visual.tex    - Main file of the full documentation
	vis_short.tex - Main file of the short documentation
	intro.tex     - Different parts of the documentation
	part0.tex
	part1.tex
	part2.tex
	part3.tex
	part4.tex
	part5.tex
	concl.tex
	bibl.tex     

	exa1.vcg      - Example 1 of the documentation in GDL (VCG format)
	exa1.1bit.uue - Screendump of Example 1 in Sun 1 Bit format uue
	exa1.pbm.uue  - dito                    in PBM P4 format uue
	exa1.ps       - dito                    in PostScript format
	exa2.vcg      - Example 2 of the documentation in GDL (VCG format)
	exa2.1bit.uue - Screendump of Example 2 in Sun 1 Bit format uue
	exa2.pbm.uue  - dito                    in PBM P4 format uue
	exa2.ps       - dito                    in PostScript format

	foldpath.fig  - Picture 1 in Fig format
	foldtree.fig  - Picture 2 ...
	hideedge.fig  - Picture 3 ...
	window.fig    - Picture 4 ...

	transfig1.tex   - transfig include file for full  documentation 
	transshort.tex  - transfig include file for short documentation

	preconf	      - a directory containing the pregenerated 
			documentation, and some pregenerated files
			to make the documentation
	
	preconf/visual.dvi     is the long documentation in dvi-format.
	preconf/visual.ps      dito in ps-format
	preconf/vis_short.dvi  is the long documentation in dvi-format.
	preconf/vis_short.ps   dito in ps-format


	preconf/foldpath.ps   - Picture 1 in PostScript format
	preconf/foldpath1.tex - dito      as epsf inclusion
	preconf/foldpath2.tex - dito      in PicTeX format

	preconf/foldtree.ps   - Picture 2
	preconf/foldtree1.tex
	preconf/foldtree2.tex

	preconf/hideedge.ps   - Picture 3
	preconf/hideedge1.tex
	preconf/hideedge2.tex

	preconf/window.ps     - Picture 4
	preconf/window1.tex
	preconf/window2.tex



INSTALLATION HINTS
------------------
	1) If you call the Makefile of this directory directly,
	you should first read it carefully and adapt the CHANGE AREA
	of the Makefile.
	If you call the Makefile from the top-level Makefile, this
	is not neceassary.

	2) Since there are screendumps included into the document, we 
	have used the PostScript format for the pictures, also for the 
	fig-pictures.  You need the macros package epsf.tex for the 
	PostScript dumps.
	To produce the document, simply type `make'.  This creates the 
	file visual.dvi.  To convert this into PostScript, please use an 
	appropriate driver, e.g. dvips, dvi2ps, dvialw etc. 

	3) If PostScript is not available:
	The easeast way is to produce a short documentation. 
	Type `make short'.
	This creates the file vis_short.dvi. However, in this case, a 
	big-latex and PicTeX is needed (prepictex.tex, pixtex.tex and 
	postpictex.tex). The pictures are ugly and some sections are 
	missing in the short documentation.

	4) Targets of the Makefile:

	   make               - creates visual.dvi
	   make long          - dito

	   make short         - creates vis_short.dvi, the documentation
				which does not need PostScript.

	   make binfiles      - creates the binary versions of the
				pictures from the uue versions of the
				pictures. E.g. exa1.1bit.uue is converted
				into exa1.1bit.

	   make clean         - removes all temporary files except the
				generated dvi- or ps-files.

	   make targetclean   - removes all temporary files and the
				generated dvi- and ps-files

	   make distclean     - removes everything that is not in the
				original distribution

	   make depend        - creates the dependencies of the sources

	   make dist          - creates a distribution



IF YOU STILL WANT TO HAVE A FULL DOCUMENTATION 
----------------------------------------------
	... but you don't have PostScript ...
	The fig-files can also be converted into any other format, 
	if you use transfig or fig2dev, thus they are included here. 
	Then, the files foldtree1.tex, foldtree.ps, foldpath1.tex, 
	foldpath.ps, hideedge1.tex, hideedge.ps, window1.tex, window.ps 
	and transfig1.tex are replaced. However this needs a little bit
	insight into the mechanism of LaTeX and transfig. Please ask your
	TeX wizard.

	If you do `make binfiles', you get the files exa1.1bit, exa2.1bit,
	exa1.pbm and exa2.pbm.
	The files exa1.1bit and exa2.1bit are the screen dumps in 
	SunView 1bit format. They are converted to Postscript via 
	fbcat -P | pbm2ps to exa1.ps and exa2.ps. Note that I also 
	have magnified the Postscript versions of the dumps.

	The files exa1.pbm and exa2.pbm are PBM P4 dumps as the VCG tool 
	can produce them.

	Sunview 1bit files can also be printed separately, if you have an
	appropriate driver.  
	A HP printer driver for PBM files is in the directory demo: pbm2hp. 


