README changes for 3.1.6

[Peter Stephenson <pws@xxxxxxxxxxxxxxxxx>]

This is what I'm planning to do with the main README file for the 3.1.6
release.

It's currently a bit premature to mention 3.0.6 as the last stable release,
although it's pretty certain to be so for most of the life of 3.1.6.  Maybe
we can still arrange to release the versions together.

Also note the list of possible incompatibilities with the previous release.
There are only three fairly small ones.  Maybe other people have
encountered more of these?

I also realised Zoli and Zefram were gradually being edited out of
Etc/CONTRIBUTORS --- that's partly because 3.1.x, as a beta version, hasn't
had so much stuff on maintainers and contributors in.  It's a bit late to
do this properly for 3.1.1-3.1.5, unfortunately, so I've just stuck a short
note in.  But it could really do with some going through the Changelog to
note things like complete rewrites of the editor and the dynamic loading
system, for example.  I don't suppose anybody's going to volunteer for
that.

--- README~	Tue Apr 13 09:41:28 1999
+++ README	Wed Jul 21 10:34:56 1999
@@ -7,7 +7,7 @@
 
 This is zsh version 3.1 (beta)
 
-Note that this is a beta version.  The latest stable version is zsh-3.0.5.
+Note that this is a beta version.  The latest stable version is zsh-3.0.6.
 
 Installing Zsh
 --------------
@@ -20,7 +20,34 @@
 --------
 
 Zsh is a shell with lots of features.  For a list of these, see the
-file Etc/FEATURES.  For more details, see the documentation.
+file Etc/FEATURES, and for the latest changes see Etc/NEWS.  For more
+details, see the documentation.
+
+Possibile incompatibilities
+---------------------------
+
+If you have been using recent versions of zsh 3.1, the following changes in
+the shell may affect you:
+- The traditional bindings of \M-n (history-search-backward) and
+  \M-p (history-search-forward) in older versions of zsh have returned,
+  as has the traditional behaviour of those functions and the functions
+  up-line-or-search and down-line-or-search.  In 3.1.5, the functions
+  behaved differently and \M-n and \M-p were bound by default to
+  history-beginning-search-backward and history-beginning-search-forward.
+- Prompt truncation behaviour via %<...< and %>...> (or %[<...] etc.) has
+  changed slightly:  the string to be truncated runs to the end of the
+  prompt or to the next truncation sequence; %<< will turn off truncation.
+  Previously it only covered individual prompt escapes.  So for example the
+  prompt `%10<...<%~%% ' will now include the `%% ' in the string to be
+  truncated, and you should change the prompt to `%10<...<%~%<<%% ' to turn
+  off truncation immediately after the `%~'.
+- If for some reason you have `setopt norcs' or `unsetopt rcs' anywhere in
+  your startup files (e.g. to stop .zlogout being run), this will now
+  take effect immediately, preventing later startup files from being
+  run.  It is safe to put `setopt norcs' in .zlogin as this is always
+  the last run.
+
+See the FAQ for a discussion of changes over the longer term.
 
 Documentation
 -------------
@@ -65,7 +92,7 @@
 can be used to extract the descriptions of builtin commands from the
 zshbuiltins manual page.  See the comments at the beginning of the
 script about its usage.  The files created by this script can be used
-by example function run-help located in the subdirectory Functions to
+by example function run-help located in the subdirectory Functions/Misc to
 show information about zsh builtins and run `man' on external commands.
 For this the shell variable HELPDIR should point to a directory containing
 the fileles generated by the helpfiles script.  run-help should be
@@ -101,8 +128,8 @@
 -------------------------------
 
 Zsh is currently maintained by the members of the zsh-workers mailing list
-and coordinated by Andrew Main (Zefram) <zefram@xxxxxxx>.  Please send
-any feedback and bugs reports to <zsh-workers@xxxxxxxxxxxxxxx>.
+and coordinated by Peter Stephenson <pws@xxxxxxx>.  Please send
+any feedback and bugs reports to <zsh-workers@xxxxxxxxxxxxxx>.
 
 There is a script "reporter" in the subdirectory Util which will print
 out your current shell environment/setup.  If you report a bug, please
--- Etc/CONTRIBUTORS~	Tue Jul 20 14:36:07 1999
+++ Etc/CONTRIBUTORS	Wed Jul 21 10:41:08 1999
@@ -50,6 +50,9 @@
 Jarausch, Phil Pennock, Wilfredo Sanchez, Bruce Stephens, Gene Cohler,
 Ollivier Robert.
 
+Previous versions of zsh 3 were maintained by Zoltán Hidvégi and Andrew
+Main (Zefram).
+
 Version 3.0
 -----------
 

-- 
Peter Stephenson <pws@xxxxxxxxxxxxxxxxx>       Tel: +39 050 844536
WWW:  http://www.ifh.de/~pws/
Dipartimento di Fisica, Via Buonarroti 2, 56127 Pisa, Italy