summaryrefslogtreecommitdiff
path: root/macros/lamstex/inputs/inst.tex
blob: e1b7bbd76b4ae6698f97f588c39b4ed002b5cf4f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
\input amstexl
\input lamstex

\docstyle{paper}

\fancyfootnotes
\RefWarnings
\litdelimiter*
\litbackslash"

%%%%%%%%%%%%%%%%%%%%% Special stuff for this document %%%%%%%%%%%%%%%%%%%%%

%% Material before title (\pretitle):

\font\bigbf=cmbx10 scaled\magstep5
\redefine\pretitle{\centerline{\bigbf READ ME FIRST!}\vskip5pt}

%% Put headings on pages:

\headline={\ifnum\pageno=1 \hfil
 \else
  \tenpoint
  \leaders\hrule height.6pt\hfil\ %
  \LamSTeX\ \bf INSTALLATION MANUAL%
  \rm\ \leaders\hrule height.6pt \hfil
 \fi}

%% LaTeX logo:

\define\LaTeX{L\kern-.35em\raise.4ex\hbox{\sevenrm A}\kern-.15em\TeX}

%% TeXtures logo:

\define\TeXtures{\TeX {\smc tures}}

%% BibTeX logo:

\def\BibTeX{B{\eightrm IB}\kern-.1em\TeX}

%% For special `Mac' paragraphs

\define\Mac{%
 \medbreak\noindent
 \vtop{\offinterlineskip
       \vbox{\hrule
             \hbox{\vrule
                   \hskip1.5pt
                   \vbox{\vskip1.5pt
                         \hrule height 7pt width11pt depth0pt
                         \vskip2pt
                         \hbox{\hskip4pt
                               \vrule height.25pt depth.25pt width4pt
                               \vrule height.7pt depth.7pt width 3pt}%
                         \vskip3pt}%
                   \hskip1.5pt\vrule}%
             \hrule}%
       \vskip-.4pt
       \hbox to14.8pt{\hfil
                      \vbox{\hrule
                            \hbox to12pt{\vrule height2pt\hfil \vrule}%
                            \hrule}%
                      \hfil}%
      }\hskip5pt\relax}

\define\endMac{\medbreak}

%% \ character, when literal mode can't be used:

\define\bs{\char'134 }

% Prevent the hyphenation re-ally:

\hyphenation{real-ly}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\document

\title \rm\LamSTeX\\ INSTALLATION\\ MANUAL\endtitle

\author The \TeX plorators Corporation\endauthor

\abstract
This installation manual explains how to install \LamSTeX\ on MS-DOS machines
or on the Macintosh.

This manual was itself produced with the \lit*paper* style. 
Appendix~\ref{repro} explains how to use \LamSTeX@, together with some of the
text files supplied, to reproduce this manual.
\endabstract

\date\today

\thanks{Acknowledgements:

As always, my most sincere thanks go to Don Knuth, who made it all possible.

Thanks to all those who tried out \LamSTeX\ in its early stages, and to
Mike Downes and Barbara Beeton, for the interfacing with \AmSTeX.

Special thanks to Blue Sky Research, and Doug Henderson in particular, for
efforts beyond the call of duty, or even of reason.}

\keywords{\LamSTeX}
\subjclass{Typesetting}
\address{3701 W. Alabama, Suite 450-273. Houston, TX 77027 (U.S.A.)}

\maketitle

%\maketoc
\tocfile
\toclevel 1

\heading Introduction\endheading

The main Manual for \LamSTeX\ is {\it\LamSTeX@, The Synthesis}, together with
the \LamSTeX\ Version~\lit*2.0* Supplement, which notes various changes for
the latest version.  The most important changes are covered in sections~ 2.1,
4.1, 4.2, 5.1, and~ 5.2 of the Supplement.  Chapters~9 and ~10 of the
Supplement explain about the \lit*paper* and \lit*book* style (mentioned
below), and Chapter~13 explains about partitioned matrices, a new feature of
\LamSTeX@.  

\heading Cautions, Requirements, and Prerequisites\endheading

In addition to the \lit*.log* and \lit*.dvi* files that \TeX\ normally
writes, \LamSTeX\ also writes files with the extensions \lit*.lax*, 
\lit*.ndx*, and \lit*.toc*. Files with the extension \lit*.aux*,
\lit*.xdx*, and \lit*.bbl* may also be produced.

This naturally means that you should avoid these extensions for files that
you make yourself, and it also means that your operating system must allow
numerous files to be open at once; in MS-DOS systems your \lit*config.sys*
file should set the values \lit*FILES=20* and \lit*BUFFERS=16*, or higher.

To run \LamSTeX\ you will need an implementation of \TeX\ that allows the
maximum main memory size (\lit*65534* words); it must also allow at least
\lit*3000* control sequence names (as well as enough room for the
additional fonts that come with \LamSTeX).

In addition to macro packages, \LamSTeX\ also involves some programs. As
explained below, MS-DOS or Macintosh versions are supplied, as well as the
C~source code, for compilation on other machines.

The \LamSTeX~Manual assumes that you already know about, and are using, \TeX\
(the basic reference here is [1], though you might well be using a more
elementary introduction); for the installation, you will also need to have at
least some idea of where your implementation of \TeX\ keeps various types of
files.  A little familiarity with \AmSTeX\ is also assumed, the official
reference being [3]. You do not need to know \LaTeX\ (described in [2]),
except that you won't understand the name `\LamSTeX' unless you know that
\LaTeX\ exists also.

\heading Installation\endheading

\LamSTeX\ consists of several macro packages to be used along with \TeX@,
a couple of programs to process various parts of the output, and 5~new
fonts, for producing commutative diagrams (see Part~II of the Manual,
{\it\LamSTeX@, The Synthesis}).

Since different implementations of \TeX\ keep files in different places,
it is not possible to provide an installation program to place all the
\LamSTeX\ files in the proper place; you will have to do that yourself,
although there are some aids for installing the fonts properly.

\section{Macro packages} You might want to make a special directory for
the \LamSTeX\ macro files, or you might want to put them in a directory
where your implementation of \TeX\ normally looks for input files.

As explained in the Manual, \LamSTeX\ must always be used with
\AmSTeX@, and in particular, with the file \lit*amstexl.tex*.

The files \lit*lamstex.tex* and \lit*lasmtbl.tex* are the main macro packages
for \LamSTeX@, while \lit*lamstex.stf*, \lit*lamstex.stb*, and
\lit*lamstex.stt* are subsidiary files used when producing tables of
contents, indexes and tables.

The file \lit*ptmatrix.tex* is used for partitioned matrices, as mentioned
above.  The file \lit*bibtex.tex* is needed when interfacing with \BibTeX\
(as explained in Chapter~7 of the Supplement). The file \lit*lithl.tex* has a
very specialized use, explained in Chapter~11 of the Supplement, and the
files \lit*pcompat.tex* and \lit*acompat.tex* are also quite specialized,
allowing compatibility with files originally produced with \lit*plain* \TeX@,
and \AmSTeX@, respectively; the use of these files is described at the
beginning of the files themselves.

Eleven pairs of files, \lit*alignat.tex*, \lit*alignat.tox*, \dots,
\lit*varref.tex*, \lit*varref.tox*, come next; their function is described
in Chapter~14 of the Manual.

Next come ``style files''.  As the Manual explains, \LamSTeX\ % automatically
comes with a default style, which is easy to use while you are still learning
about \text{\LamSTeX}@. There are also two ``generic'' \LamSTeX\ styles---for
papers and books---which comprise the files \lit*paper."1"1"1* and
\lit*book."1"1"1*.  (Eventually, many specialized style files should also be
available for \LamSTeX.) As mentioned in the Introduction, the \lit*paper*
and \lit*book* styles are described in Chapters~9 and~10 of the Supplement;
since most features of these styles are extensions of those for the default
style, you should be familiar with the default style, explained in the
Manual, before trying to learn about the specialized styles.

[Both the \lit*paper* and \lit*book* styles use 8~point type for various
constructions, and they both have the control sequence \lit*\LamSTeX* for
printing the `\text{\LamSTeX}' logo, which uses the Computer Modern symbol
font \lit*cmsy8*, normally loaded only for 8~point type. The file
\lit*lamslogo.tex* allows you to print the \LamSTeX\ logo even in the default
style: Type `\lit*\input lamslogo*' at the beginning of your file; this will
load \lit*cmsy8* if necessary, and then define the \lit*\LamSTeX* control
sequence.]

There is also a specialized \lit*letter.st* for letters; to find out about
it, \TeX\ the file \lit*letter.tex*, and print it out.  (The letter uses the
\lit*\LamSTeX* logo control sequence, so you will need to have the
\lit*cmsy8* font available. If you don't have this font, simply delete the
line \lit*\input lamslogo* from the file, and replace the occurrences of
\lit*{\LamSTeX}* with something you can print, for example, `\lit*LAMSTEX*'.)

\section{Programs\label{programs}} The \LamSTeX\ programs \lit*index* and
\lit*dvipaste* are used to process some of \LamSTeX's output: \lit*index*
turns the compact index files produced by \LamSTeX\ into sorted, extended,
files that can then be used to actually print an index (Chapter~13 of the
Manual), while \lit*dvipaste* is needed to implement \LamSTeX's approach to
tables (see Chapter~17).  These programs should be installed in the proper
place for them to work on the files that are produced by \LamSTeX@.  For
MS-DOS there are executable files \lit*index.exe* and
\lit*dvipaste.exe*.

\Mac
For
the Macintosh version of \LamSTeX\ there are \lit*dvipaste* and \lit*index*
applications. As explained in the Manual, \lit*dvipaste* combines
\lit*.dvi* files. If you are using \TeXtures, which normally doesn't
create \lit*.dvi* files, you will first have to use the \TeXtures\ DVItool
accessory, choosing `Export DVI' to create the \lit*.dvi* files that are
going to be combined; after using \lit*dvipaste* to create a (newly named)
\lit*.dvi* file, you will have to use the DVItool accessory again,
choosing `Import DVI' to convert this \lit*.dvi* file into a \TeXtures\ %
document. (Sigh.)  \endMac

If you have neither an MS-DOS machine nor a Macintosh, the necessary programs
can be compiled from the C~source code files \lit*dvipaste.c* and
\lit*index.c*.

\section{Fonts} Installation of \LamSTeX's fonts for commutative diagrams
is more complicated.

\subsection{The {\tt.tfm} files} Even if you aren't going to use
commutative diagrams, you will at least need the \lit*.tfm* files
\lit*lams1.tfm*, \dots, \lit*lams5.tfm*, since the \lit*lamstex.tex* macro
package uses them, and you will also need the \lit*dummy.tfm* file that is
used by \AmSTeX@.
\footnote{This font isn't all that important, but the \AmSTeX\ macro file
does load it; only the metrics for this font are needed, since it is used
only for ``syntax checking'', where no output is produced.} These \lit*.tfm*
files should simply be placed wherever your implementation of \TeX\ expects
to find \lit*.tfm* files.

\Mac
For versions of \TeX\ on the
Macintosh that do not use ordinary \lit*.tfm* and \lit*.pk* files,
  there are `\lit*lamsmetrics*' and `\lit*lamsfonts*'
suitcases for \TeXtures. Just copy these suitcases into the \TeXtures\ %
`\lit*TeX fonts*' folder, and you will be done.  The suitcases contain the
necessary font metrics, as well as the fonts for printing on the LaserWriter
or viewing with \TeXtures---these fonts are supplied at the standard
magnification, as well as the magnifications \lit*\magstephalf*,
\lit*\magstep1*, and \lit*\magstep2*.

In addition, there is a `\lit*dummy*' suitcase for the \lit*dummy* font used
in \AmSTeX@, which should also be transferred to the `\lit*TeX fonts*'
folder.


\subsection{The {\tt.pk} files} Installation of \lit*.pk* files is much
more complicated, not only because every implementation of \TeX\ seems to
arrange things differently, but also because different \lit*.pk* files are
required for different printers.  The
\lit*.pk* files are kept in separate directories (or folders)---\lit*300*,
\lit*240*, \lit*180*, and \lit*118*---where \lit*300* is for 300~dot/inch
printers, \lit*240* for 240~dot/inch printers, \lit*180* for 180~dot/inch
printers, and \lit*118* for ``printing'' on the screen (viewing) with
ArborText's~\lit*preview*.

\smallskip
The first thing to do is to change to the subdirectory where you want to
place the standard size (unmagnified) \lit*.pk* files.  The name of this
subdirectory probably ends with something like that shown in the table
below: \pagelabel{startpage}
\bigskip
\centerline{\paste{insttbls}1}
\bigskip
\flushpar (If you are lucky, you might have an implementation of \TeX\
that follows a more logical arrangement, like using \lit*\300\m1000* for
the unmagnified fonts for 300~dot/inch printers, \lit*\240\m1000* for the
unmagnified fonts for 240~dot/inch printers, etc.)

Each of the directories \lit*300*, \dots,
\lit*118*, has subdirectories \lit*0*, \lit*h*, \lit*1*, and \lit*2*,
where the subdirectory \lit*0* contains the unmagnified fonts for that
resolution. The five files {\it in subdirectory~\lit*0* of the appropriate
directory\/}  should be copied to the hard disk, {\it
assuming that you are in the proper subdirectory of the hard disk}.

For MS-DOS systems, there are batch files, \lit*300.bat*, \lit*240.bat*,
\lit*180.bat*, and \lit*118.bat*, to do this.  {\it Assuming that you are
in the proper subdirectory of the hard disk}, and that the diskette
containing the fonts is in drive \lit*a:*, you can simply type



\list
\item \lit*a:300* for 300 dot/inch printers;
\item \lit*a:240* for 240 dot/inch printers;
\item \lit*a:180* for 180 dot/inch printers;
\item \lit*a:118* for 118 dot/inch previewing.
\endlist
If, for some reason, the diskette has to be placed in the \lit*b:* drive,
then in the batch files all occurrences of \lit*a:* will have to be
changed to \lit*b:*.

\smallskip

The Manual was actually printed with somewhat preliminary versions of
these special fonts, and at certain places in the Manual, for example, on
page~139, it can be seen that different portions of horizontal arrows do
not align quite properly.  The arrow fonts that come with \LamSTeX\ have
corrected these deficiencies.

Nevertheless, at 300 dot/inch, or even lower resolution, it is inevitable
that there will be some jaggedness in the arrows---which are constructed
by juxtaposing smaller pieces---as in the diagram below:
$$
\cgaps{1;.5}
\CD
A @(1,0) @(0,-1) @(1,-1) & B @()\0t@(0,-1) @(1,0) @(1,-1)& C@(0,-1)\\
D @(1,0) @(1,1) & E @(1,1) @(1,0)& F
\endCD
$$

By the way, this diagram has no inherent interest, except that it happens
to use characters from all five of these fonts, so printing this manual
yourself, as described in Appendix~\ref{repro}, provides a check that the
fonts have been installed correctly.

\Mac
If you have a Macintosh Plus or SE@, things will be even worse when you
view such diagrams.  Because of a QuickDraw bug in the ROM@, horizontal
and vertical arrows usually won't have the proper heads; however, the
printed version will still be correct.
\endMac

\topic{Magnified fonts} You now have all the \lit*.pk* files necessary for
printing (or previewing) unmagnified documents.  But in case you want to
apply magnification to some documents, all the \lit*.pk* files are also
supplied at magnifications of \lit*\magstephalf*, \lit*\magstep1*, and
\lit*\magstep2*.

\subtopic{Fonts for {\tt\bs magstephalf}} To install all the \lit*.pk*
files used for magnification by\linebreak \lit*\magstephalf*, you must
first change to the subdirectory where the magnified files are supposed to
go.  The name of this subdirectory probably ends with something like that
shown in the table below
\bigskip
\centerline{\paste{insttbls}2}
\nopagebreak
\bigskip
\flushpar(or, more logically, with something like \lit*\m1095*.)

Now you should copy the files in subdirectory~\lit*h* of the appropriate
directory on the diskette to this directory of the hard disk.  For MS-DOS
systems, you can simply type
\list
\item \lit*a:300-h* for 300 dot/inch printers;
\item \lit*a:240-h* for 240 dot/inch printers;
\item \lit*a:180-h* for 180 dot/inch printers;
\item \lit*a:118-h* for 118 dot/inch previewing.
\endlist

\subtopic{Fonts for {\tt\bs magstep1}} The \lit*.pk* files for
magnification by \lit*\magstep1* are installed similarly, in a
subdirectory whose name probably ends with something like that shown in
the table below
\bigskip
\centerline{\paste{insttbls}3}
\nopagebreak
\bigskip
\flushpar (or, more logically, with something like \lit*\m1200*).

In this case, you should copy the files in subdirectory~\lit*1* of the
appropriate directory on the diskette to this subdirectory of the hard
disk. For MS-DOS systems, you can simply type \lit*a:300-1* or
\lit*a:240-1* or \lit*a:180-1* or \lit*a:118-1*.

\subtopic{Fonts for {\tt\bs magstep2}} Finally, the \lit*.pk* files for
magnification by \lit*\magstep2* can be installed in the same way, in a
subdirectory whose name probably ends with something like that shown in
the table below \pagelabel{endpage}
\bigskip
\centerline{\paste{insttbls}4}
\nopagebreak
\bigskip
\flushpar (or, more logically, with something like \lit*\m1440*).

In this case, you should copy the files in subdirectory~\lit*2* of the
appropriate directory on the diskette to this subdirectory of the hard
disk.  For MS-DOS systems, you can simply type \lit*a:300-2* or
\lit*a:240-2* or \lit*a:180-2* or \lit*a:118-2*.

\section{Sources} The final set of files are source-code for programs and
fonts.  In addition to the \lit*dvipaste.c* and \lit*index.c* source code,
discussed in section~\ref{programs}, there are the MetaFont source files
\lit*lams1.mf*, \dots, \lit*lams5.mf*, from which these fonts can be
produced at any size and resolution.

Although the \lit*dvipaste* program was written specifically for
\LamSTeX@, it can actually be used for numerous general \TeX\ purposes, in
conjunction with an extra macro package \lit*dvipaste.tex*.  The file
\lit*dvipaste.doc* describes such usage, which is further illustrated by
the files \lit*boxes1.tex*, \lit*boxes2.tex*, and \lit*join.tex*. (None of
these files are really part of \LamSTeX.)


\appendices
\appendix Reproduction\label{repro}\endappendix

The files \lit*insttbls.tex* and \lit*inst.tex* may be used to reproduce
this manual (with the current date). This provides a good test that
\LamSTeX\ is safely installed, since it uses so many \LamSTeX\ features,
but for this very reason you might want to wait until you are more
familiar with \LamSTeX\ before making the attempt.

Once you're ready, here's the recipe:
\list \advance\litindent30pt

\item First \TeX\ the file \lit*insttbls.tex*. (If you've already made a
\LamSTeX\ format file, {\it do not\/} use it for this file [see page~179
of the Manual], just \TeX\ the file directly.)  This will produce a
\lit*insttbls.dvi* file that you may or may not want to print, and a file
\lit*insttbls.dat*, both needed in the sequel.

\item Now \TeX\ the file \lit*inst.tex*. (If you've made a \LamSTeX\
format file, you can use it for this file---the first two lines of the
file will essentially be ignored.) Ignore \lit*Warning* 
 messages.  A \lit*inst.toc* file will be produced, along with the
\lit*inst.dvi* file (which isn't any good yet, since the Contents don't
appear).

\item Now use your text editor to remove the \lit*%* sign before the line
\lit*\maketoc* (you wouldn't want this line there the first time, because
\TeX\ would complain that it couldn't find the \lit*inst.toc* file), and
\TeX\ the file \lit*inst.tex* once again.  This time no \lit*Warning* 
 messages should appear.

{\newpost\list1{$'$} \Offset\list10
\item The new \lit*.dvi* file now has the Contents, but the page numbers
aren't correct, because inclusion of this Contents has moved some sections
to the next page. So you have to \TeX\ the file once again.
}

\item Finally, use the \lit*dvipaste* program,
\Lit*
dvipaste inst
*
to produce a new \lit*inst.dvi* file.  (With \TeXtures, you must first use
the DVItool accessory to produce the \lit*inst.dvi* and \lit*insttbls.dvi*
files, then use \lit*dvipaste*, and then use DVItool once again to create
a new \TeXtures\ document.)

\endlist

Once the ingredients are properly mixed, place in a moderate laser printer
for 10--20 seconds per page, allow to cool for a few seconds, and enjoy.
Makes 1~copy.

\makebib
\bib \no1 \by Knuth, Donald E. \book The \TeX book \publ
  Addison-Wesley Publishing Company, Inc\endbib
\bib \no2 \by Lamport, Leslie \book \LaTeX@: A Document Preparation
 System \publ Addison-Wesley Publishing Company, Inc\endbib
\bib \no3 \by Spivak, M.D., Ph.D. \book The Joy of \TeX \publ
 American Mathematical Society\endbib
\endmakebib

\enddocument