$Id: README,v 1.22 1995/05/26 09:30:22 coleman Exp coleman $

Version
-------
This is zsh version 2.6 (beta9)

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
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.  For more details, see the documentation.

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

Doc/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 tex-info 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 run-help
located in the subdirectory Functions will view the appropriate file
from the help directory, set in the HELPDIR variable, or run 'man' if
such a file is not available.

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 startup files are located in the subdirectory
Startup_Files.  Examples of zsh functions and scripts are located in
the subdirectory Functions.  Examples of completion control commands
(compctl) are located in the file Misc/compctl-examples.

Zsh Ftp Sites, Web Pages, and Mailing Lists
-------------------------------------------
The current list of zsh ftp sites, web pages, and mailing lists can be
found in the META-FAQ.  A copy is included in this distribution and is
available separately at any of the zsh ftp sites.

Common Problems and Frequently Asked Questions
----------------------------------------------
Zsh has a list of Frequently Asked Questions (FAQ) maintained by
Peter Stephenson <P.Stephenson@swansea.ac.uk>.  It covers many common
problems encountered when building, installing, and using zsh.  A copy
is included in this distribution in Etc/FAQ and is available separately
at any of the zsh ftp sites.

Zsh Maintenance and Bug Reports
-------------------------------
Zsh is currently maintained by the members of the zsh-workers mailing list
and coordinated by Richard Coleman <zsh@math.gatech.edu>.  Please send
any feedback and bugs reports to: zsh-workers@math.gatech.edu

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.

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.

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.

If you would like to contribute to the development and maintenance of zsh,
then you should join the zsh-workers mailing list (check the META-FAQ
for info on this).  You should also read the "zsh-development-guide"
located in the subdirectory Util.

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

Richard Coleman          (Coordinator, Zsh Development Group)
zsh@math.gatech.edu      (zsh e-mail)
coleman@math.gatech.edu  (general e-mail)

