summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/texdraw/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/texdraw/README')
-rw-r--r--Master/texmf-dist/doc/support/texdraw/README170
1 files changed, 170 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/texdraw/README b/Master/texmf-dist/doc/support/texdraw/README
new file mode 100644
index 00000000000..91cced49d63
--- /dev/null
+++ b/Master/texmf-dist/doc/support/texdraw/README
@@ -0,0 +1,170 @@
+This file describes the contents of the distribution for TeXdraw
+
+$Id: README,v 2.0 1995/12/18 texdraw-V2R0 $
+
+The TeXdraw package consists of a set of macro definitions for the TeX
+typesetting program. These macros allow the user to produce PostScript
+drawings from within TeX and LaTeX.
+
+The main benefits of TeXdraw accrue from the ability to produce drawings
+from <within> TeX, using TeX fonts for labelling the drawing.
+
+Basic drawing features include:
+(1) moves, lines and arrow vectors
+ - selectable gray level, line width pattern, arrowhead size and type
+(2) circles, ellipses, arcs, and Bezier curves
+(3) general fill command to fill a region defined by lines and Bezier
+ curves (selectable gray level)
+(4) TeX text, including mathematics, can be positioned and superimposed
+ on the drawing
+
+TeXdraw has been designed to be extensible. Drawing "segments" are
+relocatable, self-contained units. Using a combination of the begingroup/
+endgroup mechanism in TeX and the gsave/grestore mechanism in PostScript,
+drawing segments allow for local changes to the scaling and line
+parameters. Using TeX's macro definition capability, new drawing commands
+can be constructed from drawing segments.
+
+The extensibility features include,
+(1) relocatable drawing segments to keep changes local
+(2) local segment scaling
+(3) saving and restoring positions using symbolic positions
+
+The compressed file texdraw-V2R0.tar.Z is available for anonymous ftp on
+ftp.TSP.EE.McGill.CA in directory /pub/tsp/texdraw.
+
+=====
+Peter Kabal kabal@TSP.EE.McGill.CA
+Department of Electrical Engineering
+McGill University
+Montreal, Quebec
+
+
+=====
+The distribution consists of the TeXdraw macros themselves, files with
+auxiliary macros, and the TeXdraw manual (texinfo format, also as a
+PostScript file).
+
+Distribution Contents:
+----------------------
+
+Miscellaneous:
+ README - this file
+ ChangeLog - log of changes to TeXdraw
+
+TeXdraw macros (main directory):
+ texdraw.tex - TeXdraw macros for TeX
+ texdraw.sty - LaTeX2e interface to TeXdraw
+ txdtools.tex - TeXdraw toolbox for extending TeXdraw
+ txdps.tex - TeXdraw macros for accessing PostScript macros
+ blockdiagram.tex - Block diagram macros for TeXdraw
+ txdexamp.tex - plain TeX code for the examples in the manual
+ txdexamp.latex - LaTeX2e code for the examples in the manual
+
+compacted TeXdraw macros (directory compact/):
+ texdraw.tex
+ txdtools.tex
+ txdps.tex
+
+TeXdraw documentation (directory manual/):
+ texdraw.ps - PostScript version of the manual
+ texdraw.texi - Texinfo source file for the TeXdraw manual
+ texdraw.aux - cross-references (generated by an earlier run, used
+ as input when TeX'ing the manual)
+ texdraw.cps - concept index (generated by an earlier run, used as
+ input when TeX'ing the manual)
+ texdraw.fns - sorted functon index (generated by an earlier run,
+ used as input when TeX'ing the manual).
+
+GNU Texinfo utilities (directory manual/):
+ texindex.c - Source for the texindex program
+ getopt.h - Include file for texindex.c
+ texinfo.tex - Texinfo macros used to make manuals and on-line
+ documentation
+ texi2dvi - Script to run TeX and texindex
+
+===============================================
+The following notes on setup are for Unix systems.
+
+Initial Tests:
+
+(1) Print the PostScript version of the manual ("texdraw.ps") to see the
+ capabilities of TeXdraw.
+(2) Try TeX'ing the examples file. Assuming plain TeX is invoked with the
+ command "tex" and LaTeX2e is invoked with the command "latex"
+ % tex txdexamp
+ ... or ...
+ % latex texdexamp.latex
+(3) Printing the examples using the appropriate printer driver program (only
+ dvips can be used with the plain TeX version of the examples),
+ % dvips txdexamp
+
+=====
+Permanent Setup:
+
+Compact source files:
+In the subdirectory "compact", there are versions of the macro files
+with most comments and white space removed.
+
+(1) Private copy of TeXdraw.
+ Move the TeXdraw sources files ("texdraw.sty", texdraw.tex",
+ "txdtools.tex" and "txdps.tex") to an appropriate directory. If you are
+ keeping private versions of the files, consider using the directory
+ ~mylogin/tex . With many versions of TeX, including this directory in
+ the TeX input path variable (the environment variable TEXINPUTS) allows
+ you to refer to the files in TeX without specifying the full pathname.
+ With the C-cshell, a line in the ".login" file sets the environment
+ variable TEXINPUTS
+ % setenv TEXINPUTS ".:$HOME/tex:".
+ The last part of the path string should terminate with a colon to have
+ the default directory of TeX files available.
+(2) Public copy of TeXdraw.
+ Move the TeXdraw source files ("texdraw.sty", "texdraw.tex",
+ "txdtools.tex" and "txdps.tex") to a directory that TeX searches by
+ default. This might be a directory such as "/usr/local/lib/tex/inputs".
+ Newer versions of TeX allow subdirectory searching - in that case, use
+ the directory "/usr/local/lib/tex/inputs/TeXdraw".
+
+=====
+The following instructions pertain to installing the ability to use the
+Texinfo system for any texinfo type manual.
+(1) The GNU program "texindex" should built using
+ % cc texindex.c -o texindex
+ Move the program to an appropriate place such as "/usr/local/bin".
+(2) The GNU script "texi2dvi" runs TeX and texindex for a texinfo file.
+ Move this script to an appropriate place such as "/usr/local/bin".
+(3) The GNU "texinfo.tex" file should go into the public directories
+ searched by TeX, for instance "/usr/local/lib/tex/inputs", or
+ "/usr/local/lib/tex/inputs/texinfo".
+
+=====
+Creating a TeXdraw manual from the sources:
+(1) Make sure "texdraw.tex", "txdtools.tex" and "texinfo.tex" will be found
+ by TeX.
+(2) To create the manual, you have to TeX the manual twice - the second
+ time to access the sorted indices and the cross-references. The
+ program "texindex" sorts the indices. (The distribution includes pre-
+ sorted indices that can be used). The three steps can be replaced by
+ an invokation of the script "texi2dvi".
+ % tex texdraw.texinfo
+ % texindex texdraw
+ % tex texdraw.texinfo
+(3) If you have the printer driver program dvips, a PostScript version of the
+ manual is created as follows.
+ % dvips texdraw -o texdraw.ps
+
+=====
+On-line info manual:
+
+Consider building an info version of the manual. For this you need the
+GNU program "makeinfo" (available by anonymous ftp from prep.ai.mit.edu
+as part of texinfo-XXX.tar.gz). After running "makeinfo texdraw", the top
+level info directory file "dir" in /usr/local/emacs/info needs to be
+updated to include a menu entry for TeXdraw. This entry is of the form
+* TeXdraw: (texdraw).
+ TeXdraw is a collection of macros that allow drawings to be
+ created from within TeX.
+Also the files produced by makeinfo (texdraw, texdraw-1, texdraw-2, and
+texdraw-3) need to be moved there. The info file can be read from within
+the emacs editor, or with the info reader program "info" (also part of the
+texinfo distribution).