summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/texsis.1
blob: 241319867b84bb9605fa30db4a11f07457ba2c1e (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
.\"  Unix Manual Pages for TeXsis, the TeX macros for physicists
.\"======================================================================
.\" (C) Copyright 1991,1994,2000 by Eric Myers and Frank Paige.
.\" This file is a part of TeXsis.  Distribution and/or modifications
.\" are allowed under the terms of the LaTeX Project Public License (LPPL).
.\" See the file COPYING or ftp://feynman.physics.lsa.umich.edu/texsis/LPPL
.\"======================================================================
.\"  To view this file without the man command type: 
.\"         'nroff -man texsis.1 | more'
.\"  or, on some versions of man, just man -l texsis.1
.\"
.\" @(#) $Id: texsis.1,v 18.0 2000/05/17 00:52:43 myers Exp $
.TH TEXSIS 1  "16 May 2000"  "TeXsis 2.18"  "User Manuals"
.SH NAME
TeXsis \- TeX macros for Physicists

.SH SYNOPSIS
.B texsis 
[ filename ]

.SH DESCRIPTION
.B TeXsis 
is a collection of 
.B TeX
macros for typesetting physics documents such as papers and preprints,
conference proceedings, books, theses, referee reports, letters, and
memos. 
.B TeXsis
macros provide automatic numbering of equations, automatic
numbering and formatting of references, double column formatting, macros
for making tables and figures, with or without captions, including
tables with horizontal and vertical rules.
.B TeXsis
supports a wide variety of type sizes and a number of
specialized document formats, and it even includes macros for making
form letters for job applications or letters of recommendation.
.PP
TeXsis is an extension of "plain" TeX, so anything you know how to do
in plain TeX you can do in TeXsis.
TeXsis macro instructions are simply abbreviations for often used
combinations of control sequences used to typeset physics documents.
For more information about plain TeX see the man pages for
.BR tex (1),
and/or 
.I The TeXbook, 
by D.E. Knuth.
.PP
TeXsis is stored as a pre-loaded format so that it loads quickly (see
the man pages for 
.BR initex (1),
and/or "preloaded formats" in 
.I The TeXbook
). 
To run TeXsis simply give the command 
.B texsis
in place of the 
.B tex
command, i.e.
.br
.sp
.in +2
.B texsis  
[ filename ]
.in -2
.br
.sp
where 
.I filename.tex 
is the name of a file containing TeX and/or TeXsis
\\controlsequences.
.PP
TeXsis is initally in plain TeX mode, i.e. 10pt type and singlespaced,
but the control sequence \\texsis selects 12pt type, doublespacing,
and enables other useful features.
Alternatively, \\paper turns on these features and sets things up to
typeset a paper, \\thesis does the same for typesetting a thesis,
\\letter is used to produce a letter using macros similar to those
listed in the back of
.I The TeXbook,
\\memo gives a setup for producing memoranda, and so on.
.PP
A manual which describes all of the TeXsis macro instructions is
available.
It is written in TeXsis, so it serves as its own example of how to
write a document with TeXsis.
The source code is also heavily commented, so it is possible to
extract useful macros from the source code and modify them to suit
your own purposes.
Provisions are made for local customization of TeXsis.
In particular, the file 
.I TXSmods.tex, 
if it exists, is read from the current directory or from the path
.B TEXINPUTS 
whenever TeXsis is started.
You can therefore put your own custom macros for a given project in a
directory and they will automatically be loaded when TeXsis is run
from that directory.

.SH INSTALLATION
There is an appendix to the printed manual containing detailed
installation instructions, but they are also provided in a form which
can be processed by plain TeX, in the file
.I Install.tex.

.SH DIAGNOSTICS
TeXsis informational messages are written to the terminal and the log
file begining with `% '.
Warning and error messages begin with `> '.

.SH FILES
The source files for TeXsis and the TeXsis manual are usually installed  
in the same place the rest of TeX is kept.
Although this may vary from intallation to installation, it will
generally include a root directory named
.I texmf.  
Common examples are 
.I /usr/share/texmf/,
.I /usr/lib/teTeX/texmf,
or 
.I /usr/local/lib/texmf.
Filenames here are relative to this
.I texmf
root directory.
.br
.TP 2.5i
.I web2c/texsis.fmt
TeXsis pre-loaded format.
.TP 
.I tex/texsis/TXS*.tex
TeXsis source code.
.TP
.I tex/texsis/*.txs
"Style" files which can be read in at run time for special document
formats.
.TP
.I doc/texsis/TXS*.doc
Source for the printed TeXsis manual (written in TeXsis).
.TP
.I tex/texsis/TXSsite.tex
Local site customization instructions 
(this is read only once, when the format file is created).
.TP
.I tex/texsis/TXSpatch.tex
Run time patch file (like a system TeXsis.rc file, it is read
every time TeXsis is run).
.TP
.I TXSmods.tex
Run time init file (this is read every time TeXsis is run from the
current directory, or from the search path in 
.B TEXINPUTS
).

.SH RESTRICTIONS
Please note that TeXsis is designed to be completely compatible with
plain TeX.
As a result it cannot be compatible with LaTeX.
.PP
Having the full manual written in TeXsis can cause a problem if you
don't have a version of TeXsis already running.
To get around this you can run
.I Manual.tex 
through plain TeX and it will load the TeXsis files before processing
the manual.
This takes longer, but not by much.


.SH BUGS
Please report bugs (or suggestions for improvements) to  
texsis@feynman.physics.lsa.umich.edu.
.PP
Patchs to correct small problems or make small improvements
are available at 

        ftp://feynman.physics.lsa.umich.edu/texsis/

in the file 
.I TXSpatch.tex
(If that file doesn't exist then there are no current patches.)

.SH SEE ALSO
.BR initex (1),
.BR tex (1),
.BR virtex (1)
.br
Donald E. Knuth,
.I The TeXbook;
.br
Michael Doob,
.I A Gentle Introduction to TeX.

.SH AUTHORS
Eric Myers <myers@umich.edu>
.br
Department of Physics 
.br
University of Michigan
.br
Ann Arbor, Michigan  USA
.sp 1
and
.sp 1
Frank E. Paige <paige@bnl.gov>
.br
Physics Department        
.br
Brookhaven National Laboratory 
.br
Upton, New York 11973 USA
.fi

.SH VERSION
.de VL
\\$2
..
Revision Number: 2.18/beta3
.br
Release Date:  16 May 2000

.end