AT&T UNIX™PC Unix System V Users Manual - tenox

UAHELP (l) (AT&T UNIX PC only ) UAHELP (l)
NAME
uahelp - user agent help process
SYNOPSIS
uahelp -h helpfile [ -t title] [ -d debugfile ]
DESCRIPTION
Uahelp is a help facility which is driven by a text file (help file).
The syntax of this file is described below.
Title , if specified, is the title of the initial help display.
If the -d (debug) option is specified, then as helpfile is being
parsed, the lines are written to debugfile . When a syntax error
occurs during the parsing of help file , then uahelp displays an error
message and quits. The line containing the error is the last line
written to debugfile . This option is used to debug new helpfiles .
Helpfile is an ordinary ASCII text file, with a "keyword = value"
syntax. The following keywords are defined:
Keyword Value
Wlabel
Contents
Name
Llabel
Slabel
Branch
Title
Text
Window label
Lists of help displays in this file
Name of current help display
Long screen label for current display
Short screen label for current display
List of help displays available via SLK's from
the current help display
Title of current help display
Text of current help display
All keywords must be case correct and followed by an equal sign
(=) and a value. The Wlabel and Contents keywords must be
defined at the beginning of the help file, and they are followed by
a series of definitions of the individual help displays, one for each
display listed under Contents.
The individual help displays begin with a Name definition, which
must be one of the names listed under Contents. The remaining
keyword definitions apply to the current help display, up until the
Text keyword, which terminates the help display definition.
The value of the Contents and Branch keywords must consist
of a list of one or more help display names. These names must be
separated by commas, and the final one must be terminated with
a new line character. The value of the Name keyword is a single
help display name, 16 characters or less. The value of the Wlabel,
Llabel, Slabel, and Title keywords are strings enclosed in
double quotes (" ").
The value of the Text keyword is text in ADF format (see
ADF( 4)). The following embedded codes are recognized:
\ CEN\ Center the line
\IND\ Indent to the next tab stop
\ UL \ Begin underlining
- 1 -