_S_G_I_H_e_l_p_M_s_g provides for communication with ssssggggiiiihhhheeeellllpppp(1), the SGI Help
System.
Programs wishing to utilize this functionality must call the function
_S_G_I_H_e_l_p_I_n_i_t once to initialize the API. The pointer to the open Display
(see XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy(3X11)) and the application's client (class) name
(usually the same name as the application's resource file; see
XXXXttttAAAAppppppppIIIInnnniiiittttiiiiaaaalllliiiizzzzeeee(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 _S_G_I_H_e_l_p_I_n_i_t more than once
during program execution is harmless, but is unnecessary.
The _S_G_I_H_e_l_p_M_s_g call provides a method for communication with the help
server process, ssssggggiiiihhhheeeellllpppp(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
_k_e_y and _b_o_o_k, which tells the help server (ssssggggiiiihhhheeeellllpppp(1)) which help card to
display. Note that help cards come from books found within the online
documentation library.
The _S_G_I_H_e_l_p_I_n_d_e_x_M_s_g call tells the help server process, ssssggggiiiihhhheeeellllpppp(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 IIIIRRRRIIIIXXXX IIIInnnntttteeeerrrraaaaccccttttiiiivvvveeee DDDDeeeesssskkkkttttoooopppp((((TTTTMMMM)))) IIIInnnntttteeeeggggrrrraaaattttiiiioooonnnn GGGGuuuuiiiiddddeeee for more
information on this topic and on providing/creating help content for your
application to work in conjunction with ssssggggiiiihhhheeeellllpppp(1).
DDDDEEEEFFFFIIIINNNNIIIITTTTIIIIOOOONNNNSSSS
A bbbbooooooookkkksssshhhheeeellllffff is defined as a directory containing a set of books. By
default, bookshelves are located in
/_u_s_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_l_i_b_r_a_r_y/_S_G_I__b_o_o_k_s_h_e_l_v_e_s To examine a sample bookshelf,
look under this default path. Most of the directories contained under
this area are defined as bbbbooooooookkkksssshhhheeeellllvvvveeeessss.
By convention, below each of those bbbbooooooookkkksssshhhheeeellllffff directories exists a
subdirectory named _b_o_o_k_s. The _b_o_o_k_s subdirectory contains all available