xman [-options ... ]
The xman(1) utility is a manual page browser. The default size of the initial xman(1) window is small so that you can leave it running throughout your entire login session. In the initial window there are three options: Help will pop up a window with on-line help; Quit will exit; and Manual Page will pop up a window with a manual page browser in it. Typing CTRL+S will pop up a window prompting for a specific manual page to display. You can display more than one manual page browser window at a time from a single execution of xman(1).
For further information on using xman(1), please read the on-line help information. Most of this topic will discuss customization of xman(1).
The xman(1) utility supports all standard Toolkit command-line arguments (see X(5)). The following additional arguments are supported.
setenv MANPATH /mit/kit/man:/usr/man
By default, xman(1) will search each of the following
directories (in each of the directories specified in the user's
MANPATH) for manual pages. If manual pages exist in that
directory, 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 contains a directory called man3. All of these manual pages will appear, alphabetically sorted, when the user selects the menu item called (3) Subroutines. If there is no directory called mano in any of the directories in the user's MANPATH, or there are no manual pages in any of the directories called mano, no menu item will be displayed for the section called (o) Old.
By using the mandesc file, a user or system manager can more closely control which manual pages will appear in each of the sections represented by menu items in the Sections menu. This functionality is only available on a section-by-section basis, and individual manual pages cannot be handled in this manner.
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 want 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 mandesc file would look like this:
2Programmer Subroutines 3Programmer Subroutines
This will add a menu item to the Sections menu that would bring up a listing of all manual pages in sections two and three of the Programmers Manual. Because the label names are exactly 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, add the line:
anywhere in your mandesc file. This keeps xman(1) from searching the default manual sections In that directory only. For example, suppose you want to do the same thing as above, but you do not think that it is still useful to have the System Calls or Subroutines sections. You would need to duplicate the default entries, as well as adding your new one.
no default sections
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
The xman utility will read any section that is of the form man<character>, where <character> is an uppercase or lowercase letter (they are treated distinctly) or a numeral (0-9). Be warned, however, that man(1) and catman will not search directories that are non-standard.
In order to specify resources, it is useful to know the hierarchy of the widgets which compose xman(1). In the notation below, indentation indicates hierarchical structure. The widget class name is given first, followed by the widget instance name.
Xman xman (This widget is never used) TopLevelShell topbox Form form Label topLabel Command helpButton Command quitButton 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 . . (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 <name of section> . . (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 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
The xman(1) utility includes the following application-specific resources, which allow customizations unique to xman(1).
See X(5) for a full statement of rights and permissions.
Athena Widget Set