[AUCTeX-diffs] Changes to auctex/doc/auctex.texi,v

[Ralf Angeli]

CVSROOT:        /cvsroot/auctex
Module name:    auctex
Changes by:     Ralf Angeli <angeli>    10/02/13 14:16:37

Index: auctex.texi
===================================================================
RCS file: /cvsroot/auctex/auctex/doc/auctex.texi,v
retrieving revision 1.300
retrieving revision 1.301
diff -u -b -r1.300 -r1.301
--- auctex.texi 26 Dec 2009 15:36:34 -0000      1.300
+++ auctex.texi 13 Feb 2010 14:16:37 -0000      1.301
@@ -13,7 +13,7 @@
 a sophisticated TeX environment for Emacs.
 
 Copyright @copyright{} 1992, 1993, 1994, 1995, 2001, 2002, 2004, 2005,
-2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
@@ -2428,29 +2428,59 @@
 @end deffn
 
 @AUCTeX{} also allows you to easily select different @TeX{} engines for
-processing.
+processing, either by using the entries in the @samp{TeXing Options}
+submenu below the @samp{Command} menu or by calling the function
address@hidden  These eventually set the variable
address@hidden which you can also modify directly.
 
 @defopt TeX-engine
 This variable allows you to choose which @TeX{} engine should be used
 for typesetting the document, i.e. the executables which will be used
 when you invoke the @samp{TeX} or @samp{LaTeX} commands.  The value
-should be one of the symbols @code{default} for plain old @TeX{} or
address@hidden, @code{xetex} for address@hidden and @code{omega} for Omega.
+should be one of the symbols defined in @code{TeX-engine-alist-builtin}
+or @code{TeX-engine-alist}.  The symbols @samp{default}, @samp{xetex},
address@hidden and @samp{omega} are available from the built-in list.
 @end defopt
 
+Note that @code{TeX-engine} is buffer-local, so setting the variable
+directly or via the above mentioned menu or function will not take
+effect in other buffers.  If you want to activate an engine for all
address@hidden modes, set @code{TeX-engine} in your init file, e.g. by using
address@hidden customize-variable <RET>}.  If you want to activate it for a
+certain @AUCTeX{} mode only, set the variable in the respective mode
+hook.  If you want to activate it for certain files, set it through file
+variables (@pxref{File Variables,,,emacs,The Emacs Editor}).
+
 @vindex TeX-command
 @vindex LaTeX-command
address@hidden TeX-XeTeX-command
address@hidden LaTeX-XeTeX-command
 @vindex TeX-Omega-command
 @vindex LaTeX-Omega-command
 @vindex ConTeXt-engine
 @vindex ConTeXt-Omega-engine
-The executables related to the different @TeX{} engines are specified in
-the variables @code{TeX-command}, @code{LaTeX-command},
address@hidden, @code{LaTeX-XeTeX-command},
address@hidden, @code{LaTeX-Omega-command},
address@hidden and @code{ConTeXt-Omega-engine} respectively.
address@hidden TeX-engine-alist
address@hidden TeX-engine-alist-builtin
+Should you need to change the executable names related to the different
+engine settings, there are some variables you can tweak.  Those are
address@hidden, @code{LaTeX-command}, @code{TeX-Omega-command},
address@hidden, @code{ConTeXt-engine} and
address@hidden  The rest of the executables is defined
+directly in @code{TeX-engine-alist-builtin}.  If you want to override an
+entry from that, add an entry to @code{TeX-engine-alist} that starts
+with the same symbol as that the entry in the built-in list and specify
+the executables you want to use instead.  You can also add entries to
address@hidden in order to add support for engines not covered
+per default.
+
address@hidden TeX-engine-alist
+Alist of TeX engines and associated commands.  Each entry is a list with
+a maximum of five elements.  The first element is a symbol used to
+identify the engine.  The second is a string describing the engine.  The
+third is the command to be used for plain TeX.  The fourth is the
+command to be used for LaTeX.  The fifth is the command to be used for
+the @samp{--engine} parameter of ConTeXt's @samp{texexec} program.  Each
+command can either be a variable or a string.  An empty string or nil
+means there is no command available.
address@hidden defopt
 
 You can customize @AUCTeX{} to show the processor output as it is
 produced.