SGIHelpMsg(3)

NAME
     SGIHelpInit, SGIHelpMsg, SGIHelpIndexMsg - help functions


SYNOPSIS
     #include <helpapi/HelpBroker.h>

     int SGIHelpMsg (char *in_key, char *in_book, char* user_data);

     int SGIHelpInit(Display *in_dsp, char *in_client, char *in_sep);

     int SGIHelpIndexMsg (char *in_key, char *in_book);


DESCRIPTION
     SGIHelpMsg provides for communication with sgihelp(1), the Silicon
     Graphics Help System.

     Programs wishing to utilize this functionality must call the function
     SGIHelpInit once to initialize the API. The pointer to the open Display
     (see XOpenDisplay(3X11)) and the application's client (class) name
     (usually the same name as the application's resource file; see
     XtAppInitialize(3Xt)) must be provided. The third parameter, the
     separator character used in the application's helpmap file, should be set
     to NULL (to utilize the API default). Calling SGIHelpInit more than once
     during program execution is harmless, but is unnecessary.

     The SGIHelpMsg call provides a method for communication with the help
     server process, sgihelp(1). This process will start automatically when a
     request for help is generated, if it is not already running on the
     system. The calling application (making the help request) can send in the
     key and book, which tells the help server (sgihelp(1)) which help card to
     display.  Note that help cards come from Insight(1) books, or from HTML
     files found within the Insight(1) library.

     The SGIHelpIndexMsg call tells the help server process, sgihelp(1), to
     display a list of available topics for this application. Note that a
     content provider must prepare a helpmap file for this to work.

     Refer to the IRIX Interactive Desktop(TM) Integration Guide for more
     information on this topic and on providing/creating help content for your
     application to work in conjunction with sgihelp(1).


NOTES
     The application must link with the library libhelpmsg.so and must include
     the file <helpapi/HelpBroker.h>.

     Security Note:

     Programs running suid root should examine the documentation for
     sgihelp(1) carefully before utilizing the help system; there are security
     concerns for that class of applications. Using sgihelp(1) for a program
     running suid root is not recommended.

SEE ALSO
     IRIX Interactive Desktop(TM) Integration Guide, sgihelp(1), insight(1).