#
# $Id: README,v 1.18 1995/04/27 00:13:23 coleman Exp coleman $
#

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

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:

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

Zsh Ftp Sites
-------------
The main archive site for zsh is:

   ftp://ftp.math.gatech.edu/pub/zsh

There are mirror sites at:

   ftp://ftp.sterling.com/zsh
   ftp://ftp.rge.com/pub/zsh
   ftp://ftp.cenatls.cena.dgac.fr/pub/shells/zsh
   ftp://mrrl.lut.ac.uk/zsh
   ftp://ftp.fu-berlin.de/pub/unix/shells/zsh
   ftp://ftp.ips.oz.au/pub/packages/zsh

Zsh Web Page
------------
Zsh has a web page maintained by Mark Borges <mdb@cdc.noaa.gov>
which is located at:
   http://www.mal.com/zsh/zsh_home.shtml

Zsh Mailing Lists
-----------------
Zsh currently has two mailing lists:

zsh-announce@sterling.com
zsh-list@sterling.com

Zsh-announce@sterling.com is for announcements of new versions.
Zsh-list@sterling.com is for user questions, patches, and development
discussions.  Postings to zsh-announce are automatically forwarded to
zsh-list, so you need not join both lists.  To subscribe to either list,
send e-mail to majordomo@sterling.com with the body

	subscribe zsh-list <optional-address>
or
	subscribe zsh-announce <optional-address>

depending on which list you wish to join.  The <optional-address> can
be blank if you want to subscribe from your current e-mail address.
To get help on the mailing list server, you can send the message "help"
to the list server (majordomo@sterling.com).  To unsubscribe, use the
analogous mail message bodies "unsubscribe zsh-announce" and "unsubscribe
zsh-list".  Please do not send these messages to the lists themselves.
If you have any problems, you can contact the list maintainer, Rick
Ohnemus, at owner-zsh-list@sterling.com

Zsh Maintenance and Bug Reports
-------------------------------
Zsh is currently maintained by the members of the zsh mailing list and
coordinated by Richard Coleman <zsh@math.gatech.edu>.  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.

If you would like to contribute to the development and maintenance of zsh,
please read the file "zsh-development-guide" in the Utils subdirectory.

There is a script called "reporter" in ./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.  A copy of FAQ is located in the file ./Etc/FAQ in the zsh
distribution.  Also, the latest version of the FAQ is always available
separately in any of the zsh ftp sites.

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)

