code.delx.au - gnu-emacs-elpa/blob - packages/auctex/doc/intro.texi

   1 @include macros.texi
   2 @ifset rawfile
   3 @paragraphindent none
   4 This is the README file for the AUCTeX distribution.
   5
   6 @quotation
   7 Copyright (C) 2008 Free Software Foundation, Inc.
   8
   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.
  12 @end quotation
  13
  14 @chapheading Introduction to @AUCTeX{}
  15 @end ifset
  16
  17 @ifclear rawfile
  18 @node Summary
  19 @chapter Overview of @AUCTeX{}
  20 @end ifclear
  21
  22 @ifset rawfile
  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.
  27 @end ifset
  28
  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.
  32
  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.
  38
  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.
  46
  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.
  51 @ifset rawfile
  52 For more information, see further below.
  53 @end ifset
  54
  55 More detailed information about the features and usage of @AUCTeX{} can
  56 be found in the
  57 @ifset rawfile
  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.
  61 @end ifset
  62 @ifclear rawfile
  63 remainder of this manual.
  64 @end ifclear
  65
  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'.
  69
  70 The most recent version is always available at
  71 @url{http://ftp.gnu.org/pub/gnu/auctex/}.
  72
  73 WWW users may want to check out the @AUCTeX{} page at
  74 @url{http://www.gnu.org/software/auctex/}.
  75
  76 For comprehensive information about how to install @AUCTeX{}
  77 @ifset rawfile
  78 read the file @file{INSTALL} or @file{INSTALL.windows}, respectively.
  79 @end ifset
  80 @ifclear rawfile
  81 @xref{Installation}, or @ref{Installation under MS Windows},
  82 respectively.
  83 @end ifclear
  84
  85 If you are considering upgrading @AUCTeX{}, the recent changes are
  86 described in
  87 @ifset rawfile
  88 the @file{CHANGES} file.
  89 @end ifset
  90 @ifclear rawfile
  91 @ref{Changes}.
  92 @end ifclear
  93
  94 If you want to discuss @AUCTeX{} with other users or its developers,
  95 there are several mailing lists you can use.
  96
  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}.