Debian Codegraph @

texmf-dist/doc/generic/xypic/INSTALL

raw
1 -*-text-*- $Id: INSTALL,v 3.23 2011/03/31 06:04:02 krisrose Exp $
2
3
4 ================================================
5 INSTALLING THE Xy-pic DIAGRAM TYPESETTING MACROS
6 ================================================
7
8
9 This file explains how you install the runtime files in the
10 distribution of Xy-pic. See `README' for general information.
11
12 Contents:
13
14 -1- Copyleft
15 -2- Overview of files and where they should be installed
16 -3- Bugs & comments & where to get help
17
18
19 ---------------------------------------------------------------------------
20 -1- COPYLEFT
21 ---------------------------------------------------------------------------
22
23 Note that the entire Xy-pic package is distributed with copyleft:
24
25 Copyright (c) 1991-2011 Kristoffer H. Rose <[email protected]>
26 Copyright (c) 1994-2011 Ross Moore <[email protected]>
27
28 The Xy-pic package is free software; you can redistribute it and/or
29 modify it under the terms of the GNU General Public License as
30 published by the Free Software Foundation; either version 2 of the
31 License, or (at your option) any later version.
32
33 The Xy-pic package is distributed in the hope that it will be
34 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
35 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
36 General Public License for more details.
37
38 You should have received a copy of the GNU General Public License
39 along with this package; if not, see http://www.gnu.org/licenses/.
40
41 What this means is that if you install Xy-pic then you should (1) make
42 sure that the file `COPYING' is accessible to the users, and (2) be
43 prepared to provide Xy-pic (including sources including of your
44 modifications) to any of your users that request it (you may charge a
45 fee for this if you are so inclined).
46
47 Note: Some option files may be copyrighted by other people and use a
48 different (more relaxed) license but the conditions remain the same
49 for the entirety of Xy-pic.
50
51
52 ---------------------------------------------------------------------------
53 -2- OVERVIEW OF FILES AND WHERE THEY SHOULD BE INSTALLED
54 ---------------------------------------------------------------------------
55
56 In this section we explain in 10 steps where the different groups of
57 Xy-pic files in the `run' and `doc' distribution should be installed.
58 For each file category we indicate the location recommended by TDS,
59 the TeX Directory Standard (as formed by a TUG working group of that
60 name).
61
62
63 IMPORTANT
64 ---------
65 If you have an older system (more than 10 years) then these
66 instructions may not be suitable. Go to the source directory
67 http://xy-pic.cvs.sourceforge.net/viewvc/xy-pic/src/Historic/
68 where we keep some older instructions, or ask on the mailing list.
69
70
71 Step 1. Availability & License
72 ------------------------------
73 These eight files contain general information and should be installed
74 in a publicly readable place:
75
76 README generic information on Xy-pic
77 CATALOG version information and summary
78 TRAILER announcement and availability
79 INSTALL how to install (this file)
80 MANIFEST list of all files
81 VERSIONS the RCS version ids of all source files
82 COPYING GNU General Public License
83 FONTCOPYING Special license for fonts
84 Xy-pic.html HTML source of Xy-pic home page
85 Xy-logo.png Xy-pic logo (gotta have one of those)
86
87 TDS directory: texmf/doc/generic/xypic
88
89
90 Step 2. Macros
91 --------------
92 Files `texinputs/*' are TeX and LaTeX macro files that must be
93 installed in a place which TeX and LaTeX will search (e.g., with un*x
94 TeX, a directory users include in the TEXINPUTS environment variable).
95
96 TDS directory: texmf/tex/generic/xypic
97
98
99 Step 3. TeX Font Metric
100 -----------------------
101 Files `texfonts/*.tfm' should be installed in a directory that TeX
102 will search for fonts (e.g., with un*x TeX, a directory users include
103 in the TEXFONTS environment variable).
104
105 TDS directory: texmf/fonts/tfm/public/xypic
106
107
108 Step 4. METAFONT Sources
109 ------------------------
110 Files `mfinputs/*.mf' should be installed in some directory where the
111 METAFONT program will search for them (e.g., with un*x TeX, a
112 directory included in the MFINPUTS environment variable).
113
114 NOTE: The METAFONT source files are only useful on installations where
115 the printer driver and previewer can utilise them to generate the
116 required bitmap fonts `on-line'. If this is possible on your
117 installation then please use it: it saves substantial amounts of space
118 and means that you will automatically use fonts optimised for each
119 printer (provided evrything is correctly set up, of course).
120
121 TDS directory: texmf/fonts/source/public/xypic
122
123
124 Step 5. PostScript Type1 Fonts
125 ------------------------------
126 Files `type1/*.pfb' contain versions of the Xy-pic fonts in special
127 PostScript form that may be useful on some installations. They should
128 be installed where the applications using them look for such fonts (if
129 used with DVIPS then the `ps/xypic.map' file from the next group
130 should also be installed).
131
132 NOTE: Some installations, notably teTeX 0.4, will PREFER using these
133 fonts over the METAFONT-generated equivalents (IMHO this is a bug in
134 the MakeTeXPK script). On those systems we recommend that you ALSO
135 install the PK fonts to circumvent the problem.
136
137 IMPORTANT: Make sure that you do not have any old Xy-pic PostScript
138 `xy*.pfa' fonts floating around in your system - search for and remove
139 all files named `xy*.pfa' when you have installed the new fonts. One
140 common way old (and wrong) fonts is manifest is when some arrowheads
141 appear skewed or too thin.
142
143 TDS directory: texmf/fonts/type1/public/xypic
144
145
146 Step 6. PostScript Font Metric Files
147 ------------------------------------
148
149 Files `pfm/*.pfm' are special files for some font handling software.
150 Install them if you need them.
151
152 TDS directory (usually): texmf/fonts/pfm/public/xypic
153
154
155 Step 7. Adobe Font Metric Files
156 -------------------------------
157 Files `afm/*.afm' are special files for the Adobe Type Manager.
158 Install them if you need them.
159
160 TDS directory (usually): texmf/fonts/afm/public/xypic
161
162
163 Step 8. PostScript Header Files
164 -------------------------------
165 Files `ps/*' contain PostScript header files. If you plan to use
166 the PostScript extension option then you should copy these files to a
167 place where your PostScript DVI driver will find them.
168
169 TDS directory (usually): texmf/dvips/xypic
170
171
172 Step 9. PostScript Font Map Files
173 ---------------------------------
174 Files `map/*' contain PostScript and PDF font mappings that link each
175 font to the used encoding.
176
177 TDS directory (usually): texmf/fonts/map/dvips/xypic
178
179
180 Step 10. PDF Font Encoding Files
181 -------------------------------
182 Files `enc/*' contain PDF encoding files (that name each character in
183 the special Xy-pic fonts). If you plan to use the PDF backend then
184 you should copy these files to a place where PDFTeX will find them.
185
186 TDS directory: texmf/fonts/enc/dvips/xypic
187
188
189 Step 11. Documentation
190 ----------------------
191 The documentation is provided in Adobe PDF files.
192
193 doc/xyguide.pdf User's Guide for everyone.
194 doc/xyrefer.pdf Reference Manual for experienced users
195
196 The source code documentation is also included.
197
198 doc/xysource.pdf TeXnical documentation for TeXperts
199 doc/xypdf.pdf TeXnical details about PDF generation
200 doc/xy*src.tar.gz the actual source files
201
202 TDS directory: texmf/doc/generic/xypic
203
204
205 That's all.
206
207
208 ---------------------------------------------------------------------------
209 -3- BUGS & COMMENTS & WHERE TO GET HELP
210 ---------------------------------------------------------------------------
211
212 We will appreciate reports on any problems you may encounter and
213 opinions you have on how the usefulness of Xy-pic can be improved.
214 Please report using either
215
216 Electronic mail (Internet): [email protected] [preferred]
217
218 Paper mail: Kristoffer H. Rose
219 IBM T.J.Watson Research Center
220 P.O.Box 704
221 Yorktown Heights, NY 10598
222 USA
223
224 W3 <URL: http://sourceforge.net/projects/xy-pic/>
225
226 ---------------------------------------------------------------------------
227
228 This is the end of INSTALL. We hope you'll enjoy Xy-pic!
229
230 -- Ross Moore and Kristoffer Rose
231
232 ---------------------------------------------------------------------------
233