Z-Shell (zsh) FAQ changes this month

[Peter Stephenson <pws@xxxxxxxxxxxxxxxxxxxxxxxx>]

This file contains general information on how to find out about zsh,
(the first part of the FAQ up to item 1.1), then any other items which
have changed since last month's posting, then the differences in the
yodl version of the FAQ.  If you would like a complete individual
copy, email me and I will add you to the list.


Changes since issue posted February 2000:

3.25 Now question: coloured prompts on colour xterms.

This document contains a list of frequently-asked (or otherwise
significant) questions concerning the Z-shell, a command interpreter
for many UNIX systems which is freely available to anyone with FTP
access.  Zsh is among the most powerful freely available Bourne-like
shell for interactive use.

If you have never heard of `sh', `csh' or `ksh', then you are
probably better off to start by reading a general introduction to UNIX
rather than this document.

If you just want to know how to get your hands on the latest version,
skip to question 1.6; if you want to know what to do with
insoluble problems, go to 5.2.

Notation: Quotes `like this' are ordinary textual quotation
marks.  Other uses of quotation marks are input to the shell.

Contents:
Chapter 1:  Introducing zsh and how to install it
1.1. Sources of information
1.2. What is it?
1.3. What is it good at?
1.4. On what machines will it run?  (Plus important compilation notes)
1.5. What's the latest version?
1.6. Where do I get it?
1.7. I don't have root access: how do I make zsh my login shell?

Chapter 2:  How does zsh differ from...?
2.1. sh and ksh?
2.2. csh?
2.3. Why do my csh aliases not work?  (Plus other alias pitfalls.)
2.4. tcsh?
2.5. bash?
2.6. Shouldn't zsh be more/less like ksh/(t)csh?

Chapter 3:  How to get various things to work
3.1. Why does `$var' where `var="foo bar"' not do what I expect?
3.2. In which startup file do I put...?
3.3. What is the difference between `export' and the ALL_EXPORT option?
3.4. How do I turn off spelling correction/globbing for a single command?
3.5. How do I get the meta key to work on my xterm?
3.6. How do I automatically display the directory in my xterm title bar?
3.7. How do I make the completion list use eight bit characters?
3.8. Why do the cursor (arrow) keys not work?
3.9. Why does my terminal act funny in some way?
3.10. Why does zsh not work in an Emacs shell mode any more?
3.11. Why do my autoloaded functions not autoload [the first time]?
3.12. How does base arithmetic work?
3.13. How do I get a newline in my prompt?
3.14. Why does `bindkey ^a command-name' or 'stty intr ^-' do something funny?
3.15. Why can't I bind \C-s and \C-q any more?
3.16. How do I execute command `foo' within function `foo'?
3.17. Why do history substitutions with single bangs do something funny?
3.18. Why does zsh kill off all my background jobs when I logout?
3.19. How do I list all my history entries?
3.20. How does the alternative loop syntax, e.g. `while {...} {...}' work?
3.21. Why is my history not being saved?
3.22. How do I get a variable's value to be evaluated as another variable?
3.23. How do I prevent the prompt overwriting output when there is no newline?
3.24. What's wrong with cut and paste on my xterm?
3.25. How do I get coloured prompts on my colour xterm?

Chapter 4:  The mysteries of completion
4.1. What is completion?
4.2. What sorts of things can be completed?
4.3. How does zsh deal with ambiguous completions?
4.4. How do I complete in the middle of words / just what's before the cursor?
4.5. How do I get started with programmable completion?
4.6. And if programmable completion isn't good enough?

Chapter 5:  The future of zsh
5.1. What bugs are currently known and unfixed? (Plus recent important changes)
5.2. Where do I report bugs, get more info / who's working on zsh?
5.3. What's on the wish-list?
5.4. Will zsh have problems in the year 2000?

Acknowledgments

Copyright
--- End of Contents ---

Chapter 1: Introducing zsh and how to install it

1.1: Sources of information

  Information on zsh is available via the World Wide Web.  The URL
  is http://sunsite.auc.dk/zsh/ .
  The server provides this FAQ and much else and is
  now maintained by Karsten Thygesen and others (mail zsh@xxxxxxxxxxxxxx
  with any related messages).  The FAQ is at http://sunsite.auc.dk/zsh/FAQ/ .
  The site also contains some contributed zsh scripts and functions;
  we are delighted to add more, or simply links to your own collection.

  This document was originally written in YODL, allowing it to be converted
  easily into various other formats.  The master source file lives at
  http://sunsite.auc.dk/zsh/FAQ/zshfaq.yo and the plain text version
  can be found at http://sunsite.auc.dk/zsh/FAQ/zshfaq.txt .

  Another useful source of information is the collection of FAQ articles
  posted frequently to the Usenet news groups comp.unix.questions,
  comp.unix.shells and comp.answers with answers to general questions
  about UNIX.  The fifth of the seven articles deals with shells,
  including zsh, with a brief description of differences.  There is
  also a separate FAQ on shell differences and how to change your
  shell.  Usenet FAQs are available via FTP from rtfm.mit.edu and
  mirrors and also on the World Wide Web; see

    USA         http://www.cis.ohio-state.edu/hypertext/faq/usenet/top.html
    UK          http://www.lib.ox.ac.uk/internet/news/faq/comp.unix.shell.html
    Netherlands http://www.cs.uu.nl/wais/html/na-dir/unix-faq/shell/.html

  You can also get it via email by emailing mail-server@xxxxxxxxxxxx
  with, in the body of the message, `send faqs/unix-faq/shell/zsh'.

  The latest version of this FAQ is also available directly from any
  of the zsh archive sites listed in question 1.6.

  I have been putting together a user guide to complement the manual by
  explaining the most useful features of zsh in a more easy to read way.
  This will be a long project, but a partial version describing how to
  write startup files and how to use the new, more powerful, form for
  completion which first appeared in 3.1.6 (and is not described in this
  FAQ) can be seen by looking at
    http://www.pwstephenson.fsnet.co.uk/computing/
  where it exists in various formats.

  (As a method of reading the following in Emacs, you can type \M-2
  \C-x $ to make all the indented text vanish, then \M-0 \C-x $
  when you are on the title you want.)

  For any more eclectic information, you should contact the mailing
  list:  see question 5.2.

--- End of general information, changed items follow in full ---

3.25: How do I get coloured prompts on my colour xterm?

(Or `color xterm', if you're reading this in black and white.)  You need to
find the sequences which generate the various colours from the manual;
these are ANSI standard on the terminal emulators I know about which
support colour.  With a recent (post 3.1.6) distribution of zsh, there is a
theme system to handle this for you; even if you don't see that, the
installed function ``colors'' (meaning `colours', if you're not reading
this in black and white) gives the escape sequences.  You will end up with
code looking like this (borrowed from Oliver Kiddle):

  PS1=$'%{\e[1;31m%}<the rest of your prompt here>%{\e[0m%}'

The `$'' form of quoting turns the ``\e'' into a real escape
character.  The ``%{...%}'' is used in prompts for strings which will
not appear as characters, so that the prompt code doesn't miscalculate the
length of the prompt which would have a bad effect on editing.  The
resulting ``<ESC>[1;31m'' makes the prompt red, and the
``<ESC>[0m'' puts printing back to normal so that the rest of the line
is unchanged.

--- End of changed items, diff from previous version follows ---

Index: zshfaq.yo
===================================================================
RCS file: /pack/anoncvs/zsh/www/FAQ/zshfaq.yo,v
retrieving revision 1.52
retrieving revision 1.53
diff -u -r1.52 -r1.53
--- zshfaq.yo	2000/02/23 20:41:58	1.52
+++ zshfaq.yo	2000/03/24 20:55:34	1.53
@@ -43,20 +43,20 @@
 whenman(report(ARG1)(ARG2)(ARG3))\
 whenms(report(ARG1)(ARG2)(ARG3))\
 whensgml(report(ARG1)(ARG2)(ARG3)))
-myreport(Z-Shell Frequently-Asked Questions)(Peter Stephenson)(2000/02/23)
+myreport(Z-Shell Frequently-Asked Questions)(Peter Stephenson)(2000/03/24)
 COMMENT(-- the following are for Usenet and must appear first)\
 description(\
 mydit(Archive-Name:) unix-faq/shell/zsh
-mydit(Last-Modified:) 2000/02/23
+mydit(Last-Modified:) 2000/03/24
 mydit(Submitted-By:) email(pws@xxxxxxxxxxxxxxxxxxxxxxxx (Peter Stephenson))
-mydit(Version:) $Id: zshfaq.yo,v 1.52 2000/02/23 20:41:58 pws Exp $
+mydit(Version:) $Id: zshfaq.yo,v 1.53 2000/03/24 20:55:34 pws Exp $
 mydit(Posting-Frequency:) Monthly
 mydit(Copyright:) (C) P.W. Stephenson, 1995--2000 (see end of document)
 )
 
-bf(Changes since issue posted January 1999:)
+bf(Changes since issue posted February 2000:)
 description(
-mydit(1.1)  Mention user guide instead of semi-defunct reference card.
+mydit(3.25) Now question: coloured prompts on colour xterms.
 )
 
 This document contains a list of frequently-asked (or otherwise
@@ -120,6 +120,7 @@
 3.22. How do I get a variable's value to be evaluated as another variable?
 3.23. How do I prevent the prompt overwriting output when there is no newline?
 3.24. What's wrong with cut and paste on my xterm?
+3.25. How do I get coloured prompts on my colour xterm?
 
 Chapter 4:  The mysteries of completion
 4.1. What is completion?
@@ -1602,6 +1603,27 @@
      read; all input is read as continuation lines (this may require the
      fixes referred to above in order to be reliable).
   )
+
+sect(How do I get coloured prompts on my colour xterm?)
+
+(Or `color xterm', if you're reading this in black and white.)  You need to
+find the sequences which generate the various colours from the manual;
+these are ANSI standard on the terminal emulators I know about which
+support colour.  With a recent (post 3.1.6) distribution of zsh, there is a
+theme system to handle this for you; even if you don't see that, the
+installed function `mytt(colors)' (meaning `colours', if you're not reading
+this in black and white) gives the escape sequences.  You will end up with
+code looking like this (borrowed from Oliver Kiddle):
+verb(
+  PS1=$'%{\e[1;31m%}<the rest of your prompt here>%{\e[0m%}'
+)
+The mytt($') form of quoting turns the `mytt(\e)' into a real escape
+character.  The `mytt(%{...%})' is used in prompts for strings which will
+not appear as characters, so that the prompt code doesn't miscalculate the
+length of the prompt which would have a bad effect on editing.  The
+resulting `mytt(<ESC>[1;31m)' makes the prompt red, and the
+`mytt(<ESC>[0m)' puts printing back to normal so that the rest of the line
+is unchanged.
 
 
 chapter(The mysteries of completion)