about summary refs log tree commit diff
diff options
context:
space:
mode:
authorm0viefreak <m0viefreak.cm@googlemail.com>2014-02-17 05:07:56 +0100
committerPeter Stephenson <p.w.stephenson@ntlworld.com>2014-02-18 19:48:30 +0000
commit71d3065950102fc151cf686f7237483db09c3847 (patch)
treeae577dd52a80f22c6898f74da5fa5c3ccbdbcea8
parentb97808fba223fd68810ee6ee779e2eb3703724a3 (diff)
downloadzsh-71d3065950102fc151cf686f7237483db09c3847.tar.gz
zsh-71d3065950102fc151cf686f7237483db09c3847.tar.xz
zsh-71d3065950102fc151cf686f7237483db09c3847.zip
update zshcontrib for latest helpfiles
-rw-r--r--ChangeLog5
-rw-r--r--Doc/Zsh/contrib.yo27
2 files changed, 18 insertions, 14 deletions
diff --git a/ChangeLog b/ChangeLog
index 0f1cb7371..630f4f1dd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2014-02-18  Peter Stephenson  <p.w.stephenson@ntlworld.com>
+
+	* m0viefreak: 32403: Doc/Zsh/contrib.yo: update zshcontrib
+	manual for helpfiles improvements.
+
 2014-02-18  m0viefreak  <m0viefreak.cm@googlemail.com>
 
 	* 32396: Completion/Unix/Command/_git: _git: fix
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index bb6613ece..bb294e5a5 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -45,9 +45,8 @@ shell features as well.  The autoloadable tt(run-help) function, found in
 tt(Functions/Misc), searches for these helpfiles and performs several
 other tests to produce the most complete help possible for the command.
 
-There may already be a directory of help files on your system; look in
-tt(/usr/share/zsh) or tt(/usr/local/share/zsh) and subdirectories below
-those, or ask your system administrator.
+Help files are installed by default to a subdirectory of tt(/usr/share/zsh)
+or tt(/usr/local/share/zsh).
 
 To create your own help files with tt(helpfiles), choose or create a
 directory where the individual command help files will reside.  For
@@ -55,22 +54,22 @@ example, you might choose tt(~/zsh_help).  If you unpacked the zsh
 distribution in your home directory, you would use the commands:
 
 example(mkdir ~/zsh_help
-cd ~/zsh_help
-man zshall | colcrt - | \ 
-perl ~/zsh-version()/Util/helpfiles)
+perl ~/zsh-version()/Util/helpfiles ~/zsh_help)
+
+vindex(HELPDIR)
+The tt(HELPDIR) parameter tells tt(run-help) where to look for the help
+files. When unset, it uses the default installation path.
+To use your own set of help files, set this to the appropriate path
+in one of your startup files:
+
+example(HELPDIR=~/zsh_help)
 
 findex(run-help, use of)
-Next, to use the tt(run-help) function, you need to add lines something
+To use the tt(run-help) function, you need to add lines something
 like the following to your tt(.zshrc) or equivalent startup file:
 
 example(unalias run-help
-autoload run-help
-HELPDIR=~/zsh_help)
-
-vindex(HELPDIR)
-The tt(HELPDIR) parameter tells tt(run-help) where to look for the help
-files.  If your system already has a help file directory installed, set
-tt(HELPDIR) to the path of that directory instead.
+autoload run-help)
 
 Note that in order for `tt(autoload run-help)' to work, the tt(run-help)
 file must be in one of the directories named in your tt(fpath) array (see