%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%	README file for SNNSv3.1 User Manual
% 
%	24.08.93	Guenter Mamier
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

This directory should contain the following files and directories
(marked with a '\'):

README			this file
LaTeX_styles/		LaTeX styles directory which you might need 
			at your site to run the manual through LaTeX

	main SNNS user manual files
UserManual.bib		user manual bibliography
UserManual.tex		user manual (main file, it includes all other
			files files which make up the documentation)
UserManual.ind          user manual index file

	file description chapters
file_examples.tex	SNNS network file examples
file_interface.tex	SNNS network file interface description
grammar.tex		SNNS network file grammar

	intruduction chapters
intro_SNNS.tex		introduction to SNNS
nn_terminology.tex	introduction to connectionism and terminology
intro_figs/		all Postscript figures of the intro chapters
licensing.tex  		SNNS license agreement (part of the manual)

	simulator kernel chapters
kernel_figs/		all Postscript figures of the kernel chapters
trans_funcs.tex		kernel activation functions, output f.s etc.
kernel_implem.tex	kernel implementation
kernel_func_ui.tex	kernel function interface
kernel_design.tex	kernel overview
kernel_struct.tex	kernel internal data structures

title.tex		title page of this report

	X-Window graphical user interface (xgui) chapters
xgui_3D.tex		xgui 3D display manual chapter
xgui_3D_figs/		all Postscript figures of the xgui 3D display
xgui_3D_implem.tex	xgui 3D implementation
nn_analyzing.tex 	analyze tools
xgui_bignet/		all Postscript figures of the xgui bignet tool
network_creation.tex	xgui bignet tool to help create big networks
xgui_editor.tex		xgui 2D display editor commands
xgui_figs/		all Postscript figures of the 2D user interface
xgui_implem.tex		xgui implementation (2D)
using_xgui.tex		xgui usage
nn_models.tex		explanation of the implemented models and functions
nn_models/		all Postscript figures of the nn_models chapter

	batch program chapters
batch_example.tex	example batch protocol file
batch_version.tex	batch version manual



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	How to print the user manual with LaTeX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Perform the following steps in this directory 'userman':

1) Create a device independent file `UserManual.dvi` from the LaTeX
sources with

	biglatex UserManual.tex

We need `biglatex` instead of `latex` here at our site because of
internal memory restrictions of 'latex'.

Create the bibliography with

	bibtex UserManual

Create the index with

	makeindex UserManual

Run `biglatex' again to include the bibliography and the index in the
document and to allow latex to get all references right.

The resulting file UserManual.dvi could be printed with a proper
printer driver but it lacks all figures which are included as
Postscript images. Since there are many figures in our documentation
we suggest you also do the following steps.

2) Translate the file `UserManual.dvi` into a Postscript file with all
images included with

	dvips UserManual.dvi

The program 'dvips' is a popular conversion program to create
Postscript from .dvi files. It creates the file `UserManual.ps'. 
The program 'dvips' cannot be obtained from us, don't ask!

3) The resulting file `UserManual.ps` should print on any PostScript
laser printer. We mostly use Apple LaserWriter printers at our site,
but it has also been tested on other laser printers.

	lpr UserManual.ps	<options to indicate Postscript file>

At our site printing over the network is done with a non-standard
printing routine, so we have to include an option '-raw' to tell the
printer that it is a Postscript file. This varies from site to site.

4) Some printers don't handle files larger than 1MB. Since the manual 
is about 7MB big, it is advisable to split it up before printing. This 
can be done f.e. with

	dvips UserManual.dvi -l 50 -o part1.ps
	dvips UserManual.dvi -p 51 -l 100 -o part2.ps
	dvips UserManual.dvi -p 101 -l 150 -o part3.ps
	dvips UserManual.dvi -p 151 -l 200 -o part4.ps
	dvips UserManual.dvi -p 201  -o part5.ps

5) We experienced printer problems with some of the pictures in the
manual. The critical pages are 120, 123, and 127. These problems can 
be avoided if the following files are replaced by dummies.

	art_figs/art1ee.ps
	art_figs/art2ee.ps
	art_figs/amapee.ps



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	How to print the user manual from the Postscript file
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

You can also obtain a Postscript file of the SNNSv3.1 user manual from
us. It can be fetched from the same ftp directory as the original
SNNSv3.1 software under the name

	SNNSv3.1.Manual.ps.Z

It is a compressed Postscript file (< 1.3 M) of the documentation with
all figures included. It is identical to the above file `UserManual.ps`
of step 3 and can be printed directly after uncompressing it.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	End of this README file
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%