XMAN(1) AIX XMAN(1) NAME xman - Manual page display program for the X Window System SYNOPSIS xxxxmmmmaaaannnn [ -_o_p_t_i_o_n_s ... ] DESCRIPTION _X_m_a_n is a manual page browser. The default size of the ini- tial _x_m_a_n window is small so that you can leave it running throughout your entire login session. In the initial window there are three options: _H_e_l_p will pop up a window with on- line help, _Q_u_i_t will exit, and _M_a_n_u_a_l _P_a_g_e will pop up a window with a manual page browser in it. Typing Control-S will pop up a window prompting for a specific manual page to display. You may display more than one manual page browser window at a time from a single execution of _x_m_a_n. For further information on using _x_m_a_n, please read the on- line help information. Most of this manual will discuss customization of _x_m_a_n. OPTIONS Xman supports all standard Toolkit command line arguments (see _X(1)). The following additional arguments are sup- ported. ----hhhheeeellllppppffffiiiilllleeee _f_i_l_e_n_a_m_e Specifies a helpfile to use other than the default. ----bbbbooootttthhhhsssshhhhoooowwwwnnnn Allows both the manual page and manual directory to be on the screen at the same time. ----nnnnoooottttooooppppbbbbooooxxxx Starts without the Top Menu with the three buttons in it. ----ggggeeeeoooommmmeeeettttrrrryyyy _W_x_H+_X+_Y Sets the size and location of the Top Menu with the three buttons in it. ----ppppaaaaggggeeeessssiiiizzzzeeee _W_x_H+_X+_Y Sets the size and location of all the Manual Pages. CUSTOMIZING XMAN _X_m_a_n allows customization of both the directories to be searched for manual pages, and the name that each directory will map to in the _S_e_c_t_i_o_n_s menu. Xman determines which directories it will search by reading the _M_A_N_P_A_T_H environ- ment variable. If no _M_A_N_P_A_T_H is found then the directory is /usr/man is searched on POSIX systems. This environment is expected to be a colon-separated list of directories for Rev. Release 5 Page 1 XMAN(1) AIX XMAN(1) xman to search. setenv MANPATH /mit/kit/man:/usr/man By default, _x_m_a_n will search each of the following direc- tories (in each of the directories specified in the users MANPATH) for manual pages. If manual pages exist in that directory then they are added to list of manual pages for the corresponding menu item. A menu item is only displayed for those sections that actually contain manual pages. Directory Section Name --------- ------------ man1 (1) User Commands man2 (2) System Calls man3 (3) Subroutines man4 (4) Devices man5 (5) File Formats man6 (6) Games man7 (7) Miscellaneous man8 (8) Sys. Administration manl (l) Local mann (n) New mano (o) Old For instance, a user has three directories in her manual path and each contain a directory called _m_a_n_3. All these manual pages will appear alphabetically sorted when the user selects the menu item called (_3) _S_u_b_r_o_u_t_i_n_e_s. If there is no directory called _m_a_n_o in any of the directories in her MANPATH, or there are no manual pages in any of the direc- tories called _m_a_n_o then no menu item will be displayed for the section called (_o) _O_l_d. THE MANDESC FILE By using the _m_a_n_d_e_s_c file a user or system manager is able to more closely control which manual pages will appear in each of the sections represented by menu items in the _S_e_c_- _t_i_o_n_s menu. This functionality is only available on a sec- tion by section basis, and individual manual pages may not be handled in this manner. (Although generous use of sym- bolic links - see _l_n(1) - will allow almost any configura- tion you can imagine.) The format of the mandesc file is a character followed by a label. The character determines which of the sections will be added under this label. For instance suppose that you would like to create an extra menu item that contains all programmer subroutines. This label should contain all manual pages in both sections two and three. The _m_a_n_d_e_s_c file would look like this: 2Programmer Subroutines Rev. Release 5 Page 2 XMAN(1) AIX XMAN(1) 3Programmer Subroutines This will add a menu item to the _S_e_c_t_i_o_n_s menu that would bring up a listing of all manual pages in sections two and three of the Programmers Manual. Since the label names are _e_x_a_c_t_l_y the same they will be added to the same section. Note, however, that the original sections still exist. If you want to completely ignore the default sections in a manual directory then add the line: no default sections anywhere in your mandesc file. This keeps xman from search- ing the default manual sections _I_n _t_h_a_t _d_i_r_e_c_t_o_r_y _o_n_l_y. As an example, suppose you want to do the same thing as above, but you don't think that it is useful to have the _S_y_s_t_e_m _C_a_l_l_s or _S_u_b_r_o_u_t_i_n_e_s sections any longer. You would need to duplicate the default entries, as well as adding your new one. no default sections 1(1) User Commands 2Programmer Subroutines 3Programmer Subroutines 4(4) Devices 5(5) File Formats 6(6) Games 7(7) Miscellaneous 8(8) Sys. Administration l(l) Local n(n) New o(o) Old Xman will read any section that is of the from _m_a_n<_c_h_a_r_a_c_t_e_r>, where is an upper or lower case letter (they are treated distinctly) or a numeral (0-9). Be warned, however, that man(1) and catman(8) will not search directories that are non-standard. WIDGETS In order to specify resources, it is useful to know the hierarchy of the widgets which compose _x_m_a_n. In the nota- tion below, indentation indicates hierarchical structure. The widget class name is given first, followed by the widget instance name. Xman xman (_T_h_i_s _w_i_d_g_e_t _i_s _n_e_v_e_r _u_s_e_d) TopLevelShell topbox Form form Label topLabel Command helpButton Command quitButton Rev. Release 5 Page 3 XMAN(1) AIX XMAN(1) Command manpageButton TransientShell search DialogWidgetClass dialog Label label Text value Command manualPage Command apropos Command cancel TransientShell pleaseStandBy Label label TopLevelShell manualBrowser Paned Manpage_Vpane Paned horizPane MenuButton options MenuButton sections Label manualBrowser Viewport directory List directory List directory . . (one for each section, . created on the fly) . ScrollByLine manualPage SimpleMenu optionMenu SmeBSB displayDirectory SmeBSB displayManualPage SmeBSB help SmeBSB search SmeBSB showBothScreens SmeBSB removeThisManpage SmeBSB openNewManpage SmeBSB showVersion SmeBSB quit SimpleMenu sectionMenu SmeBSB . . (one for each section) . TransientShell search DialogWidgetClass dialog Label label Text value Command manualPage Command apropos Command cancel TransientShell pleaseStandBy Label label TransientShell likeToSave Dialog dialog Label label Text value Command yes Rev. Release 5 Page 4 XMAN(1) AIX XMAN(1) Command no TopLevelShell help Paned Manpage_Vpane Paned horizPane MenuButton options MenuButton sections Label manualBrowser ScrollByLine manualPage SimpleMenu optionMenu SmeBSB displayDirectory SmeBSB displayManualPage SmeBSB help SmeBSB search SmeBSB showBothScreens SmeBSB removeThisManpage SmeBSB openNewManpage SmeBSB showVersion SmeBSB quit APPLICATION RESOURCES _x_m_a_n has the following application-specific resources which allow customizations unique to _x_m_a_n. mmmmaaaannnnuuuuaaaallllFFFFoooonnnnttttNNNNoooorrrrmmmmaaaallll (Class FFFFoooonnnntttt) The font to use for normal text in the manual pages. mmmmaaaannnnuuuuaaaallllFFFFoooonnnnttttBBBBoooolllldddd (Class FFFFoooonnnntttt) The font to use for bold text in the manual pages. mmmmaaaannnnuuuuaaaallllFFFFoooonnnnttttIIIIttttaaaalllliiiicccc (Class FFFFoooonnnntttt) The font to use for italic text in the manual pages. ddddiiiirrrreeeeccccttttoooorrrryyyyFFFFoooonnnnttttNNNNoooorrrrmmmmaaaallll (Class FFFFoooonnnntttt) The font to use for the directory text. bbbbooootttthhhhSSSShhhhoooowwwwnnnn (Class BBBBoooooooolllleeeeaaaannnn) Either `true' or `false,' specifies whether or not you want both the directory and the manual page shown at start up. ddddiiiirrrreeeeccccttttoooorrrryyyyHHHHeeeeiiiigggghhhhtttt (Class DDDDiiiirrrreeeeccccttttoooorrrryyyyHHHHeeeeiiiigggghhhhtttt) The height in pixels of the directory, when the directory and the manual page are shown simultaneously. ttttooooppppCCCCuuuurrrrssssoooorrrr (Class CCCCuuuurrrrssssoooorrrr) The cursor to use in the top box. hhhheeeellllppppCCCCuuuurrrrssssoooorrrr (Class CCCCuuuurrrrssssoooorrrr) Rev. Release 5 Page 5 XMAN(1) AIX XMAN(1) The cursor to use in the help window. mmmmaaaannnnppppaaaaggggeeeeCCCCuuuurrrrssssoooorrrr (Class CCCCuuuurrrrssssoooorrrr) The cursor to use in the manual page win- dow. sssseeeeaaaarrrrcccchhhhEEEEnnnnttttrrrryyyyCCCCuuuurrrrssssoooorrrr (Class CCCCuuuurrrrssssoooorrrr) The cursor to use in the search entry text widget. ppppooooiiiinnnntttteeeerrrrCCCCoooolllloooorrrr (Class FFFFoooorrrreeeeggggrrrroooouuuunnnndddd) This is the color of all the cursors (pointers) specified above. The name was chosen to be compatible with xterm. hhhheeeellllppppFFFFiiiilllleeee (Class FFFFiiiilllleeee) Use this rather than the system default helpfile. ttttooooppppBBBBooooxxxx (Class BBBBoooooooolllleeeeaaaannnn) Either `true' or `false,' determines whether the top box (containing the help, quit and manual page buttons) or a manual page is put on the screen at start-up. The default is true. vvvveeeerrrrttttiiiiccccaaaallllLLLLiiiisssstttt (Class BBBBoooooooolllleeeeaaaannnn) Either `true' or `false,' determines whether the directory listing is verti- cally or horizontally organized. The default is horizontal (false). GLOBAL ACTIONS _X_m_a_n defines all user interaction through global actions. This allows the user to modify the translation table of any widget, and bind any event to the new user action. The list of actions supported by _x_m_a_n are: GGGGoooottttooooPPPPaaaaggggeeee((((_p_a_g_e)))) When used in a manual page display window this will allow the user to move between a directory and manual page display. The _p_a_g_e argument can be either DDDDiiiirrrreeeeccccttttoooorrrryyyy or MMMMaaaannnnuuuuaaaallll---- PPPPaaaaggggeeee. QQQQuuuuiiiitttt(((()))) This action may be used anywhere, and will exit xman. SSSSeeeeaaaarrrrcccchhhh((((_t_y_p_e,,,, _a_c_t_i_o_n)))) Only useful when used in a search popup, this action will cause the search widget to per- form the named search type on the string in the search popup's value widget. This action will also pop down the search widget. The Rev. Release 5 Page 6 XMAN(1) AIX XMAN(1) _t_y_p_e argument can be either AAAApppprrrrooooppppoooossss, MMMMaaaannnnppppaaaaggggeeee or CCCCaaaannnncccceeeellll. If an _a_c_t_i_o_n of OOOOppppeeeennnn is specified then xman will open a new manual page to display the results of the search, otherwise xman will attempt to display the results in the parent of the search popup. PPPPooooppppuuuuppppHHHHeeeellllpppp(((()))) This action may be used anywhere, and will popup the help widget. PPPPooooppppuuuuppppSSSSeeeeaaaarrrrcccchhhh(((()))) This action may be used anywhere except in a help window. It will cause the search popup to become active and visible on the screen, allowing the user search for a manual page. CCCCrrrreeeeaaaatttteeeeNNNNeeeewwwwMMMMaaaannnnppppaaaaggggeeee(((()))) This action may be used anywhere, and will create a new manual page display window. RRRReeeemmmmoooovvvveeeeTTTThhhhiiiissssMMMMaaaannnnppppaaaaggggeeee(((()))) This action may be used in any manual page or help display window. When called it will remove the window, and clean up all resources associated with it. SSSSaaaavvvveeeeFFFFoooorrrrmmmmaaaatttttttteeeeddddPPPPaaaaggggeeee((((_a_c_t_i_o_n)))) This action can only be used in the lllliiiikkkkeeeeTTTToooo---- SSSSaaaavvvveeee popup widget, and tells xman whether to SSSSaaaavvvveeee or CCCCaaaannnncccceeeellll a save of the manual page that has just been formatted. SSSShhhhoooowwwwVVVVeeeerrrrssssiiiioooonnnn(((()))) This action may be called from any manual page or help display window, and will cause the informational display line to show the current version of xman. FILES <_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y>/man<_c_h_a_r_a_c_t_e_r> <_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y>/cat<_c_h_a_r_a_c_t_e_r> <_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y>/mandesc /usr/lib/X11/app-defaults/Xman specifies required resources /tmp _X_m_a_n creates temporary files in /tmp for all unformatted man pages and all apropos searches. SEE ALSO _X(1), _m_a_n(1), _a_p_r_o_p_o_s(1), _c_a_t_m_a_n(8), _A_t_h_e_n_a _W_i_d_g_e_t _S_e_t Rev. Release 5 Page 7 XMAN(1) AIX XMAN(1) ENVIRONMENT DDDDIIIISSSSPPPPLLLLAAAAYYYY the default host and display to use. MMMMAAAANNNNPPPPAAAATTTTHHHH the search path for manual pages. Direc- tories are separated by colons (e.g. /usr/man:/mit/kit/man:/foo/bar/man). XXXXEEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT to get the name of a resource file that over- rides the global resources stored in the RESOURCE_MANAGER property. XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR A string that will have ``Xman'' appended to it. This string will be the full path name of a user app-defaults file to be merged into the resource database after the system app- defaults file, and before the resources that are attached to the display. COPYRIGHT Copyright 1988 by Massachusetts Institute of Technology. See _X(_1) for a full statement of rights and permissions. AUTHORS Chris Peterson, MIT X Consortium from the V10 version writ- ten by Barry Shein formerly of Boston University. Rev. Release 5 Page 8