main 8b479fc8 006/257: Don't ignore README and tex-site.el; fix prv-xemacs compilation and copyrights

[Tassilo Horn]

branch: main
commit 8b479fc861135e28d878fd9012b3dd682f00b812
Author: Stefan Monnier <monnier@iro.umontreal.ca>
Commit: Stefan Monnier <monnier@iro.umontreal.ca>

    Don't ignore README and tex-site.el; fix prv-xemacs compilation and 
copyrights
---
 .elpaignore        |   1 -
 .gitignore         |   8 +-
 GNUmakefile        |   3 +-
 README             | 240 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 lpath.el           |   3 +
 prv-xemacs.el      |  16 ++--
 style/dinbrief.el  |   2 +
 style/epsf.el      |   2 +
 style/latexinfo.el |   2 +-
 style/prosper.el   |   2 +-
 style/psfig.el     |   2 +
 tex-site.el        | 155 ++++++++++++++++++++++++++++++++++
 12 files changed, 422 insertions(+), 14 deletions(-)

diff --git a/.elpaignore b/.elpaignore
index 0fd70211..a815508f 100644
--- a/.elpaignore
+++ b/.elpaignore
@@ -3,7 +3,6 @@
 *.ac
 *.spec
 autogen.sh
-.cvsignore
 install-sh
 lpath.el
 mkinstalldirs
diff --git a/.gitignore b/.gitignore
index 79e23175..657cfceb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,17 +7,21 @@ FAQ
 INSTALL
 INSTALL.windows
 Makefile
-README
+#README
 TODO
 auctex.el
 auto-loads.el
 autom4te.*
 config.*
 configure
-tex-site.el
+#tex-site.el
 tex-site.el.out
 
+# Files genrated while building the auto-generated files included in elpa.
 doc/preview-dtxdoc.texi
 doc/version.texi
 latex/preview-mk.ins
 latex/preview.drv
+
+# Files generated when installing/compiling the package in place.
+auctex-autoloads.el
diff --git a/GNUmakefile b/GNUmakefile
index 44ed8b4f..347e0cc9 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -59,9 +59,10 @@ AUCTEXVERSION:=$(if 
$(THISVERSION),$(THISVERSION),$(LASTVERSION).$(AUCTEXDATE))
 tex-site.el: tex-site.el.in
        sed -e 's|@lisppackagelispdir@|(file-name-directory load-file-name)|'\
            -e 's|@lisppackagedatadir@|(file-name-directory load-file-name)|'\
-           -e 's|@lispautodir@|(if (file-writeable-p "/usr/local/var/auctex") 
"/usr/local/var/auctex" "~/.emacs.d/auctex")|'\
+           -e 's|@lispautodir@|(if (file-writable-p "/usr/local/var/auctex") 
"/usr/local/var/auctex" "~/.emacs.d/auctex")|'\
            -e 's|@AUCTEXVERSION@|$(AUCTEXVERSION)|'\
            -e 's|@AUCTEXDATE@|$(AUCTEXDATE)|'\
+           -e "\$$a(provide 'tex-site)" \
            $< >$@
 
 doc/version.texi: ChangeLog
diff --git a/README b/README
new file mode 100644
index 00000000..0a1f3311
--- /dev/null
+++ b/README
@@ -0,0 +1,240 @@
+This is the README file for the AUCTeX distribution.
+
+     Copyright (C) 2008 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 and this notice are preserved.
+
+Introduction to AUCTeX
+**********************
+
+This file gives a brief overview of what AUCTeX is.  It is *not* an
+attempt to document AUCTeX.  Real documentation for AUCTeX is available
+in the manual, which should be available as an info file after
+installation.
+
+AUCTeX is a comprehensive customizable integrated environment for
+writing input files for TeX, LaTeX, ConTeXt, Texinfo, and docTeX using
+Emacs or XEmacs.
+
+It supports you in the insertion of macros, environments, and sectioning
+commands by providing completion alternatives and prompting for
+parameters.  It automatically indents your text as you type it and lets
+you format a whole file at once.  The outlining and folding facilities
+provide you with a focused and clean view of your text.
+
+AUCTeX 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
+preview-latex, 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.  For more
+information, see further below.
+
+More detailed information about the features and usage of AUCTeX can be
+found in the AUCTeX manual.  You can access it from within Emacs by
+typing 'C-h i d m auctex <RET>'.  If you prefer the standalone info
+reader, issue the command 'info auctex' in a terminal.
+
+AUCTeX is written entirely in Emacs Lisp, and hence you can easily 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
+<http://ftp.gnu.org/pub/gnu/auctex/>.
+
+WWW users may want to check out the AUCTeX page at
+<http://www.gnu.org/software/auctex/>.
+
+For comprehensive information about how to install AUCTeX read the file
+'INSTALL' or 'INSTALL.windows', respectively.
+
+If you are considering upgrading AUCTeX, the recent changes are
+described in the 'CHANGES' file.
+
+If you want to discuss AUCTeX with other users or its developers, there
+are several mailing lists you can use.
+
+Send a mail with the subject "subscribe" to <auctex-request@gnu.org> in
+order to join the general discussion list for AUCTeX.  Articles should
+be sent to <auctex@gnu.org>.  In a similar way, you can subscribe to the
+<info-auctex@gnu.org> list for just getting important announcements
+about AUCTeX.  The list <bug-auctex@gnu.org> is for bug reports which
+you should usually file with the '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
+<auctex-devel@gnu.org>.
+preview-latex in a nutshell
+***************************
+
+Does your neck hurt from turning between previewer windows and the
+source too often?  This AUCTeX component will render your displayed
+LaTeX equations right into the editing window where they belong.
+
+The purpose of preview-latex is to embed LaTeX environments such as
+display math or figures into the source buffers and switch conveniently
+between source and image representation.
+
+1 What use is it?
+*****************
+
+WYSIWYG (what you see is what you get) sometimes is considered all the
+rage, sometimes frowned upon.  Do we really want it?  Wrong question.
+The right question is _what_ we want from it.  Except when finetuning
+the layout, we don't want to use printer fonts for on-screen text
+editing.  The low resolution and contrast of a computer screen render
+all but the coarsest printer fonts (those for low-quality newsprint)
+unappealing, and the margins and pagination of the print are not wanted
+on the screen, either.  On the other hand, more complex visual
+compositions like math formulas and tables can't easily be taken in when
+seen only in the source.  preview-latex strikes a balance: it only uses
+graphic renditions of the output for certain, configurable constructs,
+does this only when told, and then right in the source code.  Switching
+back and forth between the source and preview is easy and natural and
+can be done for each image independently.  Behind the scenes of
+preview-latex, a sophisticated framework of other programs like
+'dvipng', Dvips and Ghostscript are employed together with a special
+LaTeX style file for extracting the material of interest in the
+background and providing fast interactive response.
+
+2 Activating preview-latex
+**************************
+
+After installation, the package may need to be activated (and remember
+to activate AUCTeX too).  In XEmacs, and in any prepackaged versions
+worth their salt, activation should be automatic upon installation.  If
+this seems not the case, complain to your installation provider.
+
+The usual activation (if it is not done automatically) would be
+
+     (load "preview-latex.el" nil t t)
+
+If you still 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 '<M-x>
+list-load-path-shadows <RET>'.
+
+3 Getting started
+*****************
+
+Once activated, preview-latex and its documentation will be accessible
+via its menus (note that preview-latex requires AUCTeX to be loaded).
+When you have loaded a LaTeX document (a sample document 'circ.tex' is
+included in the distribution, but most documents including math and/or
+figures should do), you can use its menu or 'C-c C-p C-d' (for
+'Preview/Document').  Previews will now be generated for various objects
+in your document.  You can use the time to take a short look at the
+other menu entries and key bindings in the 'Preview' menu.  You'll see
+the previewed objects change into a roadworks sign when preview-latex
+has determined just what it is going to preview.  Note that you can
+freely navigate the buffer while this is going on.  When the process is
+finished you will see the objects typeset in your buffer.
+
+It is a bad idea, however, to edit the buffer before the roadworks signs
+appear, since that is the moment when the correlation between the
+original text and the buffer locations gets established.  If the buffer
+changes before that point of time, the previews will not be placed where
+they belong.  If you do want to change some obvious error you just
+spotted, we recommend you stop the background process by pressing 'C-c
+C-k'.
+
+To see/edit the LaTeX code for a specific object, put the point (the
+cursor) on it and press 'C-c C-p C-p' (for 'Preview/at point').  It will
+also do to click with the middle mouse button on the preview.  Now you
+can edit the code, and generate a new preview by again pressing 'C-c C-p
+C-p' (or by clicking with the middle mouse button on the icon before the
+edited text).
+
+If you are using the 'desktop' package, previews will remain from one
+session to the next as long as you don't kill your buffer.  If you are
+using XEmacs, you will probably need to upgrade the package to the
+newest one; things are being fixed just as I am writing this.
+
+4 Basic modes of operation
+**************************
+
+preview-latex has a number of methods for generating its graphics.  Its
+default operation is equivalent to using the 'LaTeX' command from
+AUCTeX.  If this happens to be a call of PDFLaTeX generating PDF output
+(you need at least AUCTeX 11.51 for this), then Ghostscript will be
+called directly on the resulting PDF file.  If a DVI file gets produced,
+first Dvips and then Ghostscript get called by default.
+
+The image type to be generated by Ghostscript can be configured with
+
+     M-x customize-variable RET preview-image-type RET
+
+The default is 'png' (the most efficient image type).  A special setting
+is 'dvipng' in case you have the 'dvipng' program installed.  In this
+case, 'dvipng' will be used for converting DVI files and Ghostscript
+(with a 'PNG' device) for converting PDF files.  'dvipng' is much faster
+than the combination of Dvips and Ghostscript.  You can get downloads,
+access to its CVS archive and further information from its project site
+(http://savannah.nongnu.org/projects/dvipng).
+
+5 More documentation
+********************
+
+After the installation, documentation in the form of an info manual will
+be available.  You can access it with the standalone info reader with
+
+     info preview-latex
+
+or by pressing 'C-h i d m preview-latex <RET>' in Emacs.  Once
+preview-latex is activated, you can instead use 'C-c C-p <TAB>' (or the
+menu entry 'Preview/Read documentation').
+
+Depending on your installation, a printable manual may also be available
+in the form of 'preview-latex.dvi' or 'preview-latex.ps'.
+
+Detailed documentation for the LaTeX style used for extracting the
+preview images is placed in 'preview.dvi' in a suitable directory during
+installation; on typical teTeX-based systems,
+
+     texdoc preview
+
+will display it.
+
+6 Availability
+**************
+
+The preview-latex project is now part of AUCTeX and accessible as part
+of the AUCTeX project page (http://savannah.gnu.org/projects/auctex).
+You can get its files from the AUCTeX download area
+(ftp://ftp.gnu.org/pub/gnu/auctex).  As of AUCTeX 11.81, preview-latex
+should already be integrated into AUCTeX, so no separate download will
+be necessary.
+
+You will also find '.rpm' files there for Fedora and possibly SuSE.
+Anonymous CVS is available as well.
+
+7 Contacts
+**********
+
+Bug reports should be sent by using 'M-x preview-report-bug <RET>', as
+this will fill in a lot of information interesting to us.  If the
+installation fails (but this should be a rare event), report bugs to
+<bug-auctex@gnu.org>.
+
+There is a general discussion list for AUCTeX which also covers
+preview-latex, look at <http://lists.gnu.org/mailman/listinfo/auctex>.
+For more information on the mailing list, send a message with just the
+word "help" as subject or body to <auctex-request@gnu.org>.  For the
+developers, there is the <auctex-devel@gnu.org> list; it would probably
+make sense to direct feature requests and questions about internal
+details there.  There is a low-volume read-only announcement list
+available to which you can subscribe by sending a mail with "subscribe"
+in the subject to <info-auctex-request@gnu.org>.
+
+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 <dak@gnu.org>, and of course you can arrange for
+service contracts or for added functionality.  Take a look at the 'TODO'
+list for suggestions in that area.
diff --git a/lpath.el b/lpath.el
index 34eff145..67f82cec 100644
--- a/lpath.el
+++ b/lpath.el
@@ -1,4 +1,7 @@
 ;;; This file is only used for installing AUCTeX.
+
+;; Copyright (C) 2013 Free Software Foundation, Inc.
+
 ;;; It is not a part of AUCTeX itself.
 
 ;; Make sure we get the right files.
diff --git a/prv-xemacs.el b/prv-xemacs.el
index a4bae717..ce89a1de 100644
--- a/prv-xemacs.el
+++ b/prv-xemacs.el
@@ -1,7 +1,6 @@
 ;;; prv-xemacs.el --- XEmacs support for preview-latex
 
-;; Copyright (C) 2001, 02, 03, 04, 05,
-;;               2006 Free Software Foundation, Inc.
+;; Copyright (C) 2001-2006 Free Software Foundation, Inc.
 
 ;; Author: David Kastrup
 ;; Keywords: convenience, tex, wp
@@ -39,12 +38,13 @@
     "List of macros only present when compiling/loading uncompiled.")
 
   (defmacro preview-defmacro (name &rest rest)
-    (push 
-     (if (fboundp name)
-        (cons name (symbol-function name))
-       name)
-     preview-compatibility-macros)
-    `(eval-when-compile (defmacro ,name ,@rest)))
+    (when (featurep 'xemacs)
+      (push
+       (if (fboundp name)
+           (cons name (symbol-function name))
+         name)
+       preview-compatibility-macros)
+      `(eval-when-compile (defmacro ,name ,@rest))))
   (push 'preview-defmacro preview-compatibility-macros))
 
 (preview-defmacro assoc-default (key alist test)
diff --git a/style/dinbrief.el b/style/dinbrief.el
index 60494341..1182b7bd 100644
--- a/style/dinbrief.el
+++ b/style/dinbrief.el
@@ -1,5 +1,7 @@
 ;;; dinbrief.el - Special code for LaTeX-Style dinbrief.
 
+;; Copyright (C) 2013 Free Software Foundation, Inc.
+
 ;; Contributed by Werner Fink <tex@itap.physik.uni-stuttgart.de>
 ;; Please direct comments to him.
 
diff --git a/style/epsf.el b/style/epsf.el
index f8b2c9ff..47256483 100644
--- a/style/epsf.el
+++ b/style/epsf.el
@@ -1,5 +1,7 @@
 ;;; epsf.el - Support for the epsf style option.
 
+;; Copyright (C) 2013 Free Software Foundation, Inc.
+
 ;; Contributed by Marc Gemis <makke@wins.uia.ac.be>
 
 ;;; Code: 
diff --git a/style/latexinfo.el b/style/latexinfo.el
index f1fdd5d3..59daf6c3 100644
--- a/style/latexinfo.el
+++ b/style/latexinfo.el
@@ -1,6 +1,6 @@
 ;;; latexinfo.el - Support for LaTeXinfo files.
 
-;; Copyright (C) 1993 Marc Gemis <makke@wins.uia.ac.be>
+;; Copyright (C) 1993 Free Software Foundation, Inc.
 
 ;; Author: Marc Gemis <makke@wins.uia.ac.be>
 ;; Version: $Id: latexinfo.el,v 1.7 2008-02-03 14:53:30 angeli Exp $
diff --git a/style/prosper.el b/style/prosper.el
index 8c7f34e4..b0939c78 100644
--- a/style/prosper.el
+++ b/style/prosper.el
@@ -1,6 +1,6 @@
 ;;; prosper.el --- Prosper style file for AUCTeX
 
-;; Copyright (C) 2001, 2002 by Philip Lord, Nevin Kapur
+;; Copyright (C) 2001, 2002 Free Software Foundation, Inc.
 
 ;; Authors:  Phillip Lord<p.lord@russet.org.uk>
 ;;           Nevin Kapur <nevin@jhu.edu>
diff --git a/style/psfig.el b/style/psfig.el
index 70fef606..16df7cfc 100644
--- a/style/psfig.el
+++ b/style/psfig.el
@@ -1,5 +1,7 @@
 ;;; psfig.el - Support for the psfig style option.
 
+;; Copyright (C) 2013 Free Software Foundation, Inc.
+
 ;; Contributed by Marc Gemis <makke@wins.uia.ac.be>
 ;; Please direct comments to him.
 
diff --git a/tex-site.el b/tex-site.el
new file mode 100644
index 00000000..fc7c807d
--- /dev/null
+++ b/tex-site.el
@@ -0,0 +1,155 @@
+;;; tex-site.el - Site specific variables.  Don't edit.
+
+;; Copyright (C) 2005 Free Software Foundation, Inc.
+;;
+;; completely rewritten.
+
+;; Author: David Kastrup <dak@gnu.org>
+;; Maintainer: auctex-devel@gnu.org
+;; Keywords: tex
+
+;; This file is part of AUCTeX.
+
+;; AUCTeX 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 3, or (at your option)
+;; any later version.
+
+;; AUCTeX 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 AUCTeX; see the file COPYING.  If not, write to the Free
+;; Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+;; 02110-1301, USA.
+
+;;; Commentary:
+
+;; This file contains startup code, autoloads and variables adapted to
+;; the local site configuration.  It is generated and placed by the
+;; installation procedure and should not be edited by hand, nor moved
+;; to a different place, as some settings may be established relative
+;; to the file.
+
+;; All user customization should be done with
+;; M-x customize-variable RET
+
+;;; Code:
+
+(if (< emacs-major-version 21)
+  (error "AUCTeX requires Emacs 21 or later"))
+
+;; Define here in order for `M-x customize-group <RET> AUCTeX <RET>'
+;; to work if the main AUCTeX files are not loaded yet.
+(defgroup AUCTeX nil
+  "A (La)TeX environment."
+  :tag "AUCTeX"
+  :link '(custom-manual "(auctex)Top")
+  :link '(url-link :tag "Home Page" "http://www.gnu.org/software/auctex/";)
+  :prefix "TeX-"
+  :group 'tex
+  :load "tex" :load "latex" :load "tex-style")
+
+(defvar TeX-lisp-directory
+  (file-name-directory load-file-name)
+  "The directory where most of the AUCTeX lisp files are located.
+For the location of lisp files associated with
+styles, see the variables TeX-style-* (hand-generated lisp) and
+TeX-auto-* (automatically generated lisp).")
+
+(add-to-list 'load-path TeX-lisp-directory)
+
+(defvar TeX-data-directory
+  (file-name-directory load-file-name)
+  "The directory where the AUCTeX non-Lisp data is located.")
+
+(defcustom TeX-auto-global
+    (if (file-writable-p "/usr/local/var/auctex") "/usr/local/var/auctex" 
"~/.emacs.d/auctex")
+  "*Directory containing automatically generated information.
+Must end with a directory separator.
+
+For storing automatic extracted information about the TeX macros
+shared by all users of a site."
+  :group 'TeX-file
+  :type 'directory)
+
+(defconst TeX-mode-alist
+  '((tex-mode . tex-mode)
+    (plain-tex-mode . tex-mode)
+    (texinfo-mode . texinfo)
+    (latex-mode . tex-mode)
+    (doctex-mode . tex-mode))
+  "Alist of built-in TeX modes and their load files.")
+
+(defalias 'TeX-load-hack 'ignore)
+
+(add-hook 'tex-site-unload-hook
+         (lambda ()
+           (let ((list after-load-alist))
+             (while list
+               ;; Adapted copy of the definition of `assq-delete-all'
+               ;; from Emacs 21 as substitute for
+               ;; `(assq-delete-all'TeX-modes-set (car list))' which
+               ;; fails on non-list elements in Emacs 21.
+               (let* ((alist (car list))
+                      (tail alist)
+                      (key 'TeX-modes-set))
+                 (while tail
+                   (if (and (consp (car tail))
+                            (eq (car (car tail)) key))
+                       (setq alist (delq (car tail) alist)))
+                   (setq tail (cdr tail))))
+               (setq list (cdr list))))
+           (setq load-path (delq TeX-lisp-directory load-path))))
+
+(defun TeX-modes-set (var value &optional update)
+  "Set VAR (which should be `TeX-modes') to VALUE.
+
+This places either the standard or the AUCTeX versions of
+functions into the respective function cell of the mode.
+If UPDATE is set, a previously saved value for
+the non-AUCTeX function gets overwritten with the current
+definition."
+  (custom-set-default var value)
+  (let ((list TeX-mode-alist) elt)
+    (while list
+      (setq elt (car (pop list)))
+      (when (or update (null (get elt 'tex-saved)))
+       (when (fboundp elt)
+         (put elt 'tex-saved (symbol-function elt))))
+      (defalias elt
+       (if (memq elt value)
+           (intern (concat "TeX-" (symbol-name elt)))
+         (get elt 'tex-saved))))))
+
+(defcustom TeX-modes
+  (mapcar 'car TeX-mode-alist)
+  "List of modes provided by AUCTeX.
+
+This variable can't be set normally; use customize for that, or
+set it with `TeX-modes-set'."
+  :type (cons 'set
+             (mapcar (lambda(x) (list 'const (car x))) TeX-mode-alist))
+  :set 'TeX-modes-set
+  :group 'AUCTeX
+  :initialize (lambda (var value)
+               (custom-initialize-reset var value)
+               (let ((list TeX-mode-alist))
+                 (while list
+                   (eval-after-load (cdar list)
+                     `(TeX-modes-set ',var ,var t))
+                   (setq list (cdr list))))))
+
+(defconst AUCTeX-version "11.87.2012-12-04"
+    "AUCTeX version.
+If not a regular release, the date of the last change.")
+
+(defconst AUCTeX-date "2012-12-04"
+  "AUCTeX release date using the ISO 8601 format, yyyy-mm-dd.")
+
+;; Store bibitems when saving a BibTeX buffer
+(add-hook 'bibtex-mode-hook 'BibTeX-auto-store)
+
+(provide 'tex-site)