-*-text-*- $Id: INSTALL,v 2.12 1994/10/25 11:34:25 kris Exp kris $

	   ================================================
	   INSTALLING THE XY-pic DIAGRAM TYPESETTING MACROS
	   ================================================

This file assumes that you have downloaded the `ready to use' package
of XY-pic; all paths are relative to the directory where this file is
which should be named `xy-2.12'.  I'll also assume that you are using
a 300 dots per inch (write-black) laser printer (like the HP laserjet
or Apple laserwriter) and only hint where things may be different if
you have a different output device.

Contents:

  -1- Copyleft
  -2- Updating from version 2.6 (and earlier)
  -3- Overview of files and where they should be installed
  -4- Information for specific systems
  -5- Bugs & comments

----------------------------------------------------------------------
  -1- COPYLEFT
----------------------------------------------------------------------

Note that the entire XY-pic package is distributed with copyleft:

  Copyright (c) 1991-1994	 Kristoffer H. Rose  <kris@diku.dk>

  The XY-pic package 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.

  The XY-pic package 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 package; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

(Some option files are copyright by other people but the conditions
remain the same for any file distributed as part of XY-pic).

What this means is that if you install XY-pic then you should (1) make
sure that the file COPYING is accessible to the users, and (2) be
prepared to provide XY-pic (including sources) to any of your users
that request it (you may charge a fee for this if you are so
inclined).

----------------------------------------------------------------------
  -2- UPDATING FROM VERSION 2.6 (AND EARLIER)
----------------------------------------------------------------------

IMPORTANT: If you have installed version 2.7-2.11 then you should skip
this section. If you have not and use version 2.6 THEN READ IT !

XY-pic version 2.7 was almost a complete rewrite of XY-pic; later
versions are updates to this version.  If you are using version 2.6
(or some earlier version) then note the following:

* All the fonts have been redone AND renamed (except two that have not
  changed).  Thus installing version 2.12 will not break any DVI files
  you already have that were typeset using the old fonts.

* The distribution contains new versions of the files `xypic.tex' and
  `xypic.sty' that load XY-pic 2.12 in a special compatibility mode.
  Thus retypesetting your documents will create DVI files using the
  new fonts.  If you wish to keep the old `xypic.tex' and `xypic.sty'
  then you should rename them before installation; we suggest naming
  them `xypic-2.tex' and `xypic-2.sty' and REMEMBER to change the line
  `\input xypic' in `xypic-2.sty' to `\input xypic-2' !

* There are a few points where the backwards compatibility is not
  perfect -- these are noted in the documentation.

----------------------------------------------------------------------
  -3- OVERVIEW OF FILES AND WHERE THEY SHOULD BE INSTALLED
----------------------------------------------------------------------

IMPORTANT: If you have users currently using version 2.6 then make
sure you read the preceeding section before this!

SPACE REQUIREMENTS: The installed XY-pic (excluding manuals) takes up
some 350k of space; the majority (300k) is used for the actual macros.

Before you can use XY-pic you must get and install the following
files, either by retrieving the so-called `ready' distribution or by
generating them from the sources as described in the README file of
the source distribution (in the latter case the generated font bitmap
files get slightly different names).

You need to install the following groups of files; PLEASE also check
the next section for any system specific considerations!

AVAILABILITY: These three files contain general information and should
be installed in a publicly readable place (if necessary you may give
them an `xy' prefix):

  TRAILER	summary of features and availability
  INSTALL	how to install (this file)
  COPYING	GNU General Public License

MACROS: This group contains TeX/LaTeX macro files (with extension
`.tex' and `.sty') that must be installed in a place which TeX/LaTeX
will search (e.g., with un*x TeX, a directory users include in the
TEXINPUTS environment variable):

  texinputs/xy.tex		XY-pic bootstrap and kernel macros
  texinputs/xy.sty		LaTeX interface
  texinputs/xyidioms.tex	format-dependent idioms

  texinputs/xyall.tex		Load all extensions and features
  texinputs/xydummy.tex		Dummy template for new options :-)

  texinputs/xygraph.tex		Graph Combinator feature
  texinputs/xymatrix.tex	Matrix Diagrams feature
  texinputs/xyarrow.tex		Arrows and Paths feature
  texinputs/xy2cell.tex		Categorical 2-cell feature by Ross Moore
  texinputs/xypoly.tex		Regular Polygon feature by Ross Moore

  texinputs/xyv2.tex		Version 2 Compatibility feature
  texinputs/xypic.tex		Version 2 Compatibility loading interface
  texinputs/xypic.sty		Version 2 Compatibility LaTeX interface

  texinputs/xyframe.tex		Frames and Brackets extension
  texinputs/xycmtip.tex		Computer Modern tip extension
  texinputs/xycurve.tex		Curves and Splines extension by Ross Moore
  texinputs/xyline.tex		Line style extension by Ross Moore
  texinputs/xyrotate.tex	Rotate and Scale extension by Ross Moore
  texinputs/xycolor.tex		Colour extension by Ross Moore

  texinputs/xyps.tex		PostScript backend by Ross Moore
  texinputs/xyps-c.tex		  ...with auxiliary files...
  texinputs/xyps-l.tex
  texinputs/xyps-r.tex
  texinputs/xyps-col.tex	  ...and driver specific files.
  texinputs/xyps-dto.tex
  texinputs/xyps-dvi.tex
  texinputs/xyps-one.tex
  texinputs/xyps-oz.tex
  texinputs/xyps-pub.tex
  texinputs/xyps-txt.tex
  texinputs/xyps-wdo.tex

  texinputs/xytex.ini		To generate `plain TeX + XY-pic' format
  texinputs/xylatex.ini		To generate `LaTeX2e + XY-pic' format

TeX FONT METRIC: these files should be installed in a directory that
TeX will search for fonts (e.g., with un*x TeX, a directory users
include in the TEXFONTS environment variable):

  texfonts/xydash10.tfm		kernel TeX font metric files
  texfonts/xyatip10.tfm	
  texfonts/xybsql10.tfm
  texfonts/xybtip10.tfm
  texfonts/xycirc10.tfm

  texfonts/xycmat10.tfm		cmtip extension TeX font metric files
  texfonts/xycmbt10.tfm

METAFONT SOURCES: The preferred method of installing the XY-pic fonts
is to install the following METAFONT sources in some directory where
the METAFONT program will search for them (e.g., with un*x TeX, a
directory included in the system default MFINPUTS environment
variable).  These files should be installed:

  mfinputs/xydash10.mf		kernel METAFONT font sources
  mfinputs/xyd.mf
  mfinputs/xyatip10.mf
  mfinputs/xybsql10.mf
  mfinputs/xybtip10.mf
  mfinputs/xyd2.mf
  mfinputs/xycirc10.mf

  mfinputs/xycmat10.mf		cmtip extension METAFONT font sources
  mfinputs/xycmbt10.mf

NOTE: The METAFONT source files are only useful on installations where
the printer driver and previewer can utilise them to generate the
required bitmap fonts `on-line'.  If this is possible on your
installation then please use it: it saves substantial amounts of space
and means that you will automatically use fonts optimised for each
printer (provided evrything is correctly set up, of course).

BITMAP FONTS: These are for installations that can't use the METAFONT
sources directly but have a 300 dpi laserprinter driver that accepts
PK bitmap font files.  They should be installed where DVI previewers
and printer drivers will see them (e.g., with un*x, the `xdvi' program
should see them through the XDVIFONTS environment variable):

  pkfonts/cx300/xydash10.300pk	kernel font bitmaps for CanonCX-based
  pkfonts/cx300/xyatip10.300pk	  laser printers at \magstep0 (300dpi)
  pkfonts/cx300/xybtip10.300pk
  pkfonts/cx300/xybsql10.300pk
  pkfonts/cx300/xycirc10.300pk

  pkfonts/cx300/xycmat10.300pk	cmtip extension bitmaps for the same
  pkfonts/cx300/xycmbt10.300pk

  pkfonts/cx329/xydash10.329pk	kernel font bitmaps for CanonCX-based
  pkfonts/cx329/xyatip10.329pk	  laser printers at \magstephalf (329dpi)
  pkfonts/cx329/xybtip10.329pk
  pkfonts/cx329/xybsql10.329pk
  pkfonts/cx329/xycirc10.329pk

  pkfonts/cx329/xycmat10.329pk	cmtip extension bitmaps for the same
  pkfonts/cx329/xycmbt10.329pk

  pkfonts/cx360/xydash10.360pk	kernel font bitmaps for CanonCX-based
  pkfonts/cx360/xyatip10.360pk	  laser printers at \magstep1 (360dpi)
  pkfonts/cx360/xybtip10.360pk
  pkfonts/cx360/xybsql10.360pk
  pkfonts/cx360/xycirc10.360pk

  pkfonts/cx360/xycmat10.360pk	cmtip extension bitmaps for the same
  pkfonts/cx360/xycmbt10.360pk

PS HEADER FILE: If you plan to use the PostScript backend option then
you should consider copying the following file to a place where your
PostScript DVI driver will look for it:

  ps/xy212dict.ps		default PS backend header file

DOCUMENTATION: Finally, the typeset User's Guide is distributed as a
DVI file which you should be able to print (or preview) once you have
installed the fonts (as source or bitmaps as applicable for your
system):

  doc/xyguide.dvi	User's Guide, typeset using the kernel XY-pic fonts

The reference manual for the kernel and the distributed options is
included in the same format:

  doc/xyrefer.dvi	Reference Manual, using XY-pic fonts

Notice that these are portable and thus do not exploit any of the
non-portable extensions: in order to get documents with all features
enabled you should get the PostScript version as described in
`TRAILER' or generate them from the sources.

That is all.

----------------------------------------------------------------------
  -4- INFORMATION FOR SPECIFIC SYSTEMS
----------------------------------------------------------------------

UN*X: The above procedure can be done automatically by the command
`make install' if you get the source distribution as described in
TRAILER and change the configuration section of the provided Makefile
to reflect your local file system conventions.

MAC WITH Textures:  See the special file `INSTALL.Textures'.

MAC WITH OzTeX:  See the special file `INSTALL.OzTeX'.

----------------------------------------------------------------------
  -5- BUGS & COMMENTS
----------------------------------------------------------------------

I will appreciate reports on any problems you may encounter and
opinions you have on how the usefulness of XY-pic can be improved.
Please report using either

  Electronic mail (Internet): kris@diku.dk	[preferred]

  Paper mail:	Kristoffer H. Rose
		DIKU, University of Copenhagen
		Universitetsparken 1
		DK--2100 K{\o}benhavn {\O}
		DENMARK

  Fax:		+45 35321401 att. L.Wiese/K.Rose

You can always get the latest news of my whereabouts by opening my WWW
hyperlink quoted below.

----------------------------------------------------------------------

This is the end of INSTALL.  I hope you'll enjoy XY-pic!

----------------------------------------------------------------------

	      Kristoffer H{\o}gsbro ROSE  <kris@diku.dk>

     DIKU, Universitetsparken 1, 2100 K{\o}benhavn {\O}, DANMARK
     Phones: +45 35321400 direct: +45 35321420 fax: +45 35321401

	World Wide Web  <URL: http://www.diku.dk/users/kris/>

----------------------------------------------------------------------
