home *** CD-ROM | disk | FTP | other *** search
SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111)))) SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111)))) NNNNAAAAMMMMEEEE sgihelp - The SGI Help Viewer SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS sgihelp [ -debug ] [ -nofork ] sgihelp -app aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee -c index [ -l lllliiiibbbb____ppppaaaatttthhhh ] [ -debug ] [ -nofork ] sgihelp -b bbbbooooooookkkk____nnnnaaaammmmeeee -k hhhheeeellllpppp____kkkkeeeeyyyy [ -app aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee ] [ -l lllliiiibbbb____ppppaaaatttthhhh ] [ -debug ] [ -nofork ] [ -m uuuusssseeeerrrr____ddddaaaattttaaaa ] ] DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN _s_g_i_h_e_l_p is an online help viewer. This viewer provides an easy-to-use interface which allows the user to browse through help information that is distributed from _S_i_l_i_c_o_n _G_r_a_p_h_i_c_s. ssssggggiiiihhhheeeellllpppp is based on the iiiinnnnssssiiiigggghhhhtttt(1) on-line viewing technology. The content for the help information that is displayed is derived from the iiiinnnnssssiiiigggghhhhtttt(1) books. ssssggggiiiihhhheeeellllpppp is an application that gets started only when a request is made for "help". A user should _n_e_v_e_r have to start sgihelp from the command- line, unless it is used to generate a help request through a combination of the command-line arguments described below. Requests can be generated from: o Help menu item(s) found within an application o A help pushbutton on an application window o An application sending a request directly o SGIHelp itself ssssggggiiiihhhheeeellllpppp renders the request, if the help content is available (see "FFFFIIIILLLLEEEESSSS" below). The ssssggggiiiihhhheeeellllpppp window is composed of two panes (areas): the Viewer pane and the Contents/Search pane. For further information, consult the ssssggggiiiihhhheeeellllpppp on-line help. DDDDEEEEFFFFIIIINNNNIIIITTTTIIIIOOOONNNNSSSS A bbbbooooooookkkksssshhhheeeellllffff is defined as a directory containing a set of books. By default, bookshelves are located in: ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss 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 "bbbbooooooookkkkssss". The "bbbbooooooookkkkssss" subdirectory contains all available online books for this bbbbooooooookkkksssshhhheeeellllffff. For example, examining the path: PPPPaaaaggggeeee 1111 SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111)))) SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111)))) ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////SSSSGGGGIIII____EEEEnnnnddddUUUUsssseeeerrrr////bbbbooooooookkkkssss////DDDDeeeesssskkkkttttoooopppp____UUUUGGGG SSSSGGGGIIII____EEEEnnnnddddUUUUsssseeeerrrr is the bbbbooooooookkkksssshhhheeeellllffff and DDDDeeeesssskkkkttttoooopppp____UUUUGGGG is the bbbbooooooookkkk. OOOOPPPPTTTTIIIIOOOONNNNSSSS -app The -app aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee options tells _s_g_i_h_e_l_p to process a help request for the given application. The aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee coincides with an associated help file that can be found in (default) /_u_s_r/_s_h_a_r_e/_h_e_l_p or it can be the same as the name used for the application's defaults file, found in /_u_s_r/_l_i_b/_X_1_1/_a_p_p-_d_e_f_a_u_l_t_s. -b The -b bbbbooooooookkkk____nnnnaaaammmmeeee option tells _s_g_i_h_e_l_p to examine the specified book for help content for the given request. The bbbbooooooookkkk____nnnnaaaammmmeeee is the abbreviated short title for the book. Note that this option is case-sensitive. For example: ssssggggiiiihhhheeeellllpppp ----bbbb IIIIRRRRIIIISSSSEEEEsssssssseeeennnnttttiiiiaaaallllssss ............ -k The -k hhhheeeellllpppp____kkkkeeeeyyyy option tells _s_g_i_h_e_l_p to render the help card that has a specified "HelpId=" attribute of hhhheeeellllpppp____kkkkeeeeyyyy. -c The -c command option is used to invoke _s_g_i_h_e_l_p and open the Contents/Search area for the designated aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee. You must specify iiiinnnnddddeeeexxxx as the parameter following this option; which is an artifact of an older version of ssssggggiiiihhhheeeellllpppp. For example, the command used for opening ssssggggiiiihhhheeeellllpppp and loading the available help information for the _i_n_s_i_g_h_t application would be: ssssggggiiiihhhheeeellllpppp ----aaaapppppppp IIIInnnnssssiiiigggghhhhtttt ----cccc iiiinnnnddddeeeexxxx -debug Tells _s_g_i_h_e_l_p to print messages it is receiving to stdout. -nofork The -nofork (or -f) option tells _s_g_i_h_e_l_p to run in the foreground. The default is to automatically background when starting. -l The -l lllliiiibbbb____ppppaaaatttthhhh option tells _s_g_i_h_e_l_p to load the specified IRIS InSight library. A library is defined as a collection of bookshelves. By default, the library is rooted at ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy. The path (relative or full) to the new library should be specified. Only one library may be specified. For example: ssssggggiiiihhhheeeellllpppp ----llll ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbb____XXXXXXXXXXXX ............ Another method for specifying the designated library is to set the resource, "_d_e_f_L_i_b_P_a_t_h". The resource value should be designated as: SSSSGGGGIIIIHHHHeeeellllpppp****ddddeeeeffffLLLLiiiibbbbPPPPaaaatttthhhh:::: ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbb____XXXXXXXXXXXX PPPPaaaaggggeeee 2222 SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111)))) SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111)))) -m The -m uuuusssseeeerrrr____ddddaaaattttaaaa option is used to pass data to _s_g_i_h_e_l_p and is currently only used by the System Monitor; see ssssyyyyssssmmmmoooonnnn((((1111mmmm)))). NNNNOOOOTTTTEEEESSSS If you are having problems viewing rrrreeeemmmmooootttteeee, web-based help documents you may need to run the program wwwweeeebbbbccccoooonnnnttttrrrroooollll to configure an underlying set of toolkits (webviewer, websupport_eoe) that _s_g_i_h_e_l_p uses. See the man page on wwwweeeebbbbccccoooonnnnttttrrrroooollll((((1111)))) for details. This will be required if your site is behind a "firewall", or uses a proxy server, for example. To bbbbrrrroooowwwwsssseeee the available bookshelves and books on the local system, in your web browser or in the IRIX Interactive Desktop (see _I_I_D(_1_G)) File Manager, open the following file: ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////iiiinnnnddddeeeexxxx....hhhhttttmmmmllll Localized books can be browsed by opening the following file: ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////<<<<llllaaaannnngggguuuuaaaaggggeeee>>>>____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////iiiinnnnddddeeeexxxx....hhhhttttmmmmllll Specifically, here is one such file (available only if localized books have been installed): ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////ffffrrrr____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////iiiinnnnddddeeeexxxx....hhhhttttmmmmllll If you see warnings about books in an "old/unreadable format", those books can be converted using the ----cccc and (optionally) the ----dddd option(s) of the iiiinnnnssssiiiigggghhhhttttAAAAddddmmmmiiiinnnn((((1111)))) command. Additional information can be found in the iiiinnnnssssiiiigggghhhhtttt Release Notes. FFFFIIIILLLLEEEESSSS /usr/sbin/sgihelp, /usr/lib/X11/app-defaults/SGIHelp Help content for the IRIX Interactive Desktop(TM) is retrieved from the following sample of book subsystems (subject to change): desktop_eoe.books.* IRIX Interactive Desktop(TM) Books dmedia_eoe.books.* Digital Media Tools User's Guide, Help eoe.books.* IRIX Execution Environment Books imgtools.books.* ImageVision Tools User's Guide, Help impr_base.books.* Impressario User's Guide sysmon.books.* Desktop System Monitor Help *.books.[Hh]elp Various Help-related books SSSSEEEEEEEE AAAALLLLSSSSOOOO _i_n_f_o_s_e_a_r_c_h(_1), _i_n_s_i_g_h_t_A_d_m_i_n(_1) iiiinnnnssssiiiigggghhhhtttt Release Notes. PPPPaaaaggggeeee 3333 SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111)))) SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111)))) PPPPaaaaggggeeee 4444 
