man

Section: Mac OS X Darwin customization (7)
Updated: March 19, 2005
Index Return to Main Contents
 

NAME

man - Augmented man command that includes run-help and info in addtion to command man..  

SYNOPSIS

man [-options] [foo]  

DESCRIPTION

The augmented man zsh function requires the corrected and enhanced zsh function run-help and /usr/bin/info or /sw/bin/info as well as the command man. I had to fix up a few things in run-help so be sure to autoload the corrected version that handles multiple $HELPDIR entries and also gives usable error codes. These features are required to get this function to work right.

man combines the zsh run-help function with the traditional command man and the GNU info function. If a help-file is found in $HELPDIR, it is read by the zsh-function run-help , otherwise run-help defaults to the man command and displays the man page. The first aspect of this functionality requires that you first generate the help files from the ZSH man page. When this is done, each individual function and built-in command in the ZSH will have its own help-file entry. Run the function build-helpfiles to generate these the first time. The file $ZDOT/environment will then automatically set the $HELPDIR variable the next time a shell is started.

This function also uses the function settab to show the named process running and then resets itself with settab (so iTerm users will have man commandname or more commandname or info commandname displayed in the tab.

 

AUTHOR


 William Scott  

SEE ALSO

man(7), info(7), run-help(7)
 

Index

NAME
SYNOPSIS
DESCRIPTION
AUTHOR
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 05:38:45 GMT, August 06, 2005