about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2005-02-02 12:55:18 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2005-02-02 12:55:18 +0000
commitc5d4fd21952e4e3a8d95ebfac2fde9737dd0ab6a (patch)
tree555f962682d7546475bbb6e009546c522578d103 /README
parentef4e06605e313945b0a2f22e28ca455f3dd979dd (diff)
downloadzsh-c5d4fd21952e4e3a8d95ebfac2fde9737dd0ab6a.tar.gz
zsh-c5d4fd21952e4e3a8d95ebfac2fde9737dd0ab6a.tar.xz
zsh-c5d4fd21952e4e3a8d95ebfac2fde9737dd0ab6a.zip
Update files to 4.2.4
Diffstat (limited to 'README')
-rw-r--r--README133
1 files changed, 92 insertions, 41 deletions
diff --git a/README b/README
index 6b47a99ce..62445aade 100644
--- a/README
+++ b/README
@@ -5,49 +5,97 @@ THE Z SHELL (ZSH)
 Version
 -------
 
-This is zsh version 3.1 (beta)
-
-Note that this is a beta version.  The latest stable version is zsh-3.0.6.
+This is zsh version 4.2.4.  This is a stable version.
 
 Installing Zsh
 --------------
 
 The instructions for compiling zsh are in the file INSTALL.  You should
-also check the file MACHINES in the subdirectory Etc to see if there
+also check the file MACHINES in the top directory to see if there
 are any special instructions for your particular architecture.
 
 Features
 --------
 
-Zsh is a shell with lots of features.  For a list of these, see the
-file Etc/FEATURES, and for the latest changes see Etc/NEWS.  For more
+Zsh is a shell with lots of features.  For a list of some of these, see the
+file FEATURES, and for the latest changes see NEWS.  For more
 details, see the documentation.
 
-Possibile incompatibilities
+Possible 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.
+Currently the only known incompatibilities between 4.2.0 and later
+versions are minor:
+
+
+Since 4.2.1:
+
+The "test" and "[" builtins now behave more like relevant Unix standards
+suggest they should.  Previously they were a simple front-end to the same
+tests used by zsh's "[[" syntax.  (The documentation was previously cagey
+about what "test" and "[" actually did.)  "[[" has always been the
+recommended way of implementing tests within zsh.
+
+In recent versions of zsh, typing the end-of-file (EOF) character
+(typically ^D, although this can be altered with the "stty" command)
+repeatedly in the line editor printed a warning message, but never exited the
+shell.  This was a departure from the traditional behaviour of zsh and
+other shells where the shell would exit after 10 EOFs.  The traditional
+behaviour has been restored.  Also, binding a user-defined editor command
+to the EOF character now suppresses the EOF behaviour inside the line
+editor; it is possible to emulate it if desired.
+
+
+From 4.2.0 to 4.2.1:
+
+IPv6 addresses must be specified in square brackets in the zftp module and
+the function system built on top of the zftp module.
+
+Special traps for pseudosignals ZERR, DEBUG and EXIT are no longer executed
+inside other traps.  Users may well have assumed this was the case anyway
+since the behaviour was not explicity documented.  See the NEWS file for
+more detail.
+
+By default, a maximum function depth of 4096 is now compiled into the
+shell.  This may be altered during configuration; see `Function depth' in
+INSTALL.
+
+
+Some particular differences you may notice between the 4.0 and 4.2 series
+of releases:
+
+The bash-compatibility zle functions described in the zshcontrib manual
+page have been removed as a more configurable set of editing widgets for
+dealing with words have been added.  The following code in .zshrc will set
+up for bash-style word handling:
+  autoload -U select-word-style
+  select-word-style bash
+
+The `=prog' facility for expanding command paths (provided the EQUALS
+option is enabled, as it is by default) no longer expands aliases.  It was
+felt this feature was underused and confusing.
+
+In 4.0, a literal `/' was quoted in the `src' text of a substitution of the
+form `${foo/src/rep}' or ${foo//src/rep} with two backslashes.  This was
+documented, but inconsistent with normal quoting conventions and poorly
+implemented.  The `/' now requires only one backslash to quote it whether
+or not the expression occurs in double quotes.  For example:
+  % foo=word/bird
+  % print ${foo/\//-} "${foo/\//+}"
+  word-bird word+bird
+Note also the following workaround which is valid in all versions of the
+shell that support this syntax:
+  % slash=/
+  % foo=word/bird
+  % print ${foo/$slash/-} "${foo/$slash/+}"
+
+In 4.0, the -M option to bindkey used the first non-option argument to
+specify the keymap, whereas it now uses an argument to the option.  Hence:
+  bindkey -M -R keymap a-z self-insert
+needs to be rewritten as
+  bindkey -M keymap -R a-z self-insert
+The following form works in both versions:
+  bindkey -R -M keymap a-z self-insert
 
 Documentation
 -------------
@@ -59,7 +107,7 @@ Doc/Zsh/*.yo	The master source for the zsh documentation is written in
 		It is not required by zsh but but it is a nice program so
 		you might want to get it anyway, especially if you are a
 		zsh developer.  It can be downloaded from
-		ftp://ftp.icce.rug.nl/pub/unix/yodl*
+		ftp://ftp.lilypond.org/pub/yodl/
 
 Doc/zsh*.1	Man pages in nroff format.  These will be installed
 		by "make install.man" or "make install".  By default,
@@ -73,7 +121,8 @@ Doc/zsh.texi	Everything the man pages have, but in texinfo format.  These
 		By default, these will be installed in /usr/local/info,
 		although you can change this with the --infodir option to
 		configure or editing the user configuration section of the
-		top level Makefile.
+		top level Makefile.  Version 4.0 or above of the
+		Texinfo tools are recommended for processing this file.
 
 Also include in the distribution are:
 
@@ -84,9 +133,11 @@ Doc/intro.ms	An introduction to zsh in troff format using the ms
 		may not work without changes but it is still a good
 		introduction.
 
+For more information, see the website, as described in the META-FAQ.
+
 If you do not have the necessary tools to process these documents,
 PostScript, ASCII, Info and DVI versions are available in the separate
-file zsh-beta-doc.tar.gz at the archive sites listed in the META-FAQ.
+file zsh-doc.tar.gz at the archive sites listed in the META-FAQ.
 
 The distribution also contains a Perl script in Utils/helpfiles which
 can be used to extract the descriptions of builtin commands from the
@@ -95,7 +146,7 @@ script about its usage.  The files created by this script can be used
 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
+the files generated by the helpfiles script.  run-help should be
 unaliased before loading the run-help function.  After that this function
 will be executed by the run-help ZLE function which is by default bound
 to ESC-h in emacs mode.
@@ -128,19 +179,19 @@ Zsh Maintenance and Bug Reports
 -------------------------------
 
 Zsh is currently maintained by the members of the zsh-workers mailing list
-and coordinated by Peter Stephenson <pws@zsh.org>.  Please send
-any feedback and bugs reports to <zsh-workers@sunsite.auc.dk>.
+and coordinated by Peter Stephenson <coordinator@zsh.org>.  Please send
+any feedback and bugs reports to <zsh-workers@sunsite.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
-use this script and include the output from sourcing this file.  This way,
-the problem you are reporting can be recreated.
-
-You can help even more if you can reproduce the bug starting zsh with
+Reports are most helpful if you can reproduce the bug starting zsh with
 the -f option.  This skips the execution of local startup files except
 /etc/zshenv.  If a bug occurs only when some options set try to locate
 the option which triggers the bug.
 
+There is a script "reporter" in the subdirectory Util which will print out
+your current shell environment/setup.  If you cannot reproduce the bug
+with "zsh -f", use this script and include the output from sourcing this
+file.  This way, the problem you are reporting can be recreated.
+
 The known bugs in zsh are listed in the file Etc/BUGS.  Check this as
 well as the Frequently Asked Questions (FAQ) list before sending a bug
 report.  Note that zsh has some features which are not compatible with