mirrors/zsh
1
0
Fork 0
mirror of git://git.code.sf.net/p/zsh/code synced 2025-01-01 05:16:05 +01:00
Code Releases Activity

update zshcontrib for latest helpfiles

Browse source
This commit is contained in:
m0viefreak 2014-02-17 05:07:56 +01:00 committed by Peter Stephenson
parent b97808fba2
commit 71d3065950
2 changed files with 20 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
ChangeLog
View file

@ -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> 2014-02-18 m0viefreak <m0viefreak.cm@googlemail.com>
* 32396: Completion/Unix/Command/_git: _git: fix * 32396: Completion/Unix/Command/_git: _git: fix

31
Doc/Zsh/contrib.yo
View file

@ -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 tt(Functions/Misc), searches for these helpfiles and performs several
other tests to produce the most complete help possible for the command. 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 Help files are installed by default to a subdirectory of tt(/usr/share/zsh)
tt(/usr/share/zsh) or tt(/usr/local/share/zsh) and subdirectories below or tt(/usr/local/share/zsh).
those, or ask your system administrator.
To create your own help files with tt(helpfiles), choose or create a To create your own help files with tt(helpfiles), choose or create a
directory where the individual command help files will reside. For 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: distribution in your home directory, you would use the commands:
example(mkdir ~/zsh_help example(mkdir ~/zsh_help
cd ~/zsh_help perl ~/zsh-version()/Util/helpfiles ~/zsh_help)
man zshall | colcrt - | \
perl ~/zsh-version()/Util/helpfiles)
findex(run-help, use of)
Next, 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) vindex(HELPDIR)
The tt(HELPDIR) parameter tells tt(run-help) where to look for the help 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 files. When unset, it uses the default installation path.
tt(HELPDIR) to the path of that directory instead. 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)
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)
Note that in order for `tt(autoload run-help)' to work, the tt(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 file must be in one of the directories named in your tt(fpath) array (see