4 This is the README file for the AUCTeX distribution.
7 Copyright (C) 2008 Free Software Foundation, Inc.
9 Copying and distribution of this file, with or without modification, are
10 permitted in any medium without royalty provided the copyright notice
11 and this notice are preserved.
14 @chapheading Introduction to @AUCTeX{}
19 @chapter Overview of @AUCTeX{}
23 This file gives a brief overview of what @AUCTeX{} is. It is
24 @strong{not} an attempt to document @AUCTeX{}. Real documentation for
25 @AUCTeX{} is available in the manual, which should be available as an
26 info file after installation.
29 @AUCTeX{} is a comprehensive customizable integrated environment for
30 writing input files for @TeX{}, @LaTeX{}, @ConTeXt{}, Texinfo, and
31 doc@TeX{} using Emacs or XEmacs.
33 It supports you in the insertion of macros, environments, and sectioning
34 commands by providing completion alternatives and prompting for
35 parameters. It automatically indents your text as you type it and lets
36 you format a whole file at once. The outlining and folding facilities
37 provide you with a focused and clean view of your text.
39 @AUCTeX{} lets you process your source files by running @TeX{} and
40 related tools (such as output filters, post processors for generating
41 indices and bibliographies, and viewers) from inside Emacs. @AUCTeX{}
42 lets you browse through the errors @TeX{} reported, while it moves the
43 cursor directly to the reported error, and displays some documentation
44 for that particular error. This will even work when the document is
45 spread over several files.
47 One component of @AUCTeX{} that @LaTeX{} users will find attractive is
48 @previewlatex{}, a combination of folding and in-source previewing
49 that provides true ``What You See Is What You Get'' experience in your
50 sourcebuffer, while letting you retain full control.
52 For more information, see further below.
55 More detailed information about the features and usage of @AUCTeX{} can
58 @AUCTeX{} manual. You can access it from within Emacs by typing
59 @kbd{C-h i d m auctex @key{RET}}. If you prefer the standalone info
60 reader, issue the command @code{info auctex} in a terminal.
63 remainder of this manual.
66 @AUCTeX{} is written entirely in Emacs Lisp, and hence you can easily
67 add new features for your own needs. It is a GNU project and
68 distributed under the `GNU General Public License Version 3'.
70 The most recent version is always available at
71 @url{http://ftp.gnu.org/pub/gnu/auctex/}.
73 WWW users may want to check out the @AUCTeX{} page at
74 @url{http://www.gnu.org/software/auctex/}.
76 For comprehensive information about how to install @AUCTeX{}
78 read the file @file{INSTALL} or @file{INSTALL.windows}, respectively.
81 @xref{Installation}, or @ref{Installation under MS Windows},
85 If you are considering upgrading @AUCTeX{}, the recent changes are
88 the @file{CHANGES} file.
94 If you want to discuss @AUCTeX{} with other users or its developers,
95 there are several mailing lists you can use.
97 Send a mail with the subject ``subscribe'' to
98 @email{auctex-request@@gnu.org} in order to join the general discussion
99 list for @AUCTeX{}. Articles should be sent to @email{auctex@@gnu.org}.
100 In a similar way, you can subscribe to the @email{info-auctex@@gnu.org}
101 list for just getting important announcements about @AUCTeX{}. The list
102 @email{bug-auctex@@gnu.org} is for bug reports which you should usually
103 file with the @kbd{M-x TeX-submit-bug-report @key{RET}} command. If you
104 want to address the developers of @AUCTeX{} themselves with technical
105 issues, they can be found on the discussion list
106 @email{auctex-devel@@gnu.org}.