-*-text-*- $Id: README,v 2.12 1994/10/25 11:34:25 kris Exp $ ========================================================= READ ME FIRST: Xy-pic diagram typesetting package SOURCES ========================================================= Welcome to the source distribution of the Xy-pic macros for typesetting diagrams! Below you will find the following sections: -1- License information -2- Making the package and manual from sources -3- Bugs & comments -4- Distribution log Please see the file `TRAILER' for a summary of features and how you can obtain Xy-pic if all you got is this file, and the file `INSTALL' if you have retrieved the `ready-to-use' package. ---------------------------------------------------------------------- -1- LICENSE INFORMATION ---------------------------------------------------------------------- The Xy-pic package is licensed under `GNU CopyLeft': Xy-pic: Typesetting graphs and diagrams with TeX. Copyright (c) 1991-1994 Kristoffer H. Rose The Xy-pic macro 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 macro 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 options may be copyright by other people but the conditions remain the same). The full text of the GNU General Public License is supplied with Xy-pic in the file `COPYING'. ---------------------------------------------------------------------- -2- MAKING THE PACKAGE AND MANUAL FROM SOURCES ---------------------------------------------------------------------- This section describes how to make the Xy-pic package from sources on a un*x system. Making Xy-pic requires use (and some knowledge) of several standard un*x utilities; furthermore the installation uses both TeX (with the LaTeX format) and METAFONT (with the plain base). If you do not have a un*x system then you are best adviced to get the `ready to run' package and install it as described in `INSTALL'. Generation and installation procedure: 1. First make sure that you have a separate directory `src' which contains all the files of the distribution (including this file). The file `MANIFEST' contains a list of the files. 2. Next you should edit the `Configuration section' of `Makefile' to fit the configuration of your system by following the directions given there. When you have configured everything then just do make which should generate all the files needed to use the package. 3. You can test the newly generated system by typesetting the User's Guide which you probably want for reference anyway: do make guide which should produce a file `xyguide.dvi' by running LaTeX several times and BibTeX once. 4. If possible it is a good idea to try to preview the User's Guide (in whatever way you do on your system) at this point. This is slightly difficult because it uses the Xy-pic fonts which you haven't installed yet, so the previewer should be instructed to look in the current directory before looking in the system font directories. The following show how to do this for the most common previewer (on un*x systems with X windows) and might work for you: env XDVIFONTS=.: xdvi xyguide.dvi 5. You should then install the package by ensuring that the install directories in `Makefile' are setup correctly and do make install This will replace exisiting `xypic.tex' and `xypic.sty' files with the new (compatibility mode) ones; the old ones will remain available with an `.orig' suffix. 6. You can typeset the entire manual with make manual to create both files `xyguide.dvi' and `xyrefer.dvi'; they can be installed in the TEXDOC directory with the command make install.manual 7. You can build format files by the commands make xytex.fmt make xylatex.fmt (the latter requires the new standard LaTeX release aka LaTeX2e). These assume that the files `plain.tex' and `latex.ltx' are available in the TeX search path; also you have to install the format files in the appropriate place yourself. That is all. ---------------------------------------------------------------------- -3- 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. K.Rose / L.Wiese You can always get the latest news of Xy-pic from computers connected to the Internet by opening the Xy-pic World Wide Web page: W3 URL: http://www.diku.dk/users/kris/Xy-pic.html ---------------------------------------------------------------------- -4- DISTRIBUTION LOG ---------------------------------------------------------------------- The following versions have been distributed publicly: $Log: README,v $ Revision 2.12 1994/10/25 11:34:25 kris Interim release just before v3 [works with AMS-LaTeX 1.2]... Revision 2.11 1994/07/05 10:37:32 kris Third 3beta release [bug fixes]. Experimental graph feature included (for ECCT-94 presentation). Revision 2.10 1994/06/15 12:59:44 kris Second 3beta release [bug fixes]. Revision 2.8 1994/04/11 09:31:09 kris Second (bug fix) 3alpha release [corrected]. Revision 2.7 1994/03/08 02:06:01 kris Release 3alpha. MAJOR REWRITE of distribution to prepare for Xy-pic 3 functionality. Curve extension code contributed by Ross Moore ; support funding from MURG, ARC, and equipment from DEC. Revision 2.6 1992/06/24 01:23:34 kris Added `hook' tips using new font xyqc10. Added new POSitions: * and !. Added triple lines \Ssolid, \Ddashed, \Ddotted, and companion \Ttip. Reorganised manual. Revision 2.5 1992/02/24 03:30:54 kris Fixed bugs in \Direction calculation logic... Added (FACTOR) to \rotate to allow arbitrary rotation. ` intermediate points now accept an optional /RADIUS argument. Added \Tip with wide tip. Revision 2.4 1992/01/22 02:15:10 kris Fixed bugs [with thanks]: \\ works with AMS-LaTeX: don't use \Let@ [Werner Struckmann/Darrel Hankerson] No spurious arrow heads with LaTeX: \pit now undefined [Werner Struckmann] \Solid works: sets \Density [Dave Bowen] Short diagonal lines work...major rewrite of \connectv@ [Eric Domenjoud] Revision 2.3 1992/01/10 21:38:27 kris Several bugs fixed [with thanks]: The \ddtoX and \uutoX arrows were interchanged [Nico Verwer]. Some diagonal lines were wrong [Eric Domenjoud]. AMS-LaTeX users had name clash problems [Werner Struckmann]. The installation instructions in the Makefile were buggy [Leen Torenvliet]. Revision 2.2 1992/01/09 04:05:40 kris Patched to fix problem with \text and support AMS-LaTeX. Revision 2.1 1992/01/02 14:54:07 kris Release version. Revision 1.40 1991/12/17 04:53:23 kris Version distributed as `final draft' on Usenet. ---------------------------------------------------------------------- This is the end of the source README. I hope you will enjoy Xy-pic! ---------------------------------------------------------------------- Kristoffer H{\o}gsbro ROSE DIKU, Universitetsparken 1, 2100 K{\o}benhavn {\O}, DANMARK Phones: +45 35321400 direct: +45 35321420 fax: +45 35321401 World Wide Web ----------------------------------------------------------------------