DESIGN commands


PROGRAM NAME

khelp - Display online help (or ascii text files)

DESCRIPTION

This program creates a large read-only help widget in which one or more ascii files may be displayed. It is generally used for the purpose of displaying online help. All online help files should be in a roff format. Consult the Writing Documentation Chapter in the Programmers Volume of the Khoros Manual for a full description on how to write proper documentation.

If the [-i] argument is given the path to a single file, that file is displayed.

If the [-i] argument is given as a directory, the help widget will have a set of buttons at the top, where one button will appear, labelled with name of the file, for each file in the directory. Clicking on one of these buttons will cause the contents of the file labeled to appear in the text widget.

Any help files must have a suffix of '.doc' for on-line help and '.hlp' for on-line man pages. If the file has either suffix, the file $DESIGN/repos/config/doc_config/manual.cf is parsed for the roff formatter to use. The file or files are then processed by the roff formatter specifed and displayed in the help widget. If a file does not have either suffix, then it is displayed as a regular text file and is not processed by the roff formatter.

The help widget will be displayed until the user clicks on the "Quit" button. This utility will not grab X Events.

REQUIRED ARGUMENTS

-i
type: infile
desc: input file (or dir)

OPTIONAL ARGUMENTS

-x
type: integer
desc: x location of GUI
default: -1
bounds: -1 < [-x] < 1000
-width
type: integer
desc: The window width
default: 512
bounds: -1 < [-width] < 1000
-y
type: integer
desc: y location of GUI
default: -1
bounds: -1 < [-y] < 1000
-height
type: integer
desc: The window height
default: 512
bounds: -1 < [-height] < 1000

EXAMPLES

% khelp -i help/guise

This will format all the online help files in the directory help/guise and display them.

SEE ALSO

guise(1), preview(1)

RESTRICTIONS

REFERENCES

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.