Arbortext Command Language > Commands > help
  
help
help [ -2 | -3 | -4 | -msg | -msgwin2 | -msgwin3 | -msgwin4] [ -title 'windowtitle'] [ -geometryWxH+X+Y] [ -tag] [ -file] [ -mouse | topic]
Typing help at the command line, without arguments, opens the Arbortext Editor Help Center and displays its default topic.
Supplying the various options opens the Help Center to a specific topic, opens tag help, or opens other ACL application windows as follows. (Only the -topic option affects Help Center.)
The numeric arguments -2, -3, -4, -msg, -msgwin2, -msgwin3, and -msgwin4 refer to choices for multiple tag help or ACL application windows. These windows can be used to view multiple help messages at one time. They are also available to application programmers writing their own help.
-title lets you override the default window title with a name you supply within quotation marks. If windowtitle is not surrounded by quotation marks, the remainder of the command line is used as the title.
-geometry specifies the size and position of the desired help window. It is a string of the form WxH+X+Y, where W is the width, and H is the height of the window in pixels. X and Y specify the position of the window relative to:
the upper left (corner of the screen) if +X+Y is used;
the upper right if -X+Y is used;
the lower left if +X-Y is used;
and the lower right if -X-Y is used.
If the help window is currently displayed, its size and/or position can be changed according to the geometry specification.
-tag specifies that topic is the name of an element (tag) in the document type associated with the current document. The -tag option should be given to get help for a tag with the same name as the Arbortext Editor command (for example, index).
-file allows you to specify an alternate Arbortext Editor help file or custom .chm help file. For example, if you want to open the Arbortext Change Page for Defense help file, you would specify:
help -file cpa.chm
-mouse displays a help message based on the context of the mouse arrow.
topic can be command names (for example, help set), alias names (for example, help find_id), ACL topics (for example, help functions) or other terms. If topic is not recognized as a command, alias, or specific topic, the Arbortext Editor Help Center will open with the search results for topic.
hel is a synonym for help.
Examples:
help
help find
help declare_graphic_entity
hel -2
hel -msg -title 'Set Commands' set
hel expressions
help operators
hel logical expressions
help operands
help -tag link
Related Topics
window_create function