Identifies the help window that describes a command.
Syntax
┌───────────────┬───────────────┬───────────────┬───────────────┐ │Tag │Element │Attributes │End │ ├───────────────┼───────────────┼───────────────┼───────────────┤ │:icmd. │Index command │external │ │ │ │ │command string │ │ └───────────────┴───────────────┴───────────────┴───────────────┘
Attributes
external-command-string
Description
The help information for a command is assumed to be in the help window in which the index-command tag (:icmd.) is defined. If the help window provides help for more than one command, an index-command tag should be defined within the heading tag for each command.
The same external command string cannot be specified in more than one index-command tag of an index file; that is, only one help window can be designated as describing a command.
If the compiler finds the same external command string more than once (either from the same or different help windows), the duplicate occurrences are discarded, and a warning message is issued.
Note: The association with entry field and command names is a programming task. In addition, the application developer must define the field with which command windows are to be associated as a command entry field. For more information about programming a command entry field, see Command Entry Field.
Conditions
:icmd. must follow a heading tag or another index tag.
Example
:h1 id=xhlp.Help for Copying:icmd.Copying :h1 res=129.Deleting Files :icmd.Delete
Output
At execution time, the index entries enable the compiler to process command helps, create a list of commands for which help is available, and display the help window defined for any of those commands.