branch: main
commit 203de05f501cd27e79c0ae05436227b7b9101d77
Author: Ikumi Keita <ik...@ikumi.que.jp>
Commit: Ikumi Keita <ik...@ikumi.que.jp>
Revise document for main branch
Discard instructions for configure&make installation.
Discard mentions on CAPITAL name files like INSTALL, CHANGES.
Arrange description about `use-package' usage.
---
README.GIT | 20 +-
doc/changes.texi | 10 +-
doc/faq.texi | 62 ++----
doc/install.texi | 508 ++++------------------------------------------
doc/intro.texi | 26 +--
doc/preview-faq.texi | 22 +-
doc/preview-problems.texi | 24 ---
doc/preview-readme.texi | 20 +-
doc/quickstart.texi | 30 +--
doc/todo.texi | 17 +-
doc/wininstall.texi | 362 ---------------------------------
11 files changed, 94 insertions(+), 1007 deletions(-)
diff --git a/README.GIT b/README.GIT
index b33747cf..8b1b27a3 100644
--- a/README.GIT
+++ b/README.GIT
@@ -1,20 +1,22 @@
Organization of the repository
******************************
-This repository has currently three branches:
+This repository has several branches:
* 'main': the main branch of development of AUCTeX;
* 'master': the old main branch of development of AUCTeX; not used
anymore;
+Other branches are feature branches. They are created and deleted from
+time to time. To name a few:
+
* 'simplify-TeX-parse-error': a feature branch for improving parsing
of TeX logs;
* 'gendocspatch': keeps a patch to build on-line manuals and is
- intended to be used only by AUCTeX maintainers. Unless you are one
- of them and know how to handle it, you really do not want to pull
- this branch as it will be rebased frequently.
+ intended to be used only by AUCTeX maintainers. Obsoleted by
+ introduction of the 'main' branch.
Installation information
************************
@@ -22,11 +24,11 @@ Installation information
If you retrieved AUCTeX via Git instead of as a regular release, there
are some files that need to be generated from their respective source
files before you can continue reasonably with the instructions
-detailed in the README and INSTALL files (which will not be present
-otherwise).
+detailed in the README file (which will not be present otherwise).
Run "make" in order to do that. This will also generate the respective
-files for the preview subsystem.
+files for the preview subsystem. Be sure to use GNU make, otherwise it
+will fail.
-You will need to have a working and rather current copy of `makeinfo',
-`autoconf' and of `perl'.
+You will need to have a working and rather current copy of `makeinfo'
+and `perl'.
diff --git a/doc/changes.texi b/doc/changes.texi
index 496aa799..2ca681bd 100644
--- a/doc/changes.texi
+++ b/doc/changes.texi
@@ -3,10 +3,6 @@
@c Foundation, Inc.
@c See file auctex.texi for copying conditions.
@include macros.texi
-@ifset rawfile
-@chapheading Changes and New Features in @AUCTeX{}
-
-@end ifset
@heading News in 14.1
@@ -1448,7 +1444,7 @@ More detailed information can be found in the
installation instructions
(file @file{INSTALL}).
@end ifset
@ifclear rawfile
-@xref{Loading the package}.
+@xref{Activating the package}.
@end ifclear
@item
@@ -1914,10 +1910,10 @@ it started.
The build process was enhanced and is now based on @code{autoconf}
making installing @AUCTeX{} a mostly automatic process. See
@ifset rawfile
-the files @file{INSTALL} and @file{INSTALL.windows}
+the files @file{INSTALL}@c and @file{INSTALL.windows}
@end ifset
@ifclear rawfile
-@ref{Installation} and @ref{Installation under MS Windows}
+@ref{Installation}@c and @ref{Installation under MS Windows}
@end ifclear
for details.
@end itemize
diff --git a/doc/faq.texi b/doc/faq.texi
index cd71ac95..b8bd4c7a 100644
--- a/doc/faq.texi
+++ b/doc/faq.texi
@@ -1,10 +1,6 @@
@c This is part of the AUCTeX Manual.
@c Copyright (C) 2004-2024 Free Software Foundation, Inc.
@c See the file auctex.texi for copying conditions.
-@ifset rawfile
-@include macros.texi
-@chapheading Frequently Asked Questions about @AUCTeX{}
-@end ifset
@c We should switch to sectioning commands instead of items when this
@c list grows. Keep in mind to formulate short questions because
@@ -19,11 +15,9 @@ issue, then come back here and proceed.
Well, you might have guessed it, the first place to look is in the
available documentation packaged with @AUCTeX{}. This could be the
-release notes (in the @file{RELEASE} file) or the news section of the
-manual in case you are experiencing problems after an upgrade, the
-@file{INSTALL} file in case you are having problems with the
-installation, the section about bugs in the manual in case you
-encountered a bug or the relevant sections in the manual for other
+@file{README} file or @file{NEWS.org} file in case you are experiencing
+problems after an upgrade, the section about bugs in the manual in case
+you encountered a bug or the relevant sections in the manual for other
related problems.
If this did not help, you can send a bug report to the @AUCTeX{} bug
@@ -48,29 +42,20 @@ in the bug report.
Second, you can try to figure out if something in your personal or site
configuration triggers the error by starting Emacs without such
customizations. You can do this by invoking Emacs with the following
-command line, depending on the installation scheme of @AUCTeX{} and your
-@acronym{OS}:
-@itemize
-@item
-If you installed @AUCTeX{} from @acronym{ELPA}, use @samp{emacs -q
--no-site-file --eval "(progn (setq package-load-list '((auctex t)))
-(package-initialize))"}. The @option{--eval} option activates only
-@AUCTeX{} among all installed @acronym{ELPA} packages.
-@item
-If you installed @AUCTeX{} via traditional
-@command{configure}--@command{make} scheme, use @samp{emacs -q
--no-site-file -l auctex}. The @option{-l} option loads @file{auctex.el}
-which you normally do in your init file.
-@item
-In both above cases, use @samp{runemacs} instead of @samp{emacs} on
-windows.
-@end itemize
+command line:
+@example
+emacs -q -no-site-file --eval "(progn (setq package-load-list '((auctex
+t))) (package-initialize))"
+@end example
+Use @samp{runemacs} instead of @samp{emacs} on @w{MS Windows}.
+
+The @option{--eval} option activates only @AUCTeX{} among all installed
+@acronym{ELPA} packages.
-After you
-have started Emacs like this, you can load the file triggering the
-error. If everything is working now, you know that you have to search
-either in the site configuration file or your personal init file for
-statements related to the problem.
+After you have started Emacs like this, you can load the file triggering
+the error. If everything is working now, you know that you have to
+search either in the site configuration file or your personal init file
+for statements related to the problem.
@item
@acronym{ELPA} upgrade fails. What should I do?
@@ -129,19 +114,6 @@ What versions of Emacs are supported?
@AUCTeX{} was tested with @w{GNU Emacs 27.1}. Older versions may work but
are unsupported.
-@item
-What should I do when @command{./configure} does not find programs like
@command{latex}?
-
-This is problem often encountered on Windows. Make sure that the
-@env{PATH} environment variable includes the directories containing the
-relevant programs, as described in
-@ifset rawfile
-the file @file{INSTALL.windows}
-@end ifset
-@ifclear rawfile
-@ref{Installation under MS Windows,,,auctex,the @AUCTeX{} manual}.
-@end ifclear
-
@item
Why doesn't the completion, style file, or multifile stuff work?
@@ -155,9 +127,7 @@ It must be enabled first, insert this in your init file:
Read also the chapters about parsing and multifile documents in the
manual.
-@ifclear rawfile
@xref{Parsing Files} and @ref{Multifile}.
-@end ifclear
@item
Why doesn't @code{TeX-save-document} work?
diff --git a/doc/install.texi b/doc/install.texi
index f76a85d3..d3e1c4a9 100644
--- a/doc/install.texi
+++ b/doc/install.texi
@@ -2,95 +2,41 @@
@c Copyright (C) 1994, 1996, 2003-2007, 2012-2013,
@c 2015-2024 Free Software Foundation, Inc.
@c See the file auctex.texi for copying conditions.
-@ifset rawfile
-@include macros.texi
-@node Installation,,(dir),(dir)
-@top Installing @AUCTeX{}
-@end ifset
-
-@ifclear rawfile
@node Installation
@chapter Installing @AUCTeX{}
-@end ifclear
-The modern and strongly recommended way of installing @AUCTeX{} is by
-using the Emacs package manager integrated in Emacs 24 and greater
-(@acronym{ELPA}). Simply do @kbd{M-x list-packages @key{RET}}, mark the
-auctex package for installation with @kbd{i}, and hit @kbd{x} to execute
-the installation procedure. That's all.
+@AUCTeX{} is a package distributed at @acronym{ELPA}, Emacs Lisp Package
+Archive. To install @AUCTeX{}, simply do @kbd{M-x list-packages
+@key{RET}}, mark the auctex package for installation with @kbd{i}, and
+hit @kbd{x} to execute the installation procedure. That's all.
+
+Caution. If you have installed former @AUCTeX{} as regular tarball
+release, uninstall it to avoid possible troubles.
@code{use-package} users can use this simple recipe in their
@code{user-init-file} which essentially does the same as the manual
installation explained above.
@lisp
-(use-package tex
- :ensure auctex)
+(use-package auctex
+ :ensure t)
@end lisp
-Using the @acronym{ELPA} version has several advantages. Besides being
-platform and @acronym{OS} independent, you will receive intermediate
-bugfix releases between major @AUCTeX{} releases conveniently. For past
-@acronym{ELPA} releases, see
+For past @acronym{ELPA} releases, see
@url{https://elpa.gnu.org/packages/auctex.html}.
-@ifclear rawfile
Once the installation is completed, you can skip the rest of this
section and proceed to @ref{Quick Start}.
-@end ifclear
-
-Installing @AUCTeX{} should be simple: merely @command{./configure},
-@command{make}, and @code{make install} for a standard site-wide
-installation (most other installations can be done by specifying a
-@option{--prefix=@dots{}} option).
-
-On many systems, this will already activate the package, making its
-modes the default instead of the built-in modes of Emacs. If this is
-not the case, consult @ref{Loading the package}. Please read through
-this document fully before installing anything. The installation
-procedure has changed as compared to earlier versions. Users of @w{MS
-Windows} are asked to consult
-@ifset rawfile
-the file @file{INSTALL.windows}.
-@end ifset
-@ifclear rawfile
-@xref{Installation under MS Windows}.
-@end ifclear
-
-@ifclear rawfile
-@menu
-* Prerequisites::
-* Configure::
-* Build/install and uninstall::
-* Loading the package::
-* Advice for package providers::
-* Advice for non-privileged users::
-* Installation under MS Windows::
-* Customizing::
-@end menu
-@end ifclear
-@ifset rawfile
@menu
* Prerequisites::
-* Configure::
-* Build/install and uninstall::
-* Loading the package::
+* Activating the package::
* Advice for package providers::
-* Advice for non-privileged users::
+* Using @AUCTeX{} from local Git repo::
* Customizing::
@end menu
-@end ifset
-
-@ifset rawfile
-@node Prerequisites
-@chapter Prerequisites
-@raisesections
-@end ifset
-@ifclear rawfile
@node Prerequisites
@section Prerequisites
-@end ifclear
@itemize @bullet
@item GNU Emacs 27.1 or higher
@@ -117,8 +63,7 @@ Instructions for checking out the source code can be found at
@item A working @TeX{} installation
-Well, @AUCTeX{} would be pointless without that. Processing
-documentation requires @TeX{}, @LaTeX{} and Texinfo during installation.
+Well, @AUCTeX{} would be pointless without that.
@previewlatex{} requires Dvips or @command{dvipng} for its operation in
@acronym{DVI} mode.
The default configuration of @AUCTeX{} is tailored for @w{@TeX{} Live}-based
distributions, but can be adapted easily.
@@ -128,226 +73,21 @@ distributions, but can be adapted easily.
This is needed for operation of @previewlatex{} in both @acronym{DVI}
and @acronym{PDF} mode. Ghostscript version 7.07 or newer is required.
-@item GNU make
-
-Recent @AUCTeX{} uses GNU make specific capabilities in the Makefiles.
-If your @acronym{OS}'s default @command{make} command is not GNU make,
-you have to obtain it in order to build @AUCTeX{} by yourself. GNU make
-is sometimes provided under the name @command{gmake} in your
-@acronym{OS}'s binary package system.
-
-@item The Texinfo package
-
-Strictly speaking, you can get away without it if you are building
-from the distribution tarball, have not modified any files and don't
-need a printed version of the manual: the pregenerated info file is
-included in the tarball. At least @w{version 4.0} is required.
-
@end itemize
For some known issues with various software, see
-@ifset rawfile
-the @file{PROBLEMS.preview} file.
-@end ifset
-@ifclear rawfile
@ref{Known problems,,,preview-latex,the @previewlatex{} manual}.
-@end ifclear
-
-@node Configure
-@section Configure
-
-The first step is to configure the source code, telling it where
-various files will be. To do so, run
-
-@example
-./configure @var{options}
-@end example
-
-(Note: if you have fetched @AUCTeX{} from Git rather than
-a regular release, you will have to first follow the instructions in
-@file{README.GIT}).
-
-On many machines, you will not need to specify any options, but if
-@command{configure} cannot determine something on its own, you'll need to
-help it out with one of these options:
-
-@table @code
-@item --prefix=@var{prefix}
-All automatic placements for package components will be chosen from
-sensible existing hierarchies below this: directories like @file{man},
-@file{share} and @file{bin} are supposed to be directly below
-@var{prefix}.
-
-Only if no workable placement can be found there, in some cases an
-alternative search will be made in a prefix deduced from a suitable
-binary.
-
-@file{/usr/local} is the default @var{prefix}, intended to be suitable
-for a site-wide installation. If you are packaging this as an
-operating system component for distribution, the setting @file{/usr}
-will probably be the right choice. See @ref{Advice for package
-providers} for detail.
-
-If you are planning to install the package as a single non-priviledged
-user, you will typically set @var{prefix} to your home directory.
-Consult @ref{Advice for non-privileged users} for additional
-instructions.
-
-@item --with-emacs=@var{/path/to/emacs}
-If you are using a pretest which isn't in your @env{PATH}, or
-@command{configure} is not finding the right Emacs executable, you can
-specify it with this option.
-
-@item --with-lispdir=@var{lispdir}
-This option specifies the location of the @file{site-lisp}
-directory within @code{load-path} under which the files will get
-installed (the bulk will get installed in a subdirectory).
-@command{./configure} should figure this out by itself.
-
-@item --with-auctexstartfile=@file{auctex.el}
-@itemx --with-previewstartfile=@file{preview-latex.el}
-This is the name of the respective startup files. If @var{lispdir}
-contains a subdirectory @file{site-start.d}, the start files are
-placed there, and @file{site-start.el} should
-load them automatically. Please be aware that you must not move the
-start files after installation since other files are found
-@emph{relative} to them.
-
-@item --with-packagelispdir=@file{auctex}
-This is the directory where the bulk of the package gets located. The
-startfile adds this into @code{load-path}.
-
-@item --with-auto-dir=@var{/dir}
-You can use this option to specify the directory containing
-automatically generated information by @kbd{M-x TeX-auto-generate-global
@key{RET}}. It is not necessary for most
-@TeX{} installs, but may be used if you don't like the directory that
-configure is suggesting.
-
-@item --help
-This is not an option specific to @AUCTeX{}. A number of standard
-options to @command{configure} exist, and we do not have the room to
-describe them here; a short description of each is available, using
-@option{--help}.
-
-@c FIXME: It seems this no longer holds.
-@c If you use @samp{--help=recursive}, then also @previewlatex{}-specific
-@c options will get listed.
-
-@item --disable-preview
-This disables configuration and installation of @previewlatex{}. This
-option is not actually recommended. If your Emacs does not support
-images, you should really upgrade to a newer version. Distributors
-should, if possible, refrain from distributing @AUCTeX{} and
-@previewlatex{} separately in order to avoid confusion and upgrade
-hassles if users install partial packages on their own.
-
-@item --with-texmf-dir=@var{/dir}
-@itemx --without-texmf-dir
-@cindex preview-install-styles
-This option is used for specifying a @acronym{TDS}-compliant directory
-hierarchy. Using @code{--with-texmf-dir=@var{/dir}} you can specify
-where the @TeX{} @acronym{TDS} directory hierarchy resides, and the
-@TeX{} files will get installed in
-@file{@var{/dir}/tex/latex/preview/}.
-
-If you use the @option{--without-texmf-dir} option, the @TeX{}-related
-files will be kept in the Emacs Lisp tree, and at runtime the
-@env{TEXINPUTS} environment variable will be made to point there. You
-can install those files into your own @TeX{} tree at some later time
-with @kbd{M-x preview-install-styles @key{RET}}.
-
-@item --with-tex-dir=@var{/dir}
-If you want to specify an exact directory for the preview @TeX{} files,
-use @code{--with-tex-dir=@var{/dir}}. In this case, the files will be
-placed in @file{@var{/dir}}, and you'll also need the following option:
-
-@item --with-doc-dir=@var{/dir}
-This option may be used to specify where the @TeX{} documentation goes.
-It is to be used when you are using @code{--with-tex-dir=@var{/dir}},
-but is normally not necessary otherwise.
-@end table
-
-@node Build/install and uninstall
-@section Build/install and uninstall
-@cindex Installation
-@cindex Make
-@cindex Uninstallation
-
-Once @command{configure} has been run, simply enter
-
-@example
-make
-@end example
-
-@noindent
-at the prompt to byte-compile the lisp files, extract the @TeX{} files
-and build the documentation files. To install the files into the
-locations chosen earlier, type
-
-@example
-make install
-@end example
-
-@noindent
-You may need special privileges to install, e.g., if you are installing
-into system directories.
-
-Should you want to completely remove the installed package, in the same
-directory you built @AUCTeX{} run
-
-@example
-make uninstall
-@end example
-
-@noindent
-You will need administration privileges if you installed the package
-into system directories.
-
-@node Loading the package
-@section Loading the package
-@cindex @file{init.el}
-@cindex @file{.emacs}
+@node Activating the package
+@section Activating the package
You can detect the successful activation of @AUCTeX{} and
@previewlatex{} in the menus after loading a @LaTeX{} file like
@file{circ.tex}: @AUCTeX{} then gives you a @samp{Command} menu,
and @previewlatex{} gives you a @samp{Preview} menu.
-@cindex @file{auctex.el}
-@cindex @file{tex-site.el}
-With Emacs (or if you explicitly disabled use of the package system),
-the startup files @file{auctex.el} and @file{preview-latex.el} may
-already be in a directory of the @file{site-start.d/} variety if your
-Emacs installation provides it. In that case they should be
-automatically loaded on startup and nothing else needs to be done. If
-not, they should at least have been placed somewhere in your
-@code{load-path}. You can then load them by placing the lines
-
-@lisp
-(load "auctex.el" nil t t)
-(load "preview-latex.el" nil t t)
-@end lisp
-@noindent
-into your init file such as @file{init.el} or @file{.emacs}.
-
-If you explicitly used @code{--with-lispdir}, you may need to add the
-specified directory into Emacs' @code{load-path} variable by adding
-something like
-
-@lisp
-(add-to-list 'load-path "~/elisp")
-@end lisp
-@noindent
-before the above lines into your Emacs startup file.
-
For site-wide activation in GNU Emacs, see
-@ifset rawfile
-below.
-@end ifset
-@ifclear rawfile
@xref{Advice for package providers}.
-@end ifclear
Once activated, the modes provided by @AUCTeX{} are used per default for
all supported file types, namely @code{plain-tex-mode}, @code{latex-mode},
@@ -384,15 +124,9 @@ use it, you can disable it by
(push '(auctex nil) package-load-list)
@end lisp
@noindent
-in your early init file (@pxref{Early Init File,,,emacs}) for
-@acronym{ELPA} installation, or
-@lisp
-(unload-feature 'tex-site)
-@end lisp
-@noindent
-in your (standard) init file for configure--make installation. (We
-recommend those treatments over setting @code{TeX-modes} to @code{nil},
-because they don't leave unused autoloads persisted.)
+in your early init file (@pxref{Early Init File,,,emacs}). (We
+recommend this treatment over setting @code{TeX-modes} to @code{nil},
+because it doesn't leave unused autoloads persisted.)
@node Advice for package providers
@section Providing @AUCTeX{} as a package
@@ -406,163 +140,20 @@ There are people that prefer the built-in Emacs modes
for editing
@TeX{} files, in particular plain @TeX{} users. There are various
ways to tell @AUCTeX{} even after auto-activation that it should
not get used, and they are described in
-@c FIXME: It doesn't seem that these references discuss this topic.
-@ifset rawfile
-the @file{README} file.
-@end ifset
-@ifclear rawfile
-@ref{Introduction,,Introduction to @AUCTeX{}}.
-@end ifclear
+the @ref{Activating the package, previous node}.
So if you have users that don't want to use the preinstalled @AUCTeX{},
-they can easily get rid of it. Activating @AUCTeX{} by default is
-therefore a good choice.
+they can easily get rid of it. Installing @AUCTeX{} as site-wide
+default is therefore a good choice.
-First of all, you can install @acronym{ELPA} @AUCTeX{} package under a
+You can install @acronym{ELPA} @AUCTeX{} package under a
directory listed in @code{package-directory-list} to have site-wide
default.
-Next, we discuss configure--make installation.
-
-If the installation procedure did not achieve this already by placing
-@file{auctex.el} and @file{preview-latex.el} into a possibly existing
-@file{site-start.d} directory, you can do this by placing
-
-@lisp
-(load "auctex.el" nil t t)
-(load "preview-latex.el" nil t t)
-@end lisp
-
-@noindent in the system-wide @file{site-start.el}.
-
-The @option{--without-texmf-dir} option can be convenient for systems that
-are intended to support more than a single TeX distribution. Since more
-often than not @TeX{} packages for operating system distributions are
-either much more outdated or much less complete than separately provided
-systems like @w{@TeX{} Live}, this method may be generally preferable
-when providing packages.
-
-The following package structure would be adequate for a typical fully
-supported Unix-like installation:
-
-@c FIXME: teTeX is much outdated now.
-@table @samp
-@item preview-tetex
-Style files and documentation for @file{preview.sty}, placed into a
-@TeX{} tree where it is accessible from the te@TeX{} executables usually
-delivered with a system. If there are other commonly used @TeX{} system
-packages, it might be appropriate to provide separate packages for
-those.
-@item auctex-emacs-tetex
-This package will require the installation of @samp{preview-tetex} and
-will record in @code{TeX-macro-global} where to find the @TeX{} tree.
-It is also a good idea to run
-@example
-emacs -batch -f TeX-auto-generate-global
-@end example
-when either @AUCTeX{} or te@TeX{} get installed or upgraded. If your
-users might want to work with a different @TeX{} distribution (nowadays
-pretty common), instead consider the following:
-@item auctex-emacs
-This package will be compiled with @option{--without-texmf-dir} and will
-consequently contain the @samp{preview} style files in its private
-directory. It will probably not be possible to initialize
-@code{TeX-macro-global} to a sensible value, so running
-@code{TeX-auto-generate-global} does not appear useful. This package
-would neither conflict with nor provide @samp{preview-tetex}.
-@end table
-
-@node Advice for non-privileged users
-@section Installation for non-privileged users
-
-Often people without system administration privileges want to install
-software for their private use. In that case you need to pass more
-options to the @command{configure} script.
-
-The main expedient is using the @option{--prefix} option to the
-@command{configure} script, and let it point to the personal home
-directory. In that way, resulting binaries will be installed under the
-@file{bin} subdirectory of your home directory, manual pages under
-@file{man} and so on. It is reasonably easy to maintain a bunch of
-personal software, since the prefix argument is supported by most
-@command{configure} scripts.
-
-You often need to specify @option{--with-lispdir} option as well.
-If you haven't installed Emacs under your home directory and use Emacs
-installed in system directories, the @command{configure} script might not
-be able to figure out suitable place to install lisp files under your
-home directory. In that case, the @command{configure} script would
-silently choose, by default, the @file{site-lisp} directory within
-@code{load-path} for the place, where administration privileges are
-usually required to put relevant files. Thus you will have to tell
-the @command{configure} script explicitly where to put those files by,
-e.g., @code{--with-lispdir=@samp{/home/myself/share/emacs/site-lisp}}.
-
-You'll have to add something like
-@samp{/home/myself/share/emacs/site-lisp} to your @code{load-path}
-variable, if it isn't there already.
-
-In addition, you will have to tell @command{configure} script where to
-install @TeX{}-related files such as @file{preview.sty} if
-@previewlatex{} isn't disabled. It is enough to specify
-@option{--with-texmf-dir=@file{$HOME/texmf}} for most typical cases, but
-you have to create the direcotry @file{$HOME/texmf} in advance if it
-doesn't exist. If this prescription doesn't work, consider using one or
-more of the options @code{--with-texmf-dir=@var{/dir}},
-@code{--without-texmf-dir}, @code{--with-tex-dir=@var{/dir}} and
-@code{--with-doc-dir=@var{/dir}}. See @ref{Configure} for detail of
-these options.
-
-Now here is another thing to ponder: perhaps you want to make it easy
-for other users to share parts of your personal Emacs configuration. In
-general, you can do this by writing @samp{~myself/} anywhere where you
-specify paths to something installed in your personal subdirectories,
-not merely @samp{~/}, since the latter, when used by other users, will
-point to non-existent files.
-
-For yourself, it will do to manipulate environment variables in your
-@file{.profile} resp.@: @file{.login} files. But if people will be
-copying just Elisp files, their copies will not work. While it would
-in general be preferable if the added components where available from
-a shell level, too (like when you call the standalone info reader, or
-try using @file{preview.sty} for functionality besides of Emacs
-previews), it will be a big help already if things work from inside
-of Emacs.
-
-Here is how to do the various parts:
-
-@subheading Making the Elisp available
-
-In GNU Emacs, it should be sufficient if people just do
+@node Using @AUCTeX{} from local Git repo
+@section Using @AUCTeX{} from local Git repo
-@lisp
-(load "~myself/share/emacs/site-lisp/auctex.el" nil t t)
-(load "~myself/share/emacs/site-lisp/preview-latex.el" nil t t)
-@end lisp
-@noindent
-where the path points to your personal installation. The rest of the
-package should be found relative from there without further ado.
-
-@subheading Making the Info files available
-
-For making the info files accessible from within Elisp, something like
-the following might be convenient to add into your or other people's
-startup files:
-
-@lisp
-(eval-after-load 'info
- '(add-to-list 'Info-directory-list "~myself/info"))
-@end lisp
-
-@subheading Making the @LaTeX{} style available
-
-If you want others to be able to share your installation, you should
-configure it using @option{--without-texmf-dir}, in which case things
-should work as well for them as for you.
-
-@subsection Using @AUCTeX{} from local Git repo
-
-With the techniques described above, it is also possible to use @AUCTeX{}
+It is also possible to use @AUCTeX{}
directly from a local Git repository. Let's assume you have your Git
repositories under @samp{~/development/}.
@@ -573,50 +164,33 @@ git clone https://git.savannah.gnu.org/git/auctex.git
@end example
Now change directory to @samp{~/development/auctex} and run
-@samp{./autogen.sh}. Next thing is to run @command{configure} like this:
-@example
-./configure --without-texmf-dir --with-lispdir=.
-@end example
-
-@noindent
-When finished, simply enter
@example
make
@end example
@noindent
-and you're finished. Note that the @samp{make install} step is not
-necessary.
-Now you have to tell Emacs about the plan. The following variables must
-be set in your init file because their normal values are only correct when
-@AUCTeX{} is installed:
+Now you have to tell Emacs about the plan. Put the following code
+in your init file:
@lisp
-(setq TeX-data-directory "~/development/auctex"
- TeX-lisp-directory TeX-data-directory)
+(load "~/development/auctex/auctex-autoloads.el" nil t t)
+(with-eval-after-load 'info
+ (add-to-list 'Info-additional-directory-list
+ "~/development/auctex/doc/"))
@end lisp
-
@noindent
-The info files will be available with this:
-@lisp
-(eval-after-load 'info
- '(add-to-list 'Info-additional-directory-list
- "~/development/auctex/doc"))
-@end lisp
+and you're finished.
-@noindent
-Now you're ready to load @file{auctex.el} and @file{preview-latex.el} out
-of this directory:
+Note for @samp{use-package} users: you can wrap the above recipe with
+@code{use-package} like this:
@lisp
-(load "~/development/auctex/auctex.el" nil t t)
-(load "~/development/auctex/preview-latex.el" nil t t)
+(use-package auctex
+ :init
+ (load "~/development/auctex/auctex-autoloads.el" nil t t)
+ (with-eval-after-load 'info
+ (add-to-list 'Info-additional-directory-list
+ "~/development/auctex/doc")))
@end lisp
-@ifclear rawfile
-@node Installation under MS Windows
-@section Installation under MS Windows
-@include wininstall.texi
-@end ifclear
-
@node Customizing
@section Customizing
@cindex Site initialization
@@ -628,7 +202,7 @@ of this directory:
@cindex Customization, personal
@cindex Customization, site
Most of the site-specific customization should already have happened
-during configuration of @AUCTeX{}. Any further customization can be
+during installation of @AUCTeX{}. Any further customization can be
done with customization buffers directly in Emacs. Just type @kbd{M-x
customize-group @key{RET} AUCTeX @key{RET}} to open the customization group for
@AUCTeX{} or use the menu entries provided in the mode menus. Editing
diff --git a/doc/intro.texi b/doc/intro.texi
index 0bbf7399..f9533a9a 100644
--- a/doc/intro.texi
+++ b/doc/intro.texi
@@ -4,7 +4,7 @@
This is the README file for the AUCTeX distribution.
@quotation
-Copyright (C) 2008, 2017, 2018 Free Software Foundation, Inc.
+Copyright (C) 2008, 2017, 2018, 2024 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice
@@ -56,8 +56,7 @@ More detailed information about the features and usage of
@AUCTeX{} can
be found in the
@ifset rawfile
@AUCTeX{} manual. You can access it from within Emacs by typing
-@kbd{C-h i d m auctex @key{RET}}. If you prefer the standalone info
-reader, issue the command @code{info auctex} in a terminal.
+@kbd{C-h i d m auctex @key{RET}}.
@end ifset
@ifclear rawfile
remainder of this manual.
@@ -67,25 +66,20 @@ remainder of this manual.
add new features for your own needs. It is a GNU project and
distributed under the `GNU General Public License Version 3'.
-The most recent version is always available at
-@url{https://ftp.gnu.org/pub/gnu/auctex/}.
-
-WWW users may want to check out the @AUCTeX{} page at
-@url{https://www.gnu.org/software/auctex/}.
-
-For comprehensive information about how to install @AUCTeX{}
-@ifset rawfile
-read the file @file{INSTALL} or @file{INSTALL.windows}, respectively.
-@end ifset
+@AUCTeX{} is a package distributed at @acronym{ELPA}, Emacs Lisp Package
+Archive. You can manage it in Emacs package manager.
@ifclear rawfile
-@xref{Installation}, or @ref{Installation under MS Windows},
-respectively.
+(@pxref{Packages,,,emacs})
@end ifclear
+WWW users may want to check out the @AUCTeX{} page at
+@url{https://www.gnu.org/software/auctex/} and
+@url{https://elpa.gnu.org/packages/auctex.html}.
+
If you are considering upgrading @AUCTeX{}, the recent changes are
described in
@ifset rawfile
-the @file{CHANGES} file.
+the @file{NEWS.org} file.
@end ifset
@ifclear rawfile
@ref{Changes}.
diff --git a/doc/preview-faq.texi b/doc/preview-faq.texi
index 38044af6..6d2db6fc 100644
--- a/doc/preview-faq.texi
+++ b/doc/preview-faq.texi
@@ -1,17 +1,7 @@
@c This is part of the preview-latex manual.
@c Copyright (C) 2002, 2003, 2004, 2005, 2006, 2009
-@c 2017, 2021-2023 Free Software Foundation, Inc.
+@c 2017, 2021-2024 Free Software Foundation, Inc.
@c See file preview-latex.texi for copying conditions.
-@ifset rawfile
-@include macros.texi
-
-@node Frequently Asked Questions, Introduction to FAQ, (dir), (dir)
-@top Frequently Asked Questions about @previewlatex{}
-
-@contents
-
-@end ifset
-
@menu
* Introduction to FAQ::
* Requirements::
@@ -21,18 +11,8 @@
* Other formats::
@end menu
-@comment we need at least one chapter, or the numbers disappear in the
-@comment plain version of the FAQ.
-
-@ifset rawfile
-@node Introduction to FAQ, Requirements, Frequently Asked Questions,
Frequently Asked Questions
-@chapter Introduction
-@raisesections
-@end ifset
-@ifclear rawfile
@node Introduction to FAQ, Requirements, Frequently Asked Questions,
Frequently Asked Questions
@section Introduction
-@end ifclear
@subsection How can I contribute to the FAQ?
diff --git a/doc/preview-problems.texi b/doc/preview-problems.texi
index 57a1a185..ab3fe799 100644
--- a/doc/preview-problems.texi
+++ b/doc/preview-problems.texi
@@ -1,11 +1,4 @@
@include macros.texi
-@ifset rawfile
-@c documentencoding is used by makeinfo in our --no-headers output.
-@documentencoding ISO-8859-1
-@node Known problems,,(dir),(dir)
-@top Known problems with preview-latex
-
-@end ifset
@c -----------------------
@c @cindex @kbd{M-x preview-report-bug @key{RET}}
@c @cindex @code{preview-report-bug}
@@ -29,15 +22,8 @@ information interesting to us and send it to the
@email{bug-auctex@@gnu.org} list. Please use the bug reporting commands
if at all possible.
-@ifset rawfile
-@node Font problems with Dvips
-@chapter Font problems with Dvips
-@raisesections
-@end ifset
-@ifclear rawfile
@node Font problems with Dvips
@section Font problems with Dvips
-@end ifclear
Some fonts have been reported to produce wrong characters with
@previewlatex{}. @previewlatex{} calls Dvips by default with the option
@@ -80,12 +66,7 @@ avoiding drawing outside of the picture with PSTricks.
One possible remedy is to set
@code{preview-fast-conversion} to `Off'
-@ifset rawfile
-(see the manual).
-@end ifset
-@ifclear rawfile
(@pxref{The Emacs interface}).
-@end ifclear
The conversion will take more time, but will then use the bounding boxes
from @acronym{EPS} files generated by Dvips.
@@ -93,12 +74,7 @@ Dvips generally does not miss things, but it does not
understand
PostScript constructs like @code{\resizebox} or @code{\rotate} commands,
so will generate rather wrong boxes for those. Dvips can be helped with
the @code{psfixbb} package option to preview
-@ifset rawfile
-(see the manual),
-@end ifset
-@ifclear rawfile
(@pxref{The LaTeX style file}),
-@end ifclear
which will tag the corners of the included @TeX{} box. This will mostly
be convenient for @emph{pure} PostScript stuff like that created by
PSTricks, which Dvips would otherwise reserve no space for.
diff --git a/doc/preview-readme.texi b/doc/preview-readme.texi
index c404d005..afda64db 100644
--- a/doc/preview-readme.texi
+++ b/doc/preview-readme.texi
@@ -56,18 +56,10 @@ the background and providing fast interactive response.
@node Activating preview-latex, Getting started, What use is it?, Introduction
@section Activating @previewlatex{}
@cindex Activation
-After installation, the package may need to be activated (and remember
-to activate @AUCTeX{} too). If @previewlatex{} is installed via the
-Emacs package manager (@acronym{ELPA}), activation should be automatic
-upon installation.
+Successful installation automatically activates the package at Emacs
+startup.
-The usual activation (if it is not done automatically) would be
-
-@example
-(load "preview-latex.el" nil t t)
-@end example
-
-If you still don't get a ``Preview'' menu in @LaTeX{} mode in spite
+If you don't get a ``Preview'' menu in @LaTeX{} mode in spite
of @AUCTeX{} showing its ``Command'', your installation is broken. One
possible cause are duplicate Lisp files that might be detectable with
@kbd{M-x list-load-path-shadows @key{RET}}.
@@ -219,8 +211,10 @@ list available to which you can subscribe by sending a
mail with
Offers to support further development will be appreciated. If you want
to show your appreciation with a donation to the main developer, you can
do so via PayPal to @email{dak@@gnu.org}, and of course you can arrange
-for service contracts or for added functionality. Take a look at the
-@file{TODO} list for suggestions in that area.
+for service contracts or for added functionality.
+@ifclear rawfile
+Take a look at the @ref{ToDo} list for suggestions in that area.
+@end ifclear
@c Local Variables:
@c mode: Texinfo
diff --git a/doc/quickstart.texi b/doc/quickstart.texi
index e1fcac7e..7f9e1f97 100644
--- a/doc/quickstart.texi
+++ b/doc/quickstart.texi
@@ -11,32 +11,10 @@ and enable you to prepare your first @LaTeX{} document with
@AUCTeX{}
after only a few minutes of reading.
In this introduction, we assume that @AUCTeX{} is already installed on
-your system. If this is not the case, you should read the file
-@file{INSTALL} in the base directory of the unpacked distribution
-tarball. These installation instructions are available in this manual
-as well, @ref{Installation}. We also assume that you are familiar with
-the way keystrokes are written in Emacs manuals. If not, have a look at
-the Emacs Tutorial in the Help menu.
-
-If @AUCTeX{} is installed in any other way than from the Emacs package
-manager (@acronym{ELPA}), you might still need to activate it, by
-inserting
-
-@lisp
-(load "auctex.el" nil t t)
-@end lisp
-@noindent
-in your user init file.@footnote{This usually is a file in your home
-directory called @file{.emacs}, or @file{.emacs.d/init.el}.}
-
-If @AUCTeX{} is installed from @acronym{ELPA}, the installation
-procedure already cares about loading @AUCTeX{} correctly and you
-@strong{must not} have the line above in your init file. Note that this
-also applies if you have the following line in your init file
-
-@lisp
-(package-initialize)
-@end lisp
+your system. If this is not the case, you should read the installation
+instructions in this manual (@pxref{Installation}). We also assume that
+you are familiar with the way keystrokes are written in Emacs manuals.
+If not, have a look at the Emacs Tutorial in the Help menu.
In order to get support for many of the @LaTeX{} packages you will use
in your documents, you should enable document parsing as well, which can
diff --git a/doc/todo.texi b/doc/todo.texi
index a0931307..e5d0473c 100644
--- a/doc/todo.texi
+++ b/doc/todo.texi
@@ -1,12 +1,7 @@
@c This is part of the AUCTeX Manual.
@c Copyright (C) 2004-2006, 2008, 2009, 2013-2015,
-@c 2020-2022 Free Software Foundation, Inc.
+@c 2020-2024 Free Software Foundation, Inc.
@c See the file auctex.texi for copying conditions.
-@ifset rawfile
-@include macros.texi
-@node Development,,(dir),(dir)
-@top Future Development of @AUCTeX{}
-@end ifset
The following sections describe future development of @AUCTeX{}.
Besides mid-term goals, bug reports and requests we cannot fix or honor
@@ -22,16 +17,8 @@ changes on the mailing list of @AUCTeX{} first.
* Bugs::
@end menu
-@ifset rawfile
-@node Mid-term Goals
-@chapter Mid-term Goals
-@raisesections
-@end ifset
-
-@ifclear rawfile
@node Mid-term Goals
@section Mid-term Goals
-@end ifclear
@itemize @bullet
@item Integration of @previewlatex{} into @AUCTeX{}
@@ -96,9 +83,7 @@ Variables @code{LaTeX-insert-into-comments},
@code{TeX-translate-location-hook}
@item
How to use @code{TeX-auto-add-type}, as well as functions and variables
generated by that macro.
-@ifclear rawfile
They should be covered in the node @ref{Hacking the Parser}.
-@end ifclear
@item
Usage of @ConTeXt{} mode
diff --git a/doc/wininstall.texi b/doc/wininstall.texi
deleted file mode 100644
index 1c812d4d..00000000
--- a/doc/wininstall.texi
+++ /dev/null
@@ -1,362 +0,0 @@
-@c This is part of the AUCTeX Manual.
-@c Copyright (C) 2003-2007, 2009, 2018, 2021
-@c Free Software Foundation, Inc.
-@c See the file auctex.texi for copying conditions.
-@ifset rawfile
-@include macros.texi
-@end ifset
-
-@subheading In a Nutshell
-
-The following are brief installation instructions for the impatient. In
-case you don't understand some of this, run into trouble of some sort,
-or need more elaborate information, refer to the detailed instructions
-further below.
-
-@enumerate
-@item
-Install the prerequisites, i.e.@: GNU Emacs, MSYS or Cygwin, a @TeX{}
-system, and Ghostscript.
-
-@item
-Open the MSYS shell or a Cygwin shell and change to the directory
-containing the unzipped file contents.
-
-@item
-Configure @AUCTeX{}:
-
-For Emacs: Many people like to install @AUCTeX{} into the pseudo file
-system hierarchy set up by the Emacs installation. Assuming Emacs is
-installed in @file{C:/Program Files/Emacs} and the directory for local
-additions of your @TeX{} system, e.g.@: MiK@TeX{}, is
-@file{C:/localtexmf}, you can do this by typing the following statement
-at the shell prompt:
-
-@example
-./configure --prefix='C:/Program Files/Emacs' \
- --infodir='C:/Program Files/Emacs/info' \
- --with-texmf-dir='C:/localtexmf'
-@end example
-
-The commands above is example for common usage. More on configuration
-options can be found in the detailed installation instructions below.
-
-If the configuration script failed to find all required programs, make
-sure that these programs are in your system path and add directories
-containing the programs to the @env{PATH} environment variable if
-necessary. Here is how to do that in W2000/XP:
-
-@enumerate
-@ifclear rawfile
-@cindex Adding to @env{PATH} in Windows
-@cindex @env{PATH} in Windows
-@end ifclear
-@item
-On the desktop, right click ``My Computer'' and select properties.
-@item
-Click on ``Advanced'' in the ``System Properties'' window.
-@item
-Select ``Environment Variables''.
-@item
-Select ``path'' in ``System Variables'' and click ``edit''. Move to the
-front in the line (this might require scrolling) and add the missing
-path including drive letter, ended with a semicolon.
-@end enumerate
-
-@item
-If there were no further error messages, type
-
-@example
-make
-@end example
-
-In case there were, please refer to the detailed description below.
-
-@item
-Finish the installation by typing
-
-@example
-make install
-@end example
-@end enumerate
-
-@subheading Detailed Installation Instructions
-
-Installation of @AUCTeX{} under Windows is in itself not more
-complicated than on other platforms. However, meeting the prerequisites
-might require more work than on some other platforms, and feel less
-natural.
-
-If you are experiencing any problems, even if you think they are of your
-own making, be sure to report them to @email{auctex-devel@@gnu.org} so
-that we can explain things better in future.
-
-Windows is a problematic platform for installation scripts. The main
-problem is that the installation procedure requires consistent file
-names in order to find its way in the directory hierarchy, and Windows
-path names are a mess.
-
-The installation procedure tries finding stuff in system search paths
-and in Emacs paths. For that to succeed, you have to use the same
-syntax and spelling and case of paths everywhere: in your system search
-paths, in Emacs' @code{load-path} variable, as argument to the scripts.
-If your path names contain spaces or other `shell-unfriendly'
-characters, most notably backslashes for directory separators, place the
-whole path in @samp{"double quote marks"} whenever you specify it on a
-command line.
-
-Avoid `helpful' magic file names like @samp{/cygdrive/c} and
-@samp{C:\PROGRA~1\} like the plague. It is quite unlikely that the
-scripts will be able to identify the actual file names involved. Use
-the full paths, making use of normal Windows drive letters like
-@samp{ 'C:/Program Files/Emacs' } where required, and using the same
-combination of upper- and lowercase letters as in the actual files.
-File names containing shell-special characters like spaces or
-backslashes (if you prefer that syntax) need to get properly quoted to
-the shell: the above example used single quotes for that.
-
-Ok, now here are the steps to perform:
-
-@enumerate
-@item
-You need to unpack the @AUCTeX{} distribution (which you seemingly have
-done since you are reading this). It must be unpacked in a separate
-installation directory outside of your Emacs file hierarchy: the
-installation will later copy all necessary files to their final
-destination, and you can ultimately remove the directory where you
-unpacked the files.
-
-Line endings are a problem under Windows. The distribution contains
-only text files, and theoretically most of the involved tools should get
-along with that. However, the files are processed by various utilities,
-and it is conceivable that not all of them will use the same line ending
-conventions. If you encounter problems, it might help if you try
-unpacking (or checking out) the files in binary mode, if your tools
-allow that.
-
-If you don't have a suitable unpacking tool, skip to the next step: this
-should provide you with a working @samp{unzip} command.
-
-@item
-The installation of @AUCTeX{} will require the MSYS tool set from
-@uref{http://www.mingw.org/} or the Cygwin tool set from
-@uref{https://cygwin.com/}. The latter is slower and larger (the download
-size of the base system is about 15 MB) but comes with a package manager
-that allows for updating the tool set and installing additional packages
-like, for example, the spell checker @w{aspell}.
-
-If Cygwin specific paths like @samp{/cygdrive/c} crop up in the course
-of the installation, using a non-Cygwin Emacs could conceivably cause
-trouble. Using Cygwin either for everything or nothing might save
-headaches, @emph{if} things don't work out.
-
-@item
-Install a current version of @w{Emacs} from
-@uref{https://ftp.gnu.org/gnu/emacs/windows/}.
-
-@item
-You need a working @TeX{} installation. One popular installation under
-Windows is @uref{https://miktex.org/,MiK@TeX{}}. Another much more
-extensive system is @uref{https://www.tug.org/texlive/,@w{@TeX{} Live}}
-which is rather close to its Unix cousins.
-
-@item
-A working copy of @uref{https://www.ghostscript.com/,Ghostscript} is
-required for @previewlatex{} operation. Examining the output from
-@example
-gswin32c -h
-@end example
-on a Windows command line should tell you whether your Ghostscript
-supports the @code{png16m} device needed for @acronym{PNG} support.
-MiK@TeX{} apparently comes with its own Ghostscript called @file{mgs.exe}.
-
-@item
-@uref{https://www.perl.org/,Perl} is needed for rebuilding the
-documentation if you are working with a copy from Git or have
-touched documentation source files in the @previewlatex{} part. If the
-line endings of the file @file{preview/latex/preview.dtx} don't
-correspond with what Perl calls @code{\n} when reading text files,
-you'll run into trouble.
-
-@item
-Now the fun stuff starts. If you have not yet done so, unpack the
-@AUCTeX{} distribution into a separate directory after rereading the
-instructions for unpacking above.
-
-@item
-Ready for takeoff. Start some shell (typically @command{bash}) capable of
-running @command{configure}, change into the installation directory and
-call @command{./configure} with appropriate options.
-
-Typical options you'll want to specify will be
-@table @code
-@item --prefix=@var{drive:/path/to/emacs-hierarchy}
-which tells @command{configure} where to perform the installation. It may
-also make @command{configure} find Emacs automatically; if this doesn't
-happen, try @option{--with-emacs} as described below. All automatic
-detection of files and directories restricts itself to directories below
-the @var{prefix} or in the same hierarchy as the program accessing the
-files. Usually, directories like @file{man}, @file{share} and
-@file{bin} will be situated right under @var{prefix}.
-
-This option also affects the defaults for placing the Texinfo
-documentation files (see also @option{--infodir} below) and automatically
-generated style hooks.
-
-If you have a central directory hierarchy (not untypical with Cygwin)
-for such stuff, you might want to specify its root here. You stand a
-good chance that this will be the only option you need to supply, as
-long as your @TeX{}-related executables are in your system path, which
-they better be for @AUCTeX{}'s operation, anyway.
-
-@item --with-emacs
-if you are installing for a version of Emacs. You can use
-@samp{--with-emacs=@var{drive:/path/to/emacs}} to specify the name of the
-installed Emacs executable, complete with its path if necessary (if
-Emacs is not within a directory specified in your @env{PATH} environment
-setting).
-
-@item --with-lispdir=@var{drive:/path/to/site-lisp}
-This option tells a place in @code{load-path} below which the
-files are situated. The startup files @file{auctex.el} and
-@file{preview-latex.el} will get installed here unless a subdirectory
-@file{site-start.d} exists which will then be used instead. The other
-files from @AUCTeX{} will be installed in a subdirectory called
-@file{auctex}.
-
-If you think that you need a different setup, please refer to the full
-installation instructions in
-@ifset rawfile
-the @file{INSTALL} file.
-@end ifset
-@ifclear rawfile
-@ref{Configure}.
-@end ifclear
-
-@item --infodir=@var{drive:/path/to/info/directory}
-If you are installing into an Emacs directory, info files have to be put
-into the @file{info} folder below that directory. The configuration
-script will usually try to install into the folder @file{share/info}, so
-you have to override this by specifying something like
-@samp{--infodir='C:/Program Files/info'} for the configure call.
-
-@item --with-auto-dir=@var{drive:/dir}
-Directory containing automatically generated information. You should
-not normally need to set this, as @samp{--prefix} should take care of
-this.
-
-@item --disable-preview
-Use this option if your Emacs version is unable to support image
-display.
-
-@item --with-texmf-dir=@var{drive:/dir}
-This will specify the directory where your @TeX{} installation sits. If
-your @TeX{} installation does not conform to the @acronym{TDS} (@TeX{}
directory
-standard), you may need to specify more options to get everything in
-place.
-@end table
-
-For more information about any of the above and additional options, see
-@ifset rawfile
-the `Configure' section in the @file{INSTALL} file.
-@end ifset
-@ifclear rawfile
-@ref{Configure}.
-@end ifclear
-
-@c FIXME: It seems this no longer holds.
-@c Calling
-@c @file{./configure --help=recursive}
-@c will tell about other options, but those are almost never required.
-
-Some executables might not be found in your path. That is not a good
-idea, but you can get around by specifying environment variables to
-@command{configure}:
-@example
-GS="@var{drive:/path/to/gswin32c.exe}" ./configure @dots{}
-@end example
-should work for this purpose. @file{gswin32c.exe} is the usual name for
-the required @emph{command line} executable under Windows; in contrast,
-@file{gswin32.exe} is likely to fail.
-
-As an alternative to specifying variables for the @command{configure} call
-you can add directories containing the required executables to the
-@env{PATH} variable of your Windows system. This is especially a good
-idea if Emacs has trouble finding the respective programs later during
-normal operation.
-
-@item
-Run @command{make} in the installation directory.
-
-@item
-Run @code{make install} in the installation directory.
-
-@item
-With Emacs, activation of @AUCTeX{} and @previewlatex{} depends on a
-working @file{site-start.d} directory or similar setup, since then the
-startup files @file{auctex.el} and @file{preview-latex.el} will have
-been placed there. If this has not been done, you should be able to
-load the startup files manually with
-@lisp
-(load "auctex.el" nil t t)
-(load "preview-latex.el" nil t t)
-@end lisp
-in either a site-wide @file{site-start.el} or your personal startup file
-(usually accessible as @file{~/.emacs} or @file{~/.emacs.d/init.el} from
-within Emacs).
-
-@ifclear rawfile
-@cindex @file{tex-mik.el}
-@end ifclear
-The default configuration of @AUCTeX{} is probably not the best fit for
-Windows systems with MiK@TeX{}. You might want to add
-@lisp
-(require 'tex-mik)
-@end lisp
-after loading @file{auctex.el} and @file{preview-latex.el} in order to
-get more appropriate values for some customization options.
-
-You can always use
-
-@example
-@kbd{M-x customize-group @key{RET} AUCTeX @key{RET}}
-@end example
-
-in order to customize more stuff, or use the @samp{Customize} menu.
-
-@item
-Load @file{circ.tex} into Emacs and see if you get the @samp{Command}
-menu. Try using it to @LaTeX{} the file.
-
-@item
-Check whether the @samp{Preview} menu is available in this file. Use it
-to generate previews for the document.
-
-If this barfs and tells you that image type @samp{png} is not supported,
-you can either add @acronym{PNG} support to your Emacs installation or
-choose another image format to be used by @previewlatex{}.
-
-Adding support for an image format usually involves the installation of
-a library, e.g.@: from @uref{http://gnuwin32.sf.net/}. If you got your
-Emacs from @uref{https://www.gnu.org/} you might want to check its
-@uref{https://ftp.gnu.org/gnu/emacs/windows/README,README file} for
-details.
-
-A different image format can be chosen by setting the variable
-@code{preview-image-type}. While it is recommended to keep the
-@samp{dvipng} or @samp{png} setting, you can temporarily select a
-different format like @samp{pnm} to check if the lack of @acronym{PNG}
-support is the only problem with your Emacs installation.
-
-Try adding the line
-
-@lisp
-(setq preview-image-type 'pnm)
-@end lisp
-
-to your init file for a quick test. You should remove the line after
-the test again, because @acronym{PNM} files take away @strong{vast}
-amounts of disk space, and thus also of load/save time.
-@end enumerate
-
-Well, that about is all. Have fun!
