Zsh Mailing List Archive
Messages sorted by:
Reverse Date,
Date,
Thread,
Author
[PATCH 1/4] Doc/Zsh/contrib.yo: Adjust man-page for the auto installed help files
- X-seq: zsh-workers 32403
- From: m0viefreak <m0viefreak.cm@xxxxxxxxxxxxxx>
- To: zsh-workers@xxxxxxx
- Subject: [PATCH 1/4] Doc/Zsh/contrib.yo: Adjust man-page for the auto installed help files
- Date: Mon, 17 Feb 2014 05:07:56 +0100
- Cc: m0viefreak <m0viefreak.cm@xxxxxxxxxxxxxx>
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlemail.com; s=20120113; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=DrJ2avUiKYeggnSAP90pir0Wgh7S4LIp04mYx475pPo=; b=ZqJlo+i9OAx7wtMUHcLYhrdtzuMmvfy9mFcYFIeHabBKMayu/C6nTBCsFPRp896xo/ p6rr22DCaPqTE25rSxmR8OkIKWwHUIotD0a1Cd49QWWOgPXkH9/IMiWKoOoEa+ubEkEw 0WNSjhYR26F4kLzx+QDi5VHiTrAGeQOWPRv4YKoeTY/0h+5py1MdivAydeohO2WVIK92 Ezqt5R5cQaKs0O3DbWbNowdafyA6aDSRNxJw5f9a2co/AFEH5otC9uW7e5MpSMHYdyXw dCJuJvFM8Aw+ygSz8xvWg3qHrJ7Dw6YYfuvH9ambCCP5rtKruI54fvyhXS5ZJZ/Gjgec 2+DQ==
- In-reply-to: <1392610079-2632-1-git-send-email-m0viefreak.cm@googlemail.com>
- List-help: <mailto:zsh-workers-help@zsh.org>
- List-id: Zsh Workers List <zsh-workers.zsh.org>
- List-post: <mailto:zsh-workers@zsh.org>
- Mailing-list: contact zsh-workers-help@xxxxxxx; run by ezmlm
- References: <1392610079-2632-1-git-send-email-m0viefreak.cm@googlemail.com>
---
Doc/Zsh/contrib.yo | 27 +++++++++++++--------------
1 file changed, 13 insertions(+), 14 deletions(-)
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index bb6613e..bb294e5 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
--
1.9.0
Messages sorted by:
Reverse Date,
Date,
Thread,
Author