auctex

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 1, or (at your option)
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

** Installation

Just type `make' and follow the instructions.

You will need texinfo2, available by ftp from prep.ai.mit.edu.

It is best to remove the old version, before installing the new.

It is best to unpack and install AUC TeX from a different directory,
than you want the compiled .elc files to be found.

** Introduction

This section gives a brief overview of what AUC-TeX is. It is *not*
an attempt to document it. Real documentation for AUC-TeX is available in the texinfo file in the doc directory.

*** AUC-TeX for GNU Emacs

AUC-TeX is a comprehensive customizable integrated environment for
writing input files for LaTeX using GNU Emacs.

AUC-TeX lets you run TeX/LaTeX and other LaTeX-related tools, such as
a output filters or post processor from inside Emacs. Especially
`running LaTeX' is interesting, as AUC-TeX let's 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.

AUC-TeX 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
the overview' of a document.

Apart from these special features, AUC-TeX provides an large range of
handy Emacs macros, which in several different ways can help you
write your LaTeX documents fast and painless.

All features of AUC-TeX are documented using the GNU Emacs online
documentation system. That is, documentation for any command is just
a key click away!

AUC-TeX is written entirely in Emacs-Lisp, and hence you can easily
add new features for your own needs. It was not made as part of any
particular employment or project (apart from the AUC-TeX project
itself). AUC-TeX is distributed under the `GNU Emacs General Public
License' and may therefore almost freely be copied and redistributed.

*** Major features of AUC-TeX

This section is a short introduction to some `actual' features. For
further information, refer to the build-in online documentation of
AUC-TeX.

**** Indentation and formatting

AUC-TeX may automatically indent your document as you write it. By
pressing line feed instead of return at the end of a line, the current
line is indented by two spaces according to the current environment
level, and the cursor is moved down one line. By pressing TAB, the
current line is indented, and the cursor stays where it is. The
well-known Emacs feature format-paragraph (M-q) is re implemented
especially for AUC-TeX to follow the indentation. A special command
LaTeX-format-buffer, lets you indent an entire document like the
well-known c utility indent (this time, only according to the LaTeX
structure :-)

**** Completion

By studying your `\documentstyle' command (in the top of your
document), and consulting a precompiled list of (La)TeX symbols from a
large number of TeX and LaTeX files, AUC-TeX is aware of the LaTeX
commands you should able to use in this particular document. This
`knowledge' of AUC-TeX is used for two purposes: 1) To make you able
to `complete' partly written LaTeX commands. You may e.g. write
"\renew" and press ESC TAB (TeX-complete-symbol), and then AUC-TeX
will complete the word "\renewcommand" for you. In case of ambigiouty
it will display a list of possible completions. 2) To aid you
inserting environments, that is \begin - \end pairs. This is done by
pressing C-c C-c (LaTeX-environment), and you will be prompted for
which `environment' to insert.

**** Editing your document

A number of more or less intelligent keyboard macros have been defined
to aid you editing your document. The most important are listed here
below.

LaTeX-environment (C-c C-c)
Insert a \begin{} - \end{} pair as described above.

LaTeX-section (C-c C-x)
Insert one of \chapter, \section, etc.

TeX-Roman (C-c C-r), TeX-italic (C-c C-i), TeX-bold (C-c C-b) etc...
Insert one of {\rm }, {\it \/} {\bf } etc.

A number of additional functions are available. But - it would be far
too much to write about here. Refer to the AUC-TeX online
documentation for further information.

**** Running LaTeX

When invoking on of the commands TeX-buffer (C-c C-a) or TeX-region
(C-c C-d) LaTeX is run on either the entire current document or a
given region of it. The Emacs view is split in two, and the output of
TeX is printed in the second half of the screen, as you may
simultainiously continue editing you document. In case TeX found any
errors when processing your input you can call the function
TeX-next-error (C-c C-n) which will move the cursor to the first given
error, and display a short explanatory text along with the message TeX
gave. This procedure may be repeated until all errors have been
displayed. By pressing C-c C-w (TeX-debug-bad-boxes) you can toggle
whether the browser also should notify over-full/under-full boxes or not.

Once you've successfully formatted your document, you may preview or
print it by invoking TeX-preview (C-c C-p) or TeX-print (C-c !).

**** Outlining

Along with AUC-TeX comes a special `minor' outline mode for Emacs,
which lets you browse the sectioning structure of your document, while
you will still be able to use the full power of the rest of the
AUC-TeX functionality.

** Hints

*** For german.sty users

Users of geman.sty (and others who like their " to behave
normally), will want to enable the following hook:

.emacs> (setq TeX-mode-hook
.emacs> (function (lambda () (local-set-key "\"" 'self-insert-command))))

*** For users intensive users of outline-minor-mode

People who use the outline features a lot may want to bind them to a
single prefix key:

.emacs> (setq-default outline-prefix-char "\C-l")

** History

See the texinfo file for a list of changes in the last versions.

** Availability

AUC-TeX is available by anonymous ftp to `iesd.auc.dk' as
"/pub/emacs-lisp/auctex_X_x.tar.Z". (where `X_x' specifies the release
version) The most resent version is ALLWAYS available in
`/pub/emacs-lisp/auctex.tar.Z'. Also, it should be available at major
TeX and Elisp archives around the world. In case you don't have
access anonymous ftp, you can get it by Email requests to
`auc-tex_mgr@iesd.auc.dk'.

** Contacts

There has been established a mailing list for discussion of the
evaluation of auc-tex. You're very welcome to join. However, If you
are only interested in information on updates, you could refer to the
newsgroups comp.text.tex and gnu.emacs.sources.

If you want to contact the auc-tex mailing list, mail:

Articles: auc-tex@iesd.auc.dk

Requests: auc-tex-request@iesd.auc.dk

To contact the current maintainers directly of auc-tex, Email:

auc-tex_mgr@iesd.auc.dk

The address of the maintainers is:

AUC TeX development
c/o Kresten Krab Thorup

Mathematics and Computer Science
University of Aalborg
DK 9000 Aalborg
Denmark

** Emacs

Local Variables:
mode: text
mode: outline-minor
End:

README_MINOR

* README_MINOR - Introduction to minor modes.

$Id: README_MINOR,v 5.4 1993/03/16 02:24:14 amanda Exp $

** min-map.el:  Minor Keymaps 

For authors of minor modes, who need to rebind one or more keys while
in the minor mode.  You can do this by hiding the old binding in a
variable, and then restore the binding when you leave the mode.
Unfortunately, this will usually not work if more than one minor mode
try to rebind the key.  You can solve this problem, by using the
following functions to bind keys in minor modes.  See the
documentation string for the individual functions for details.

Put in (require 'min-map) in the start of the file containing your
minor mode. 

Use minor-set-key to set a key in the minor keymap for a given minor
mode.

Use minor-call-shadow to call the key binding shadowed by a given
minor mode.

Use unbind-minor-mode to remove all key definitions for a given minor
mode.

** min-out.el:  Outline Minor Mode

Allows you to use the outline-mode commands while in another major
mode.  This is already integrated in LaTeX-mode.  You toggle the mode
with M-x outline-minor-mode.  If you want to support other major
modes, let them change the outline-regexp and outline-level-function.
outline-regexp matches header lines (by default lines starting with
one or more *'s), and outline-level-function calculate the level of
the header (by default the length of the string matched by
outline-regexp).

To use, add to your init file:

(autoload 'outline-minor-mode "min-out" "Toggle outline minor mode." t)
(make-variable-buffer-local 'outline-prefix-char)
(setq-default outline-prefix-char "\C-c\C-o") ; Change to get a better prefix
(make-variable-buffer-local 'outline-regexp)
(setq-default outline-regexp "[*\^l]+")
(make-variable-buffer-local 'outline-level-function)
(setq-default outline-level-function 'outline-level-default)

** min-key.el:  Mapping the keyboard layout

This package allows you to specify a language specific keyboard
mapping between various encodings of an alphabet, and it also allows
you to convert the text in the buffer directly between the supported
encodings.

Currently the following languages / character set encodings are
supported: 

"Danish":
	"ISO 646 DK" "Keyboard Layout" "Digraphs" "TeX" "ISO 8859 Latin 1"

"Swedish":
	"ISO 646 SE" "Keyboard Layout" "Digraphs" "TeX" "ISO 8859 Latin 1"

"Russian":
	"Keyboard Layout" "TeX" "KOI8"

"Keyboard Layout":
	"QWERTY" "Dvorak"

"ISO 8859 Latin 1":
	"ISO 8859 Latin 1" "Monograph" "Digraph" 
	"ISO 646" "RFC 1345" "Backspace" "TeX"

The keyboard remapping is implemented as a minor mode.  You initially
select the mapping with ``M-x keyboard-query-mapping'', and can then
toggle mode with ``M-x keyboard-mode''.  Once in the minor mode, you
can (optionally) get the original binding of a key by typing the the
key twice.

You convert between character sets by typing 
``M-x convert-character-query'', and answering the questions.  Use
`convert-character-encoding' to convert non-interactively. 

To use, add to your init file:

(autoload 'keyboard-mode "min-key" "Toggle keyboard-mode." t)
(autoload 'keyboard-query-mapping "min-key" "Query keyboard-mode." t)
(autoload 'convert-character-query "min-key" "Convert between encodings." t)
(autoload 'convert-character-encoding "min-key"
          "Convert between encodings." nil)

You most likely want to define a short-cut for often used mappings.
The following function redefine the keys on an international
keyboard to generate Danish characters as TeX macros.

(defun tex-dk-double-mode (arg)
  "DK TeX keys on international keyboard."
  (interactive "P")
  (require 'min-key)
  (if (or (and (null arg) keyboard-mode)
	  (<= (prefix-numeric-value arg) 0))
      (keyboard-mode -1)
    (keyboard-set-mapping "Danish" "Keyboard Layout" "TeX" t)
    (keyboard-mode 1)))

** min-ind.el:  Automatic indentation

Auto-indent mode works by invoking indent-relative for TAB, and using
indent-relative-maybe as the indent-line-function for auto-fill, and
NEWLINE. Enter and leave with M-x auto-indent-mode.

To use, add to your init file:

(autoload 'auto-indent-mode "min-ind" "Toggle auto-indent-mode." t)

** min-ispl.el: Automatic ispell of words

In auto-ispell-mode `space' or `return' automatically trigger
`ispell-word' on previously typed word.  M-TAB will make an ispell
completion. Enter and leave with M-x auto-ispell-mode.

To use, add to your init file:

(autoload 'auto-ispell-mode "min-ispl" "Toggle auto-ispell-mode." t)

** ltx-dead.el: Accent's in LaTeX

Get TeX accent on letters by typing accent key followed by letter.
Enter and leave with M-x LaTeX-dead-mode.

To use, add to your init file:

(setq LaTeX-dead-keys '(?' ?` ?\" ?^ ?~)) ; Remove those you don't need
(autoload 'LaTeX-dead-mode "ltx-dead" "Toggle LaTeX-dead-mode." t)

** tex-math.el: Mathematical macros in TeX

Bind mathematical to backquote.  You enter mathematical macros with
` letter, e.g. ` a will insert \alpha in the buffer.

To use, add to your init file:

(setq LaTeX-math-abbrev-prefix "`") ; Change if you like ` as is.
(autoload 'LaTeX-math-mode "tex-math" "Toggle math mode." t)

** For your init file.

;;; Outline Minor Mode
(autoload 'outline-minor-mode "min-out" "Toggle outline minor mode." t)
(make-variable-buffer-local 'outline-prefix-char)
(setq-default outline-prefix-char "\C-c\C-o") ; Change to get a better prefix
(make-variable-buffer-local 'outline-regexp)
(setq-default outline-regexp "[*\^l]+")
(make-variable-buffer-local 'outline-level-function)
(setq-default outline-level-function 'outline-level-default)

;;; Mapping the keyboard layout
(autoload 'keyboard-mode "min-key" "Toggle keyboard-mode." t)
(autoload 'keyboard-query-mapping "min-key" "Query keyboard-mode." t)
(autoload 'convert-character-query "min-key" "Convert between encodings." t)

;;; Accent's in LaTeX
(setq LaTeX-dead-keys '(?' ?` ?\" ?^ ?~)) ; Remove those you don't need
(autoload 'LaTeX-dead-mode "ltx-dead" "Toggle LaTeX-dead-mode." t)

;;; Mathematical macros in TeX
(setq LaTeX-math-abbrev-prefix "`") ; Change if you like ` as is.
(autoload 'LaTeX-math-mode "tex-math" "Toggle math mode." t)

;;; Other minor modes
(autoload 'auto-indent-mode "min-ind" "Toggle auto-indent-mode." t)
(autoload 'auto-ispell-mode "min-ispl" "Toggle auto-ispell-mode." t)

** Emacs

Local Variables:
mode: text
mode: outline-minor
End:

These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.