HELPREGISTER

HELPREGISTER

Registers help files to display in the main SAS window Help menu

Default: none

Valid in: configuration file, SAS invocation

OS/2 specifics: all

Syntax
Details
Examples
	Example 1: INF Files
	Example 2: HLP Help Files
	Example 3: HTML Help Files

Syntax

-HELPREGISTER "menu string" path\filename <"help string"> <topic> <INF | HLP | HTML>

"menu string": is the text string that appears in the main SAS window Help menu.
path: specifies the directory path in which the help file is located. Path must be a valid OS/2 path. When HTML is specified, path is a URL.
filename: is the name of the help file. The SAS System for OS/2 Version 8 supports INF, HLP, and HTML help files. When HTML is specified, filename is a URL.
help string: is the text that appears in the status line when a user places the mouse over menu string in the main SAS window Help menu.
topic: is the topic within the help file that displays when you select menu string from the Help menu. When the help file is in .HLP format, the topic is an integer representing a resouce-id in the help file. topic is not valid for .INF help files.
INF: specifies the help file is in .INF format.
HLP: specifies the help file is in .HLP format.
HTML: specifies the help file is in .HTML format.

Details

Use the HELPREGISTER system option to use a help file you would like available from the main SAS window Help menu. When either an INF or HLP file is specified, the SAS System launches the OS/2 Viewer. When the help file is an HTML file, the SAS System launches the web browser specified in the Web page of the Preferences dialog box.

All strings containing spaces must be enclosed in double quotation marks. Optional arguments may be omitted by replacing them with a single period (.) or empty double quotation marks (" "). If no further arguments are specified, no place-holder is required.

Examples

Example 1: INF Files

sas -helpregister "My INF Help" c:\mydir\myhelp.inf
    "My Help info" . inf

Example 2: HLP Help Files

sas -helpregister "My HLP SysOp Help" helploc://sysop.hlp

Example 3: HTML Help Files

sas -helpregister "Local HTML Doc" c:\mypage.htm      
    "My own help" "#middle"

Chapter Contents
Previous
Next
Top of Page

Default:	none
Valid in:	configuration file, SAS invocation
OS/2 specifics:	all