xman(1X) xman(1X)NAME xman - displays manual pages SYNOPSIS xman [-helpfile file] [-bothshown] [-notopbox] [-geometry geometry] [-pagesize geometry] DESCRIPTION xman is a manual page browser. The default size of the ini- tial xman window is small so that you can leave it running throughout your entire login session. There are three but- tons in the initial window: the Help button pops up a win- dow with on-line help, the Quit button lets you exit xman, and the Manual Page button pops up a window with a manual page browser in it. You can pop up more than one manual page browser window from a single invocation of xman. Options The xman client application accepts all the standard X Toolkit command-line options, as described in X(1X), as well as these options: -bothshown Allows both the manual page and manual directory to be on the screen at the same time. -helpfile file Specifies a helpfile to use other than the default. -geometry geometry Specifies the size and location of the initial win- dow with the three buttons in it. See X(1X) for de- tails. -notopbox Starts without the initial window with the three buttons in it. -pagesize geometry Sets the size and location of all manual pages. See X(1X) for details. For further information on using xman, please read the on- line help information. The rest of this manual page discusses customization of xman. Customizing xman You can customize the directories that xman searches for manual pages by setting the MANPATH environment variable, which is a colon-separated list of absolute directory names. If MANPATH is not set, the directory /usr/man is searched on POSIX systems. You can set MANPATH in the C shell using the November, 1990 1
xman(1X) xman(1X)following command: setenv MANPATH /mit/kit/man:/usr/man You can set MANPATH in the Bourne and Korn shells using the following commands: MANPATH=/mit/kit/man:/usr/man export MANPATH By default, xman searches each of the following directories (in each of the directories specified in the your 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)File Formats man5 (5)Miscellaneous man6 (6)Games man7 (7)Devices man8 (8)A/UX Startup manl (l)Local mann (n)New mano (o)Old For instance, suppose there are three directories in MANPATH and each directory contains a directory called man3. All these manual pages appear alphabetically sorted when you select the menu item called ``(3) Subroutines.'' If no directory called mano is in any of the directories in MAN- PATH, or if no manual pages are in any of the directories called mano, no menu item is displayed for the section called ``(o) Old.'' The mandesc file By using the mandesc file, you can control more closely which manual pages appear in each of the sections represent- ed by menu items in the Sections menu. This functionality is only available on a section-by-section basis, and indivi- dual manual pages cannot be handled in this manner. Symbol- ic links can be used to circumvent this restriction. See ln(1) for details. The format of the mandesc file is a line starting with a character and followed by a label. The character determines which of the sections to add under the label. For instance, suppose you would like to create an extra menu item that 2 November, 1990
xman(1X) xman(1X)contains all programmer subroutines. This label should con- tain all manual pages in both sections 2 and 3. The mandesc file would look like this: 2Programmer Subroutines 3Programmer Subroutines This mandesc file adds a menu item to the Sections menu that brings up a listing of all manual pages in sections 2 and 3 in A/UX Programmer's Reference. Because the label names are exactly the same, they are 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 no default sections anywhere in the mandesc file. This line prevents xman from searching the default manual sections in that directory only. For example, suppose you want to do the same thing as above, but you don't think that it is useful to have the System Calls or Subroutines sections any longer. You would need to duplicate the default entries, as well as adding your new entries. 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 client application reads 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) does not search directories that are non-standard. Widget hierarchy To specify resources, it is useful to know the hierarchy of the widgets that compose xman. In the notation below, in- dentation indicates hierarchical structure. The widget class name is given first, followed by the widget instance name. November, 1990 3
xman(1X) xman(1X)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 List directory . . (One for each section, . created as needed) . 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 4 November, 1990
xman(1X) xman(1X)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 Resources The xman client has the following application-specific resources that allow customizations unique to xman. bothShown (Class Boolean) Specifies whether (TRUE) or not (FALSE) you want both the directory and the manual page shown at startup. directoryFontNormal (Class Font) Specifies the font to use for the directory text. directoryHeight (Class DirectoryHeight) Specifies in pixels the height of the directory when the directory and the manual page are shown simul- taneously. helpCursor (Class Cursor) Specifies the pointer to use in the help window. helpFile (Class File) Specifies a helpfile to use rather than the default helpfile. manpageCursor (Class Cursor) November, 1990 5
xman(1X) xman(1X)Specifies the pointer to use in the manual page win- dow. manualFontBold (Class Font) Specifies the font to use for bold text in the manu- al pages. manualFontItalic (Class Font) Specifies the font to use for italic text in the manual pages. manualFontNormal (Class Font) Specifies the font to use for normal text in the manual pages. pointerColor (Class Foreground) Specifies the color of the pointers specified above. The name was chosen to be compatible with xterm(1X). topBox (Class Boolean) Determines whether the initial window (containing the Help, Quit, and Manual Page buttons) or a manual page is put on the screen at startup. The default is to put the initial window on the screen (TRUE). topCursor (Class Cursor) Specifies the pointer to use in the initial window. searchEntryCursor (Class Cursor) Specifies the pointer to use in the search widget. verticalList (Class Boolean) Determines whether the directory listing is verti- cally (TRUE) or horizontally (FALSE) organized. The default is horizontal. Global actions The xman client application 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 action. The list of actions supported by xman are: CreateNewManpage() Creates a new manual page display window. This ac- tion can be used anywhere. GotoPage(page) Allows the user to move between a directory and manual page display when used in a manual page win- dow. The page argument can be either Directory or ManualPage. 6 November, 1990
xman(1X) xman(1X)PopupHelp() Pops up the help widget. This action can be used anywhere. PopupSearch() Causes the search popup to become active and visible on the screen, allowing the user to search for a manual page. This action may be used anywhere ex- cept in a help window. Quit() Exits xman. This action may be used anywhere. RemoveThisManpage() Removes the window and cleans up all resources asso- ciated with it. This action can be used in any manu- al page or help window. SaveFormattedPage(action) Tells xman whether to save or cancel a save of the manual page that has just been formatted. This ac- tion can only be used in the likeToSave pop-up widg- et. Search(type, action) Causes the search widget to perform the named search type on the string in the search popup's value widg- et. This action is only useful in a search popup. This action also pops down the search widget. The type argument can be either Apropos, Manpage or Can- cel. If an action of Open is specified, xman opens a new manual page to display the results of the search; otherwise, xman attempts to display the results in the parent of the search popup. ShowVersion() Causes the informational display line to show the current version of xman. This action can be called from any manual page or help window. Environment variables The xman command uses the following environment variables: DISPLAY Specifies the default host, display number, and screen. MANPATH Specifies the search path for manual pages. Direc- tories are separated by colons as in /usr/man:/mit/kit/man:/foo/bar/man. XAPPLRESDIR Specifies a string to which Xman is appended. This string is the full pathname of a user app-defaults November, 1990 7
xman(1X) xman(1X)file that is merged into the resource database after the system app-defaults file and before the resources that are attached to the display. XENVIRONMENT Specifies the name of a resource file to use to override the global resources stored in the RESOURCE_MANAGER property. NOTES Copyright 1988 by Massachusetts Institute of Technology. See X(1X) for a full statement of rights and permissions. Authors: Chris Peterson, MIT X Consortium, from the V10 ver- sion written by Barry Shein, formerly Boston University FILES <manpath directory>/man<character> <manpath directory>/cat<character> <manpath directory>/mandesc /usr/lib/X11/app-defaults/Xman Specifies required resources. /tmp Stores temporary files created by xman to format manual pages and created by apropos(1). SEE ALSO X(1X) apropos(1), man(1) in A/UX Command Reference Athena Widget Set - C Language Interface 8 November, 1990