about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 32 insertions, 5 deletions
diff --git a/README b/README
index 6a591b263..6b47a99ce 100644
--- a/README
+++ b/README
@@ -7,7 +7,7 @@ Version
 
 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 @@ Features
 --------
 
 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 @@ The distribution also contains a Perl script in Utils/helpfiles which
 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 Maintenance and Bug Reports
 -------------------------------
 
 Zsh is currently maintained by the members of the zsh-workers mailing list
-and coordinated by Andrew Main (Zefram) <zefram@zsh.org>.  Please send
-any feedback and bugs reports to <zsh-workers@math.gatech.edu>.
+and coordinated by Peter Stephenson <pws@zsh.org>.  Please send
+any feedback and bugs reports to <zsh-workers@sunsite.auc.dk>.
 
 There is a script "reporter" in the subdirectory Util which will print
 out your current shell environment/setup.  If you report a bug, please