home *** CD-ROM | disk | FTP | other *** search
/ Big Green CD 8 / BGCD_8_Dev.iso / NEXTSTEP / UNIX / Shells / zsh-3.0.5-MIHS / src / README < prev    next >
Encoding:
Text File  |  1996-12-17  |  5.1 KB  |  120 lines
  1. $Id: README,v 2.3 1996/06/28 13:29:59 hzoli Exp $
  2.  
  3. Version
  4. -------
  5. This is zsh version 3.0
  6.  
  7. Installing Zsh
  8. --------------
  9. The instructions for compiling zsh are in the file INSTALL.  You should
  10. also check the file MACHINES in the subdirectory Etc to see if there
  11. are any special instructions for your particular architecture.
  12.  
  13. Features
  14. --------
  15. Zsh is a shell with lots of features.  For a list of these, see the
  16. file Etc/FEATURES.  For more details, see the documentation.
  17.  
  18. Documentation
  19. -------------
  20. There are a number of documents about zsh in this distribution:
  21.  
  22. Doc/zsh*.man    Man pages in nroff format.  These will be installed
  23.         by "make install.man" or "make install".  By default,
  24.         these will be installed in /usr/local/man/man1, although
  25.         you can change this with the --mandir option to configure
  26.         or editing the user configuration section of the top level
  27.         Makefile.
  28.  
  29. Doc/zsh.texi    Everything the man pages have, but in texinfo format.  These
  30.         will be installed by "make install.info" or "make install".
  31.         By default, these will be installed in /usr/local/info,
  32.         although you can change this with the --infodir option to
  33.         configure or editing the user configuration section of the
  34.         top level Makefile.
  35.  
  36. Also include in the distribution are:
  37.  
  38. Doc/intro.ms    An introduction to zsh in troff format using the ms
  39.         macros.  This document explains many of the features
  40.         that make zsh more equal than other shells.
  41.         Unfortunately this is based on zsh-2.5 so some examples
  42.         may not work without changes but it is still a good
  43.         introduction.
  44.  
  45. If you do not have the necessary tools to process these documents,
  46. postscript, and ascii, info and dvi versions are available in the
  47. separate file zsh-doc.tar.gz at the archive sites listed below.
  48.  
  49. The distribution also contains a perl script in Utils/helpfiles which
  50. can be used to extract the descriptions of builtin commands from the
  51. zshbuiltin manual page.  See the comments at the beginning of the script
  52. about its usage.  The files created by this script can be used by
  53. example function run-help located in the subdirectory Functions to show
  54. information about zsh builtins and run `man' on external commands.  For
  55. this the shell variable HELPDIR should point to a directory containing
  56. the fileles generated by the helpfiles script.  run-help should be
  57. unaliased before loading the run-help function.  After that this
  58. function will be executed by the run-help ZLE function which is by
  59. default bound to ESC-h in emacs mode.
  60.  
  61. Examples
  62. --------
  63. Examples of zsh startup files are located in the subdirectory
  64. StartupFiles.  Examples of zsh functions and scripts are located in
  65. the subdirectory Functions.  Examples of completion control commands
  66. (compctl) are located in the file Misc/compctl-examples.
  67.  
  68. Zsh Ftp Sites, Web Pages, and Mailing Lists
  69. -------------------------------------------
  70. The current list of zsh ftp sites, web pages, and mailing lists can be
  71. found in the META-FAQ.  A copy is included in this distribution and is
  72. available separately at any of the zsh ftp sites.
  73.  
  74. Common Problems and Frequently Asked Questions
  75. ----------------------------------------------
  76. Zsh has a list of Frequently Asked Questions (FAQ) maintained by
  77. Peter Stephenson <P.Stephenson@swansea.ac.uk>.  It covers many common
  78. problems encountered when building, installing, and using zsh.  A copy
  79. is included in this distribution in Etc/FAQ and is available separately
  80. at any of the zsh ftp sites.
  81.  
  82. Zsh Maintenance and Bug Reports
  83. -------------------------------
  84. Zsh is currently maintained by the members of the zsh-workers mailing list
  85. and coordinated by ZoltÆn HidvØgi <hzoli@cs.elte.hu>.  Please send
  86. any feedback and bugs reports to: zsh-workers@math.gatech.edu
  87.  
  88. There is a script "reporter" in the subdirectory Util which will print
  89. out your current shell environment/setup.  If you report a bug, please
  90. use this script and include the output from sourcing this file.  This way,
  91. the problem you are reporting can be recreated.
  92.  
  93. You can help even more if you can reproduce the bug starting zsh with
  94. the -f option.  This skips the execution of local startup files except
  95. /etc/zshenv.  If a bug occurs only when some options set try to locate
  96. the option which triggers the bug.
  97.  
  98. The known bugs in zsh are listed in the file Etc/BUGS.  Check this as
  99. well as the Frequently Asked Questions (FAQ) list before sending a bug
  100. report.  Note that zsh has some features which are not compatible with
  101. sh but these are not bugs.  Most of these incompatibilities go away
  102. when zsh is invoked as sh or ksh (e.g. using a symbolic link).
  103.  
  104. If you send a bug report to the list and are not a subscriber, please
  105. mention this in your message if you want a response.
  106.  
  107. If you would like to contribute to the development and maintenance of zsh,
  108. then you should join the zsh-workers mailing list (check the META-FAQ
  109. for info on this).  You should also read the "zsh-development-guide"
  110. located in the subdirectory Util.
  111.  
  112. Contributors
  113. ------------
  114. The people who have contributed to this software project are listed
  115. in Etc/CONTRIBUTORS.
  116.  
  117. -------------------------------------------------------------
  118. ZoltÆn HidvØgi          (Coordinator, Zsh Development Group)
  119. hzoli@cs.elte.hu
  120.