annotate README @ 25986:29aeb35781cd

Added support for indenting existing scripts. (sh-mode-map): Added new bindings. (sh-mode): Updated mode doc-string for new commands, added make-local-variable calls, initialize mode-specific variables. (sh-indent-line): Renamed to sh-basic-indent-line; sh-indent-line is now a different function. (sh-header-marker): Changed docstring. (sh-set-shell): Initialize mode-specific variables. (sh-case, sh-for, sh-if, sh-indexed-loop, sh-repeat, sh-select) (sh-tmp-file, sh-until, sh-until, sh-while, sh-while-getopts): Changed these define-skeleton calls to work with user-specified indentation settings. (sh-basic-indent-line, sh-blink, sh-calculate-indent) (sh-check-paren-in-case, sh-check-rule, sh-do-nothing) (sh-electric-hash, sh-electric-less, sh-electric-rparen) (sh-find-prev-matching, sh-find-prev-switch, sh-get-indent-info) (sh-get-indent-var-for-line, sh-get-kw, sh-get-word) (sh-goto-match-for-done, sh-goto-matching-case, sh-goto-matching-if) (sh-guess-basic-offset, sh-handle-after-case-label) (sh-handle-prev-case, sh-handle-prev-case-alt-end, sh-handle-prev-do) (sh-handle-prev-done, sh-handle-prev-else, sh-handle-prev-esac) (sh-handle-prev-fi, sh-handle-prev-if, sh-handle-prev-open) (sh-handle-prev-rc-case, sh-handle-prev-then, sh-handle-this-close) (sh-handle-this-do, sh-handle-this-done, sh-handle-this-else) (sh-handle-this-esac, sh-handle-this-fi, sh-handle-this-rc-case) (sh-handle-this-then, sh-help-string-for-variable) (sh-in-comment-or-string, sh-indent-line, sh-learn-buffer-indent) (sh-learn-line-indent, sh-load-style, sh-make-vars-local, sh-mark-init) (sh-mark-line, sh-mkword-regexpr, sh-mkword-regexp) (sh-must-be-shell-mode, sh-must-support-indent, sh-name-style) (sh-prev-line, sh-prev-stmt, sh-prev-thing, sh-read-variable) (sh-remove-our-text-properties, sh-rescan-buffer) (sh-reset-indent-vars-to-global-values, sh-safe-backward-sexp) (sh-safe-forward-sexp, sh-save-styles-to-buffer, sh-scan-buffer) (sh-scan-case, sh-search-word, sh-set-char-syntax) (sh-set-here-doc-region, sh-set-indent, sh-set-var-value) (sh-show-indent, sh-this-is-a-continuation, sh-var-value): New functions. (sh-debug, sh-electric-rparen-needed, sh-here-doc-syntax) (sh-indent-supported, sh-kw, sh-kw-alist, sh-kws-for-done) (sh-learned-buffer-hook, sh-make-vars-local, sh-regexp-for-done) (sh-special-keywords, sh-special-syntax, sh-st-punc, sh-styles-alist) (sh-var-list): New variables.

This directory tree holds version 20.0 of GNU Emacs, the extensible,
customizable, self-documenting real-time display editor.

You may encounter bugs in this release.  If you do, please report
them; your bug reports are valuable contributions to the FSF, since
they allow us to notice and fix problems on machines we don't have, or
in code we don't use often.  See the file BUGS for more information on
how to report bugs.

See the files `etc/NEWS' and `etc/news.texi' for information on new
features and other user-visible changes since the last version of
Emacs.

The file INSTALL in this directory says how to bring up GNU Emacs on
Unix, once you have loaded the entire subtree of this directory.

The file etc/PROBLEMS contains information on many common problems that
occur in building, installing and running Emacs.

Reports of bugs in Emacs should be sent to the mailing list
[e-mail].  See the "Bugs" section of the Emacs
manual for more information on how to report bugs.  (The file `BUGS'
in this directory explains how you can find and read that section
using the Info files that come with Emacs.)  See `etc/MAILINGLISTS'
for more information on mailing lists relating to GNU packages.

The `etc' subdirectory contains several other files, named in
capital letters, which you should look at when installing GNU Emacs.

The file `configure' is a shell script to acclimate Emacs to the
oddities of your processor and operating system.  It creates the file
`Makefile' (a script for the `make' program), which automates the
process of building and installing Emacs.  See INSTALL for more
detailed information.

The file `configure.in' is the input used by the autoconf program to
construct the `configure' script.  Since Emacs has configuration
requirements that autoconf can't meet, `configure.in' uses an unholy
marriage of custom-baked configuration code and autoconf macros; it
may be wise to avoid rebuilding `configure' from `configure.in' when
possible.

The file `Makefile.in' is a template used by `configure' to create
`Makefile'.

The file `make-dist' is a shell script to build a distribution tar
file from the current Emacs tree, containing only those files
appropriate for distribution.  If you make extensive changes to Emacs,
this script will help you distribute your version to others.

There are several subdirectories:

`src' holds the C code for Emacs (the Emacs Lisp interpreter and its
    primitives, the redisplay code, and some basic editing functions).
`lisp' holds the Emacs Lisp code for Emacs (most everything else).
`lib-src' holds the source code for some utility programs for use by
    or with Emacs, like movemail and etags.
`etc' holds miscellaneous architecture-independent data files
    Emacs uses, like the tutorial text and the Zippy the Pinhead quote
    database.  The contents of the `lisp', `info' and `man'
    subdirectories are architecture-independent too.

`info' holds the Info documentation tree for Emacs.
`man' holds the source code for the Emacs manual.

   Note that the Emacs Lisp manual sources are distributed separately.
(They are twice as large as the Emacs manual in the man subdirectory.)

`msdos' holds configuration files for compiling Emacs under MSDOG.
`vms' holds instructions and useful files for running Emacs under VMS.
`nt' holds various command files and documentation files that pertain
    to running Emacs on Windows NT.