xman(1X) — Unsupported
Name
xman - X Window System reference page display program
Syntax
xman [options ]
Description
The xman manual page viewer is an X Toolkit-based display program. At startup, xman provides a window that consists of the following three areas:
HelpDisplays online help information.
QuitExits xman.
Manual PageDisplays the manual page.
Xman creates temporary files for all unformatted manual pages and all apropos searches. These files are stored in /tmp.
Options
−bd color Specifies the color of the window’s border (color displays only). The default is black.
−bg color Specifies the color of the window’s background (color displays only). The default is white.
−bothshown Specifies that xman display both the manual page and the directory.
−d dispname Specifies the display screen on which xman displays its window. If the display option is not specified, xman uses the display screen specified by your DISPLAY environment variable. The display option has the format hostname:number. Using two colons (::) instead of one (:) indicates that DECnet is to be used for transport. The default is :0. For more information, see X(.).
−display dispname This option is the same as the −d option.
−fg color Specifies the color of the text (color displays only). The default is black.
−fn font Specifies the font. The default is 6x10.
−geometry Specifies the width, length, and location of the xman window. If the geometry option is not specified, xman uses default values. The geometry option has the format [width][xlength][x][y]. For more information about the screen coordinate system, see X(.).
−notopbox Specifies that no top box is displayed at startup.
−pagesize Specifies the size and location of the reference pages. The pagesize option has the format (height)x(width)+(x_offset)+(y_offset).
xrm string Specifies the resource to be used.
Mandesc File
When invoked, xman searches for a Mandesc file in each directory specified in the reference page search path. The Mandesc file tells xman to create a separate section for one or more of the directories in the reference page search path. For example, if your reference page search path is /usr/man:/usr/sipb/man then xman searches /usr/man. If there is no Mandesc file in /usr/man, then xman searches /usr/sipb/man for a Mandesc file. If no Mandesc file is found, xman stores all of its files in the default section names (for example, manl gets a section name of local). If there is a Mandesc file, xman stores all man1 files in this directory. Like man(1), xman searches only the man1 through man8 and the manl and mann directories. It ignores the information in mano unless the Mandesc overrides this.
Separate directory names by a colon (:) in your Mandesc file.
X Defaults
The xman application reads the .Xdefaults file during startup and uses the appropriate resource specification to customize the appearance or characteristics of its displayed xman window. The format for a resource specification in the .Xdefaults file is: [name.]resource: value
nameSpecifies the application name or, in the case of X Toolkit-based applications, the name string that restricts the resource assignment to that application or to a component of an application. If this argument is not specified, the resource assignment is globally available to all X applications.
resourceSpecifies the X resource.
valueSpecifies the value that is to be assigned to the resource.
In most cases, the period (.) delimiter should be replaced by an asterisk (*). For more information, see X(.).
Because each toolkit-based application can consist of a combination of widgets (for example, command buttons and a scroll bar), you can form the name string by adding widget class and name identifiers to the string. For further information about adding class and name identifiers, see X(.).
For xman, the available name identifiers are:
help
manualBrowser
topBox
xmanCommands
xmanSearch
xmanSections
For xman, the available resources are:
bothShownSpecifies that xman display both the directory and the manual page at startup.
directoryFontNormalSpecifies the font used for the directory text
directoryHeightSpecifies the size of the directory (in pixels) when both the directory and the manual page are displayed.
helpCursorSpecifies the cursor to use in the help window.
helpFileSpecifies a file to replace the system default help file.
manpageCursorSpecifies the cursor to use in the manual page window.
manualFontBoldSpecifies the bold font
manualFontItalicSpecifies the italic font
manualFontNormalSpecifies the display font
searchEntryCursorSpecifies the cursor in the search entry text widget.
topBoxSpecifies what is put on the screen at startup. If true the top box, containing the help, quit, and manual page buttons, is displayed at startup. If false, a manual page is displayed at startup. The default is true.
topCursorSpecifies the cursor to use in the top box.
verticalListSpecifies that xman display the directory listing vertically (true) or horizontally (false). The default is horizontal (false).
Files
/usr/man/* or those specified in the reference page search path
mandesc
Restrictions
The last button pressed in any of the pop-up menus stays highlighted.