auctex / doc / intro.texi

@include macros.texi
@ifset rawfile
@chapheading Introduction to @AUCTeX{}
@end ifset

@ifclear rawfile
@node Introduction, Installation, Copying, top
@chapter Introduction to @AUCTeX{}
@end ifclear

@ifset rawfile
This file
@end ifset
@ifclear rawfile
This section of the @AUCTeX{} manual
@end ifclear
gives a brief overview of what @AUCTeX{} is.  It is @strong{not} an
attempt to document @AUCTeX{}.  Real documentation for @AUCTeX{} is
available in the
@ifset rawfile
manual, which should be available as an info file after installation.
@end ifset
@ifclear rawfile
rest of the manual.
@end ifclear

@section Installation

Read the
@ifset rawfile
@file{INSTALL} or @file{} file
@end ifset
@ifclear rawfile
section @ref{Installation}, or @ref{Installation under MS Windows},
@end ifclear
respectively for comprehensive information about how to install

The installation routine tries to make the modes provided by @AUCTeX{}
the default for all supported file types.  If this does not happen in
your case, add
(load "auctex.el" nil t t)
@end lisp
to your init file and consult the section
@ifset rawfile
about loading the package in the @file{INSTALL} file.
@end ifset
@ifclear rawfile
@ref{Loading the package}.
@end ifclear

If you want to change the modes for which it is operative instead of the
default, use
@kbd{M-x customize-variable RET TeX-modes RET}
@end example

If you want to remove a preinstalled @AUCTeX{} completely before any of
its modes have been used,
(unload-feature 'tex-site)
@end example
should accomplish that.

If you are considering upgrading @AUCTeX{}, the recent changes are
described in
@ifset rawfile
the @file{CHANGES} file.
@end ifset
@ifclear rawfile
@end ifclear

@section Features

@AUCTeX{} is a comprehensive customizable integrated environment for
writing input files for @TeX{}/@LaTeX{}/@ConTeXt{}/Texinfo using Emacs
or XEmacs.

It lets you process your source files by running @TeX{} and related
tools (such as output filters, post processors for generating indices
and bibliographies, and viewers) from inside Emacs.  @AUCTeX{} lets you
browse through the errors @TeX{} reported, while it moves the cursor
directly to the reported error, and displays some documentation for that
particular error.  This will even work when the document is spread over
several files.

One component of @AUCTeX{} that @LaTeX{} users will find attractive is
@previewlatex{}, a combination of folding and in-source previewing
that provides true ``What You See Is What You Get'' experience in your
sourcebuffer, while letting you retain full control.  @previewlatex{}
comes with its own manual, see @ref{Top, , preview-latex,
preview-latex, The @previewlatex{} Manual}.
@ifset rawfile
For more information, see further below.
@end ifset

@AUCTeX{} automatically indents your `@LaTeX{}-source', not only as you
write it --- you can also let it indent and format an entire document.
It has a special outline feature, which can greatly help you `getting an
overview' of a document.

Apart from these special features, @AUCTeX{} provides a large range of
handy Emacs macros, which in several different ways can help you write
your documents fast and painlessly.

All features of @AUCTeX{} are documented using the GNU Emacs online
documentation system.  That is, documentation for any command is just
a key click away!

@AUCTeX{} is written entirely in Emacs-Lisp, and hence you can easily
add new features for your own needs.  It has become recently a GNU
project.  @AUCTeX{} is distributed under the `GNU General Public License
Version 2'.

@section Availability

The most recent version is always available at

@end flushright

WWW users may want to check out the @AUCTeX{} page at

@end flushright

@section Contacts

Various mailing lists exist.

Send a mail with the subject ``subscribe'' to
@email{} in order to join the general discussion
list for @AUCTeX{}.  Articles should be sent to @email{}.
In a similar way, you can subscribe to the @email{}
list for just getting important announcements about @AUCTeX{}.  The list
@email{} is for bug reports which you should usually
file with the @kbd{M-x TeX-submit-bug-report RET} command.

If you want to address the developers of @AUCTeX{} themselves with
technical issues, they can be found on the discussion list
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.