summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/aastex/README
blob: ce0d72b36cdf8d368cbe79d9bb50e13eba257b08 (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
%% ****** Start of file README ****** %
%%
%% This README is part of the AASTeX 5.2 distribution.
%%
%% Copyright (C) 2003 American Astronomical Society
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%% http://www.latex-project.org/lppl.txt
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2003/12/01 or later.
%%
%% This work has the LPPL maintenance status "maintained".
%%
%% The Current Maintainer of this work is the American Astronomical Society.
%%
%% This work consists of all files listed in the document README.

Last updated June 22, 2005. 

Thanks for your interest in the AASTeX package for manuscript preparation.
This directory contains all the files in the distribution.  They are
described briefly below.  Following the file descriptions
are short installation instructions, the generic recipe for printing the
user guide and sample, and information about contacting us regarding
the distribution.

MANIFEST

aastex.cls		The AASTeX class file

src/aasclass.dtx	The commented source file for aastex.cls
src/aasclass.ins	A docstrip file for extracting aastex.cls 
				from the .dtx file 

docs/aasguide.tex	The user guide for the package
docs/aasguide.dvi	User guide DVI file
docs/aaasguide.pdf	PDF of the user guide

docs/aassymbols.tex	Tables of AASTeX and AMS symbols commands
docs/aassymbols.dvi	Symbols tables DVI file
docs/aassymbols.pdf	PDF of the symbols tables

samples/sample.tex	Sample paper with "typical" content and markup
samples/sample.dvi	Sample paper DVI file

samples/table.tex	Sample table file demonstrating capabilities 
	                	of deluxetable
samples/table.dvi	Sample table DVI file

samples/f1.eps		Sample figure files
samples/f2.eps
samples/f2_color.eps
samples/f3.eps 

samples/video3.mpg	A sample MPEG animation

samples/datafile1.txt	A machine-readable version of Table 1 from sample.tex


ADDITIONAL FILES REQUIRED BY THIS PACKAGE

AASTeX requires the natbib package, which is not 
included in this distribution. The package is available in the distribution on 
the AASTeX Web site at http://www.journals.uchicago.edu/AAS/AASTeX and 
from CTAN (http://www.ctan.org/).

natbib.dtx	Version 7 or later needed
natbib.ins 	LaTeX this to create natbib.sty and natbib
                 documentation from natbib.dtx
 
INSTALLING THE CLASS FILE

The aastex.cls file must be installed so that LaTeX can find it.
To use AASTeX locally, simply place it in the same directory as 
your LaTeX file. 

To install AASTeX for global use on your system, 
copy the aastex.cls (and natbib.sty if 
it is not already on your system) into the directory where your 
LaTeX installation expects to find class files. 

Alternately, Unix/Linux users can use the make file included 
with the distribution. Simply adjust the Makefile so that 
the INSTALLDIR parameter is set to the directory where your 
installation expects to find class files, e.g. 

INSTALLDIR = /usr/share/texmf/tex/latex/misc

If you have teTeX installed, 
run "texconfig conf" to see what TEXMFMAIN is.

Once the INSTALLDIR parameter is set correctly 
in the Makefile, type "make install" at the prompt. 
(You must have the necessary 
write permission in the system area where LaTeX 
files are installed.)

If you are using teTeX, you will need to update the LaTeX 
cache by typing "texconfig rehash."

Please see the AASTeX Web site FAQ at

http://www.journals.uchicago.edu/AAS/AASTeX

for additional installation notes or contact the help desk at 
aastex-help@aas.org for assistance. 


PRINTING THE GUIDE AND SAMPLES

The user guide is written in AASTeX preprint2 style.  
To print it out on a PostScript printer, you will need a DVI driver 
that will output to PostScript. If you wish to print to PostScript, 
and you are on a Unix or Linux system,  
the DVI driver on your computer system is probably called "dvips". 
To print out the user guide DVI file, type 

    prompt> dvips aasguide

To create and print your own DVI file, type

    prompt> latex aasguide
    prompt> latex aasguide
    prompt> dvips aasguide

There are various system- and program-specific eccentricities which
cannot be fully enumerated here.  Some things to watch out for:

    1.  On some systems, LaTeX does not permit a filename extension
	(the .tex) on the input file specification; .tex is assumed.

    2.  The user interfaces for DVI drivers are quite inconsistent.
	Some operate in an interactive mode, asking the user about
	variable setup parameters, while some only accept control
	input on the command line.

    3.  On some systems, DVI translation and printing are combined,
	so one would enter only one OS command after running LaTeX.
	This is typically the case for dvips.

Since LaTeX installations vary widely, you may need to consult 
the documentation for your particular installation or your local 
system administator for guidance in installing and using 
AASTeX.
 
ADMINISTRATIVE DETAILS

AASTeX was designed and written by Chris Biemesderfer in 1988.
Substantial revisions were made by Lee Brotzman and Pierre
Landau when the package was updated to v4.0.
AASTeX was rewritten as a LaTeX class by Arthur Ogawa 
for the  v5.0 release. It was updated to v5.2 by 
SR Nova Private Ltd.
The documentation has benefited from revisions by
Jeannette Barnes, Sara Zimmerman, and Greg Schwartz.

Comments, suggestions, complaints, and pleas for help can be sent
electronically to aastex-help@aas.org.

AASTeX Web site: http://www.journals.uchicago.edu/AAS/AASTeX.

CB, 20 May 1999
Rev. SZ, 2 Nov 2000
Rev. SZ, 14 Dec 2004
Rev. SZ, 22 Jun 2005