Manual Page for zsh-templates

     zsh-templates(7)       Mac OS X Darwin ZSH customization      zsh-templates(7)

    NAME
           zsh-templates - Template files for zsh customization

    OVERVIEW
           Template  files  for  zsh customization.  This is a collection of files
           that help the user to customize the zsh shell for the Mac OS X  operat-
           ing  system.  It  is entirely optional and is not part of the zsh shell
           distribution. See zsh(1) for further details on the zsh shell.

    INSTALLATION AND USAGE
           This package can be used as a stand-alone set of files  or  it  can  be
           installed  with  the  package manager fink.  (See fink(8) for details.)
           Please consult the  on-line  website  for  the  latest  information  on
           installation,  contents,  and  description  of  the available features,
           available at: http://tinyurl.com/y3r4kp

    INSTALLATION AND SETUP AS A STAND-ALONE PACKAGE
           Download the most current version  from  http://tinyurl.com/3ck36e  and
           unpack  the  contents  of  the tarball to obtain the directory zsh-tem-
           plates-1.x.y/.  Move or remove  any  current  /etc/zshenv,  /etc/zshrc,
           /Library/LaunchAgents/zsh*  and /Library/init/zsh files present on your
           system.  Then, to install the new version, issue the command

           sudo mkdir -p /Library/init

           followed by

           sudo cp -R zsh-templates-1.x.y/Library/init/zsh /Library/init/.

           and

           sudo cp zsh-templates-1.x.y/etc/zsh* /etc/.

           and then start a new shell. If /bin/zsh is not currently  your  default
           shell, you can make it so with the command chsh -s /bin/zsh

           After  you  start  a  new shell, you will be provided a gui interactive
           dialogue to aid in fine-tuning the behavior of the template files.

    INSTALLATION AND SETUP WITH FINK
           Please  move   or   remove   any   extant    /etc/zshenv,   /etc/zshrc,
           /Library/LaunchAgents/zsh*  and  /Library/init/zsh  files  that  may be
           present currently on your system, in order to ensure proper functioning
           of  the zsh-templates package. The best places to put modifications are
           in  the  corresponding  user  files,  i.e.,  ~/.zshenv,  ~/.zshrc,  and
           ~/Library/init/zsh within the user's individual home directories.

           If  the zsh-templates package has been installed with fink, the package
           is designed to work in conjunction with fink's /sw/bin/zsh and no  fur-
           ther  invervention  should  be  required if /sw/bin/zsh is your default
           user shell. To make /sw/bin/zsh your default user shell, you must  edit
           the file /etc/shells and add to it the line /sw/bin/zsh

           If the zsh-templates package has been installed with fink, and you also
           want these files to work with the system's  zsh,  i.e.,  with  /bin/zsh
           then issue the two commands

           sudo ln -s /sw/share/zsh/templates/etc/zshenv /etc/.

           and

           sudo ln -s /sw/share/zsh/templates/etc/zshrc /etc/.

           and then start a new shell.

           In  either  case, after you start the new shell, you will be provided a
           gui interactive dialogue to aid in fine-tuning the behavior of the tem-
           plate files.

    OTHER FILES
           The  files  in Library/LaunchAgents.disabled are experimental, problem-
           atic, and are currently disabled by default.

           The files in Applications/zsh-templates_extras include  finder  toolbar
           icons  for  opening  a  Terminal or iTerm session in the directory dis-
           played in the Finder window. See http://tinyurl.com/36sank  and  cdf(7)
           for further details.

           The  files  in  Applications/Xtal are of use to X-ray crystallographers
           and probably no one else.

    ENVIRONMENT
           The environment variable  $ZDOT  is  defined  as  /Library/init/zsh  if
           /Library/init/zsh     is     present,    or    $SWPREFIX/share/zsh/tem-
           plates/Library/init/zsh where $SWPREFIX is /sw or  the  user's  equiva-
           lent,  if  /Library/init/zsh  is not present. These variables (and many
           others) are set automatically in /etc/zshenv.

           If   both   the    /Library/init/zsh    and    $SWPREFIX/share/zsh/tem-
           plates/Library/init/zsh  exist, /Library/init/zsh takes precedence, and
           an  additional  variable   $ZDOT_TEMPLATE   is   defined   as   $SWPRE-
           FIX/share/zsh/templates/Library/init/zsh

           The  description  that follows assumes $ZDOT for brevity but applies to
           the files in $ZDOT_TEMPLATE as well.  If the same file exists  in  both
           $ZDOT and $ZDOT_TEMPLATE, the file in $ZDOT will be read instead of the
           corresponding  file  in  $ZDOT_TEMPLATE.  Any  file  that  appears   in
           /Users/$USER/Library/init/zsh  will  be  read  in addition to the other
           files. The directories $ZDOT_TEMPLATE/local-functions and  $ZDOT/local-
           functions are both in the $FPATH by default; a funtion of the same name
           in $ZDOT/local-functions  takes  precedence  over  that  in  $ZDOT_TEM-
           PLATE/local-functions.  This structure permits customizations that will
           be preserved during fink package upgrade.

    SIMPLE CUSTOMIZATIONS
           The best way to customize the zsh-template system is  to  simply  issue
           the command

           configure_zsh_templates

           while  logged in at the console. This activates an interactive GUI dia-
           logue to aid in fine-tuning the behavior of the template files.

           To change the prompt theme, issue the command switch_prompt.

           To customize user and host completions, issue the commands

           user_setup

           and

           host_setup

           To modify the behavior of Apple's X11, issue the command

           customize_x11_gui

           or

           customize_x11

           For further (on-line) information and the  latest  updates,  issue  the
           command

           help_zsh_templates

    DESCRIPTION OF FILESYSTEM CONFIGURATION
           These  files  are mostly based upon those distributed by Gary Kerbaugh,
           but I have made some additions and  deleted  or  commented  out  a  few
           things  as  well.  I've also tried to make these completely general and
           easily configurable. zsh is about customizing the user environment,  so
           these files should be regarded as a starting point for tailoring zsh to
           your own needs and desires. I have tried to facilitate this by comments
           throughout the files. If something does not work out of the box, please
           report it as a bug.

           File organization and hierarchy:

           By default, when zsh starts up, it reads  the  configuration  files  in
           /etc  first,  followed  by  those in the user's home directory. You can
           make any of these files source any other file on your computer,  so  we
           take advantage of that to make things as modular and as configurable as
           possible. There are two files to place in /etc. These  are  /etc/zshenv
           and  /etc/zshrc,  and  they  are read in that order. These in turn read
           files that are to be placed in /Library/init/zsh, which is where  Apple
           suggests  putting  such  things.  (The  main difference between the two
           files in /etc is that /etc/zshenv gets run any time you start  up  zsh,
           whereas  /etc/zshrc  gets  run  only  when  you start up an interactive
           shell.) The various distributed functions, man pages, and so on are  in
           subdirectories of /Library/init/zsh.

           Further  descriptions  are  located on a page entitled Explanations for
           each zsh template file that is available at http://tinyurl.com/2ohg9m

    MAN PAGES FOR INDIVIDUAL FUNCTIONS
           man pages for many of the distributed functions are now available, both
           using  the  man  pager and via html.  The most up-to-date version is on
           line at http://xanana.ucsc.edu/Library/init/zsh/man/html/

    AUTHORS
           Modifications and enhancements of zsh distributed templates were  writ-
           ten  by Gary Kerbaugh, William Scott, Wataru Kagawa and several others.
           The original (unmodified) completion functions _open, _fink, _hdiutils,
           _defaults  and their dependencies were written by Motoi Washida and are
           now included with zsh.

    WEBSITE
            More details are available here: http://tinyurl.com/y3r4kp

    MAINTAINER
           W. G. Scott wgscott@users.sourceforge.net

    SEE ALSO
           http://xanana.ucsc.edu/Library/init/zsh/man/html/

    Mac OS X                         July 9, 2007                 zsh-templates(7)

Bwana Created by Bruji