.mdw-build.conf: Don't try `vpath' builds with this package.
[mdwfonts] / README
1
2 ===============
3
4 M D W F O N T S
5
6 ===============
7
8
9 --- Licence note ---
10
11 mdwfonts package release note
12 Copyright (c) 1996 Mark Wooding
13
14 These programs are free software; you can redistribute them and/or modify
15 them under the terms of the GNU General Public License as published by
16 the Free Software Foundation; either version 2 of the License, or
17 (at your option) any later version.
18
19 These programs are distributed in the hope that they will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU General Public License for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with these programs; if not, write to the Free Software
26 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27
28
29 --- What it's all about ---
30
31 This is a LaTeX package and some various font bits which allow configurable
32 fonts in documents, provide a `squashed' Courier font (inlcuding the bits
33 David Carlisle left out of pslatex) and some maths support for Palatino.
34
35
36 --- Licencing ---
37
38 The packages are made available under the GNU General Public Licence (not the
39 usual LaTeX agreement). A copy of this licence is supplied in the file
40 COPYING. You should read this document if you haven't read it already, even
41 if it's just for educational value. I'm not actually sure how good a thing
42 the GNU GPL actually is, so I'm sort of testing the water. The idea that
43 this is how all software should be distributed still fills me with a certain
44 amount of trepidation.
45
46
47 --- What's in the box ---
48
49 You should have received the following files in whatever sort of archive
50 thing this suite came in:
51
52 README -- You've got this file for sure, because it's this one
53 COPYING -- A textual version of the GNU General Public Licence
54 mdwfonts.dtx -- Documentation and code for `mdwfonts.sty', the `.fd'
55 files, and a whole lot of other stuff
56 mdwfonts.ins -- Installation script for the packages
57 gpl.tex -- LaTeX version of the GNU General Public Licence
58
59 If you're missing any of these files, complain at whoever gave the rest of
60 them to you, and get them quickly. You /should/ also have a large collection
61 of `.tfm' and `.vf' files:
62
63 pcrb7tn.tfm pcrbo7tn.tfm pcrr8rn.tfm pcrro8rn.tfm pzcmi8r.tfm
64 pcrb8a.tfm pcrbo8a.tfm pcrr8tn.tfm pcrro8tn.tfm zpplcmr.tfm
65 pcrb8rn.tfm pcrbo8rn.tfm pcrrc7tn.tfm pplr8r.tfm zpplcmrm.tfm
66 pcrb8tn.tfm pcrbo8tn.tfm pcrrc8tn.tfm pplri8r.tfm zpsycmrv.tfm
67 pcrbc7tn.tfm pcrr7tn.tfm pcrro7tn.tfm psyr.tfm zpzccmry.tfm
68 pcrbc8tn.tfm pcrr8a.tfm pcrro8a.tfm
69
70 pcrb7tn.vf pcrbo7tn.vf pcrr8tn.vf pcrro7tn.vf zpplcmrm.vf
71 pcrb8tn.vf pcrbo8tn.vf pcrrc7tn.vf pcrro8tn.vf zpsycmrv.vf
72 pcrbc7tn.vf pcrr7tn.vf pcrrc8tn.vf zpplcmr.vf zpzccmry.vf
73 pcrbc8tn.vf
74
75 If you don't have these, then strictly speaking you can generate them given
76 the above sources, the sources for mathptm, and fontinst.sty, but I found
77 this ever so fiddly, and I recommend strongly that nobody else try unless
78 they're feeling really brave.
79
80 Finally, you may be lucky and have some extra files:
81
82 mdwfonts.sty -- Unpacked `mdwfonts.sty' package
83 OMLpplcm.fd, OMSpzccm.fd, OMXpsycm.fd, OT1pplcm.fd and mTTpcr.fd
84 -- Font description files for LaTeX
85 mdwfonts.dvi -- Typeset documentation for the system
86
87 If you've already got these, then great, because you don't have to generate
88 them. If you haven't, it's not a big deal. You might also have a bunch of
89 files with extensions like `.log', `.aux', `.tmp', `.ilg' and so on. These
90 files are really not at all interesting, and you might as well get rid of
91 them now.
92
93
94 --- Extracting the packages ---
95
96 If you don't have the various .sty files already, you'll need to extract them
97 from the .dtx files. This requires docstrip.tex, which should be part of
98 your base LaTeX 2e distribution. If you have docstrip vsersion 2.3d, which
99 is available with the December 1995 release of LaTeX, things will go rather
100 faster. If your LaTeX release is much older than this, you should upgrade,
101 because the packages need a fairly new LaTeX anyway. (I could do something
102 about this, but I won't, because I want to encourage everyone to upgrade.)
103
104 If everything's set up correctly, all you should need to do is say
105
106 tex mdwfonts.ins
107
108 or
109
110 latex mdwfonts.ins
111
112 or whatever incantation is necessary to run TeX or LaTeX on the supplied
113 `mdwfonts.ins' file on your system.
114
115 TeX will grind away at the files for a bit, and then say `Done' at you. (This
116 could take a while, so be patient.) You will then have a mdwfonts.log file,
117 which you can throw away, and a collection of sparkly new files. Now the
118 installation can really begin.
119
120
121 --- Installing all the files ---
122
123 The package comes with a large number of miscellaneous font files. They
124 ought to be placed in appropriate directories where TeX and/or other programs
125 can find them. Exactly where this will be depends heavily on your
126 installation: try looking for the other fonts and put these with them. The
127 various extensions for the font files are:
128
129 `.tfm' is a TeX Font Metric file, needed by TeX.
130 `.vf' is a virtual font description file, needed by DVI-drivers.
131 `.fd' is a font description file, required by LaTeX.
132
133 You'll also need to put mdwfonts.sty somewhere where LaTeX will find
134 it. What you do with the documentation file is up to you.
135
136 The various `.fd' files and mdwfonts.sty may not have been included in your
137 distribution. If you don't have them, run LaTeX on `mdwfonts.ins' to build
138 them (see above). I'm explicitly not giving instructions for building all
139 the other font files, because I'd much prefer it if they were distributed as
140 they are, please -- building them is a fiddly business, and I'd rather that
141 only I had to do it.
142
143 Once you've done all that, you must tell dvips about your new fonts, so add
144 the lines in `mdwfonts.map' to your `psfonts.map' file.
145
146
147 --- Typesetting the documentation ---
148
149 If you want to typeset the documentation for the package, you'll need some
150 packages from the `mdwtools' distribution. In particular, you need the
151 `mdwtools.tex' file, and the `syntax.sty' and `sverb.sty' packages. You'll
152 also need the `mdwfonts.dtx' file for the package you want documentation on,
153 and all the files it generated.
154
155 Make sure you've got all the files, and then run LaTeX on mdwfonts.dtx.
156
157 TeX will start hammering away for a very short while, and then stop and ask
158 you whether you want to build the indexing files. Generating index files
159 takes a lot longer (I'd guess that it doubled the amount of time taken to
160 typeset the `.dtx' file) so I don't recommend it unless:
161
162 * you've got a very fast processor, or
163 * you're very interested in how the package works internally, or
164 * you just like everything to be complete, or
165 * you're a masochist.
166
167 Even so, there's no point writing indexing information the first time you
168 run LaTeX on a file, because the table of contents hasn't been created yet,
169 and when you LaTeX the file the second time, all the references will change.
170
171 If you want the index files anyway, type `y' when you're asked. Otherwise,
172 type 'n'. You know you want to type `n' really...
173
174 If you want to do the job properly, you need to run LaTeX a second time
175 to read in the contents table. /This/ is the correct time to turn on
176 indexing, if you really want it.
177
178 If you did build the index files, you should now sort the index by saying
179
180 makeindex -s gind.ist mdwfonts.idx
181
182 The `gind.ist' file should have come with LaTeX. Having done this, you
183 should run the `.dtx' file though LaTeX one final time, to insert the
184 formatted index.
185
186 You can now print or preview the generated `.dvi' file using whatever tools
187 you usually use for such things.
188
189
190 --- Contacting the author ---
191
192 The author can be reached by email at mdw@excessus.demon.co.uk. This is his
193 personal dial-up account, paid for privately, so don't expect replies after
194 five minutes or anything like that.
195
196 If you do have any comments regarding the code, its documentation, or
197 anything else to do with these packages, don't leave me guessing -- let me
198 know. While I won't guarantee to do anything about your comments, chances
199 are that I'll right any wrongs and rescue any damsels in distress (oh, no,
200 wrong spiel).
201
202
203 -----------------------------------------------------------------------------