
Version
-------
This is zsh version 2.5.03


Installing zsh
--------------
The instructions for compiling zsh are in the file INSTALL.
If you have used zsh before, please be sure to read the section
"Important Changes" below.


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.


Documentation
-------------
There are a number of documents about zsh in this distribution:

man/zsh.1	A man page in nroff format.  This will be installed in
		/usr/local/man/man1 by "make install.man" or "make install".

doc/zsh.info*   Everything the man page has, but in info format.  This will
		be installed in /usr/local/info by "make install.info" or
		"make install".


Also include in the distribution are:

doc/intro.ms	An introduction to zsh in troff format using the ms
		macros.  This document explains many of the features
		that make zsh more equal than other shells.

doc/zsh.texi	Everything the man page has, but in texinfo format.


If you do not have the necessary tools to process these documents,
postscript, and ascii versions are available in the separate file
zsh-doc.tar.gz at the archive sites listed below.

The distribution also contains a help directory with descriptions of
builtin commands taken from the man page.  The example function
examples/func/run-help will view the appropriate file from the help directory,
set in the HELPDIR variable, or run 'man' if such a file is not
available.


Archive Sites
-------------
The main archive site for zsh is:
ftp.math.gatech.edu:/pub/zsh

There are mirror sites at:
ftp.sterling.com:/zsh
ftp.cenatls.cena.dgac.fr:/pub/shells/zsh


Important Changes
-----------------
This is a list of changes in zsh compared to version 2.3.1 which might
force you to change your old initialization files.

The -h option to compctl for host completion no longer exists.  Define
a hosts variable and use compctl -k hosts instead.  Example: change
compctl -h ping
to
compctl -k hosts ping

The hostcmds, bindcmds, optcmds and varcmds special arrays no longer
exist.  Use compctl -k hosts, -b, -o and -v respectively.

The NO_UNSET option applies to the positional parameters (usually the
arguments to a script) as well as to all other parameters.

There is a new option CSH_JUNKIE_PAREN which has to be set to allow
the csh-syntax "if (test) { foo }" to work.  This has been done to
enhance sh compatibility, where "if (test)" might be used to run
"test" in a subshell.


Examples
--------
Examples of zsh start-up files are located in ./examples/dots.
Examples of zsh functions      are located in ./examples/func.
Examples of zsh scripts        are located in ./examples/scripts.
Examples of completion control commands (compctl) are located
in ./examples/misc/compctl-examples.


Feedback and Bug Reports
------------------------
Zsh is currently maintained by the members of the zsh mailing list.
Please send any feedback and bugs reports to: zsh-list@sterling.com

If you send a bug report to the list and are not a subscriber,
please mention this in your message if you want a response.

There is a script called "reporter" in examples/scripts which
will print out your current shell evironment/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.

The known bugs in zsh are listed in the file ./etc/BUGS.  Check this
before sending a bug report.  Also, a copy of the Frequently Asked
Questions (FAQ) list is located in the file .etc/FAQ.


Zsh Mailing List
----------------
If you wish to subscribe to the zsh mailing list,
send an e-mail message to

	majordomo@sterling.com

containing the line

	subscribe zsh-list <optional-address>

where <optional-address> can be blank if you want to subscribe from
your current e-mail address.  Send the message `help' to the same
address for help on the list server; `unsubscribe zsh-list' also
works. (Don't send this to the list!). The list manager, Rick Ohnemus,
can be reached at

	owner-zsh-list@sterling.com


Contributors
------------
The people who have contributed to this software project
are listed in ./etc/CONTRIBUTORS.

