Shows help on given topics or search words.
help, hlp, hl, man
help [ <options> ] [ <word> [<word> [<word> ...] ] ]
<word> The name of a help topic or word to serach for in help contents.
Multiple <word>s can be specified. If you wish to serach for a search string containing spaces,
use double quotes around that string.
<word>s can be specified with the use of expressions.
If no options are specified specified, <word>s are assumed to be help topics, and help
on those topics is produced.
-s All help contents are searched for <word>s and a list of matching topics is produced.
If no options are specified, help pages on the specified topics are produced here.
If no <word>s are specified, a list of available topics is produced in the following format.
Topic Type Purpose
do Command Creates and executes a block of commands.
If -s is specified, a list of matching topics is produced in the above format. Topics are listed in
order of relevance.
Note that the headers are not produced in the actual stream output. The headers are shown here
for simplicity of explaining.
Any errors are listed here.
This command provides help on various topics. The topics include commands, functions, variables,
system features, etc.
<word>s are treated as case-insensitive.
Help topics, when being displayed, use the following notation.
<item> When an item is enclosed in angular brackets, substitute it with an appropriate object
(file name, path, constant, expression, etc.). When an item is not enclosed in angular brackets,
enter that item exactly as it shown.
[item] When an items is enclosed in square brackets, it is optional. When an item is not enclosed in
square brackets, it is required.
[item1 [item2 [item3] ] ] When square brackets are nested, the items, if specified, can only be specified in
order from left to right. item1 is optional. item2 is also optional, but can be specified only if item1
is specified. item3 is also optional, but can be specified only if item1 and item2 are specified.
... Three dots mean etc.
item1 | item2 When two or more items are separated by vertical bar, use only one of them.
"item" When an item is enclosed in double quotes, it needs to be enclosed in double quotes.
(Double quotes indicate that the item is a string (str) constant.)
(item) When an item is enclosed in parentheses, it needs to be enclosed in parentheses.
(Parentheses indicate that the item is an expression, and needs to be evaluated.)
Expressions must be enclosed in parentheses.
Depending on search words and expressions, execution of the search option may be slow.
Will show a listing of all help topics.
Will show help page on the echo command.
Will show help on the help command itself.
Will produce error. There is no help topic "delete".
help -s "delete"
Will result in searching the topics for the str "delete"
and displaying the list of resulting topics.
© 2008-2013, biterScripting.com. All rights reserved.
biterScripting, biterScript, biterBrowser, biterMobile, biterScripting.com, FVA (Forward Variable Assignment) are trademarks of biterScripting.com. Is it biterScripting-compatible ? is a service mark of biterScripting.com.
Explorer, Unix, Windows are trademarks, service marks or other forms of intellectual property of their respective owners.