| 1 |
.\" Unix Manual Pages for TeXsis, the TeX macros for physicists |
| 2 |
.\"====================================================================== |
| 3 |
.\" (C) Copyright 1991,1994,2000 by Eric Myers and Frank Paige. |
| 4 |
.\" This file is a part of TeXsis. Distribution and/or modifications |
| 5 |
.\" are allowed under the terms of the LaTeX Project Public License (LPPL). |
| 6 |
.\" See the file COPYING or ftp://feynman.physics.lsa.umich.edu/texsis/LPPL |
| 7 |
.\"====================================================================== |
| 8 |
.\" To view this file without the man command type: |
| 9 |
.\" 'nroff -man texsis.1 | more' |
| 10 |
.\" or, on some versions of man, just man -l texsis.1 |
| 11 |
.\" |
| 12 |
.\" @(#) $Id: texsis.1,v 18.0 2000/05/17 00:52:43 myers Exp $ |
| 13 |
.TH TEXSIS 1 "16 May 2000" "TeXsis 2.18" "User Manuals" |
| 14 |
.SH NAME |
| 15 |
TeXsis \- TeX macros for Physicists |
| 16 |
|
| 17 |
.SH SYNOPSIS |
| 18 |
.B texsis |
| 19 |
[ filename ] |
| 20 |
|
| 21 |
.SH DESCRIPTION |
| 22 |
.B TeXsis |
| 23 |
is a collection of |
| 24 |
.B TeX |
| 25 |
macros for typesetting physics documents such as papers and preprints, |
| 26 |
conference proceedings, books, theses, referee reports, letters, and |
| 27 |
memos. |
| 28 |
.B TeXsis |
| 29 |
macros provide automatic numbering of equations, automatic |
| 30 |
numbering and formatting of references, double column formatting, macros |
| 31 |
for making tables and figures, with or without captions, including |
| 32 |
tables with horizontal and vertical rules. |
| 33 |
.B TeXsis |
| 34 |
supports a wide variety of type sizes and a number of |
| 35 |
specialized document formats, and it even includes macros for making |
| 36 |
form letters for job applications or letters of recommendation. |
| 37 |
.PP |
| 38 |
TeXsis is an extension of "plain" TeX, so anything you know how to do |
| 39 |
in plain TeX you can do in TeXsis. |
| 40 |
TeXsis macro instructions are simply abbreviations for often used |
| 41 |
combinations of control sequences used to typeset physics documents. |
| 42 |
For more information about plain TeX see the man pages for |
| 43 |
.BR tex (1), |
| 44 |
and/or |
| 45 |
.I The TeXbook, |
| 46 |
by D.E. Knuth. |
| 47 |
.PP |
| 48 |
TeXsis is stored as a pre-loaded format so that it loads quickly (see |
| 49 |
the man pages for |
| 50 |
.BR initex (1), |
| 51 |
and/or "preloaded formats" in |
| 52 |
.I The TeXbook |
| 53 |
). |
| 54 |
To run TeXsis simply give the command |
| 55 |
.B texsis |
| 56 |
in place of the |
| 57 |
.B tex |
| 58 |
command, i.e. |
| 59 |
.br |
| 60 |
.sp |
| 61 |
.in +2 |
| 62 |
.B texsis |
| 63 |
[ filename ] |
| 64 |
.in -2 |
| 65 |
.br |
| 66 |
.sp |
| 67 |
where |
| 68 |
.I filename.tex |
| 69 |
is the name of a file containing TeX and/or TeXsis |
| 70 |
\\controlsequences. |
| 71 |
.PP |
| 72 |
TeXsis is initally in plain TeX mode, i.e. 10pt type and singlespaced, |
| 73 |
but the control sequence \\texsis selects 12pt type, doublespacing, |
| 74 |
and enables other useful features. |
| 75 |
Alternatively, \\paper turns on these features and sets things up to |
| 76 |
typeset a paper, \\thesis does the same for typesetting a thesis, |
| 77 |
\\letter is used to produce a letter using macros similar to those |
| 78 |
listed in the back of |
| 79 |
.I The TeXbook, |
| 80 |
\\memo gives a setup for producing memoranda, and so on. |
| 81 |
.PP |
| 82 |
A manual which describes all of the TeXsis macro instructions is |
| 83 |
available. |
| 84 |
It is written in TeXsis, so it serves as its own example of how to |
| 85 |
write a document with TeXsis. |
| 86 |
The source code is also heavily commented, so it is possible to |
| 87 |
extract useful macros from the source code and modify them to suit |
| 88 |
your own purposes. |
| 89 |
Provisions are made for local customization of TeXsis. |
| 90 |
In particular, the file |
| 91 |
.I TXSmods.tex, |
| 92 |
if it exists, is read from the current directory or from the path |
| 93 |
.B TEXINPUTS |
| 94 |
whenever TeXsis is started. |
| 95 |
You can therefore put your own custom macros for a given project in a |
| 96 |
directory and they will automatically be loaded when TeXsis is run |
| 97 |
from that directory. |
| 98 |
|
| 99 |
.SH INSTALLATION |
| 100 |
There is an appendix to the printed manual containing detailed |
| 101 |
installation instructions, but they are also provided in a form which |
| 102 |
can be processed by plain TeX, in the file |
| 103 |
.I Install.tex. |
| 104 |
|
| 105 |
.SH DIAGNOSTICS |
| 106 |
TeXsis informational messages are written to the terminal and the log |
| 107 |
file begining with `% '. |
| 108 |
Warning and error messages begin with `> '. |
| 109 |
|
| 110 |
.SH FILES |
| 111 |
The source files for TeXsis and the TeXsis manual are usually installed |
| 112 |
in the same place the rest of TeX is kept. |
| 113 |
Although this may vary from intallation to installation, it will |
| 114 |
generally include a root directory named |
| 115 |
.I texmf. |
| 116 |
Common examples are |
| 117 |
.I /usr/share/texmf/, |
| 118 |
.I /usr/lib/teTeX/texmf, |
| 119 |
or |
| 120 |
.I /usr/local/lib/texmf. |
| 121 |
Filenames here are relative to this |
| 122 |
.I texmf |
| 123 |
root directory. |
| 124 |
.br |
| 125 |
.TP 2.5i |
| 126 |
.I web2c/texsis.fmt |
| 127 |
TeXsis pre-loaded format. |
| 128 |
.TP |
| 129 |
.I tex/texsis/TXS*.tex |
| 130 |
TeXsis source code. |
| 131 |
.TP |
| 132 |
.I tex/texsis/*.txs |
| 133 |
"Style" files which can be read in at run time for special document |
| 134 |
formats. |
| 135 |
.TP |
| 136 |
.I doc/texsis/TXS*.doc |
| 137 |
Source for the printed TeXsis manual (written in TeXsis). |
| 138 |
.TP |
| 139 |
.I tex/texsis/TXSsite.tex |
| 140 |
Local site customization instructions |
| 141 |
(this is read only once, when the format file is created). |
| 142 |
.TP |
| 143 |
.I tex/texsis/TXSpatch.tex |
| 144 |
Run time patch file (like a system TeXsis.rc file, it is read |
| 145 |
every time TeXsis is run). |
| 146 |
.TP |
| 147 |
.I TXSmods.tex |
| 148 |
Run time init file (this is read every time TeXsis is run from the |
| 149 |
current directory, or from the search path in |
| 150 |
.B TEXINPUTS |
| 151 |
). |
| 152 |
|
| 153 |
.SH RESTRICTIONS |
| 154 |
Please note that TeXsis is designed to be completely compatible with |
| 155 |
plain TeX. |
| 156 |
As a result it cannot be compatible with LaTeX. |
| 157 |
.PP |
| 158 |
Having the full manual written in TeXsis can cause a problem if you |
| 159 |
don't have a version of TeXsis already running. |
| 160 |
To get around this you can run |
| 161 |
.I Manual.tex |
| 162 |
through plain TeX and it will load the TeXsis files before processing |
| 163 |
the manual. |
| 164 |
This takes longer, but not by much. |
| 165 |
|
| 166 |
|
| 167 |
.SH BUGS |
| 168 |
Please report bugs (or suggestions for improvements) to |
| 169 |
[email protected]. |
| 170 |
.PP |
| 171 |
Patchs to correct small problems or make small improvements |
| 172 |
are available at |
| 173 |
|
| 174 |
ftp://feynman.physics.lsa.umich.edu/texsis/ |
| 175 |
|
| 176 |
in the file |
| 177 |
.I TXSpatch.tex |
| 178 |
(If that file doesn't exist then there are no current patches.) |
| 179 |
|
| 180 |
.SH SEE ALSO |
| 181 |
.BR initex (1), |
| 182 |
.BR tex (1), |
| 183 |
.BR virtex (1) |
| 184 |
.br |
| 185 |
Donald E. Knuth, |
| 186 |
.I The TeXbook; |
| 187 |
.br |
| 188 |
Michael Doob, |
| 189 |
.I A Gentle Introduction to TeX. |
| 190 |
|
| 191 |
.SH AUTHORS |
| 192 |
Eric Myers <[email protected]> |
| 193 |
.br |
| 194 |
Department of Physics |
| 195 |
.br |
| 196 |
University of Michigan |
| 197 |
.br |
| 198 |
Ann Arbor, Michigan USA |
| 199 |
.sp 1 |
| 200 |
and |
| 201 |
.sp 1 |
| 202 |
Frank E. Paige <[email protected]> |
| 203 |
.br |
| 204 |
Physics Department |
| 205 |
.br |
| 206 |
Brookhaven National Laboratory |
| 207 |
.br |
| 208 |
Upton, New York 11973 USA |
| 209 |
.fi |
| 210 |
|
| 211 |
.SH VERSION |
| 212 |
.de VL |
| 213 |
\\$2 |
| 214 |
.. |
| 215 |
Revision Number: 2.18/beta3 |
| 216 |
.br |
| 217 |
Release Date: 16 May 2000 |
| 218 |
|
| 219 |
.end |