480 lines
18 KiB
HTML
480 lines
18 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of XMAN</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>XMAN</H1>
|
|
Section: User Commands (1)<BR>Updated: xman 1.1.5<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
xman - Manual page display program for the X Window System
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>xman</B>
|
|
|
|
[
|
|
<I>-options</I>
|
|
|
|
... ]
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<I>Xman</I>
|
|
|
|
is a manual page browser. The default size of the initial <I>xman</I>
|
|
window is small so that you can leave it running throughout your entire login
|
|
session. In the initial window there are three options:
|
|
<I>Help</I> will pop up a window with on-line help, <I>Quit</I> will
|
|
exit, and <I>Manual Page</I> 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 <I>xman</I>.
|
|
<P>
|
|
|
|
For further information on using <I>xman</I>, please read the on-line
|
|
help information. Most of this manual will discuss
|
|
customization of <I>xman</I>.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<P>
|
|
|
|
Xman supports all standard Toolkit command line arguments (see
|
|
<I><A HREF="/cgi-bin/man/man2html?7+X">X</A></I>(7)). The following additional arguments are supported.
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-helpfile</B> <I>filename</I><DD>
|
|
Specifies a helpfile to use other than the default.
|
|
<DT id="2"><B>-bothshown</B><DD>
|
|
Allows both the manual page and manual directory to be on the screen at
|
|
the same time.
|
|
<DT id="3"><B>-notopbox</B><DD>
|
|
Starts without the Top Menu with the three buttons in it.
|
|
<DT id="4"><B>-geometry</B> <I>WxH+X+Y</I><DD>
|
|
Sets the size and location of the Top Menu with the three buttons in it.
|
|
<DT id="5"><B>-pagesize</B> <I>WxH+X+Y</I><DD>
|
|
Sets the size and location of all the Manual Pages.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>CUSTOMIZING XMAN</H2>
|
|
|
|
<P>
|
|
|
|
<I>Xman</I>
|
|
|
|
allows customization of both the directories to be searched for manual pages,
|
|
and the name that each directory will map to in the <I>Sections</I>
|
|
menu. Xman determines which directories it will
|
|
search by reading the <I>MANPATH</I> environment variable. If no
|
|
<I>MANPATH</I> 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 xman to search.
|
|
<P>
|
|
<PRE>
|
|
setenv MANPATH /mit/kit/man:/usr/man
|
|
</PRE>
|
|
|
|
<P>
|
|
|
|
By default,
|
|
<I>xman</I>
|
|
|
|
will search each of the following directories (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.
|
|
<P>
|
|
<TABLE>
|
|
<TR VALIGN=top><TD>Directory</TD><TD>Section Name<BR></TD></TR>
|
|
<TR VALIGN=top><TD>-</TD><TD>-<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?1+man1">man1</A></TD><TD>(1) User Commands<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?2+man2">man2</A></TD><TD>(2) System Calls<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?3+man3">man3</A></TD><TD>(3) Subroutines<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?4+man4">man4</A></TD><TD>(4) Devices<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?5+man5">man5</A></TD><TD>(5) File Formats<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?6+man6">man6</A></TD><TD>(6) Games<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?7+man7">man7</A></TD><TD>(7) Miscellaneous<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?8+man8">man8</A></TD><TD>(8) Sys. Administration<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?l+manl">manl</A></TD><TD>(l) Local<BR></TD></TR>
|
|
<TR VALIGN=top><TD><A HREF="/cgi-bin/man/man2html?n+mann">mann</A></TD><TD>(n) New<BR></TD></TR>
|
|
<TR VALIGN=top><TD>mano</TD><TD>(o) Old<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
For instance, a user has three directories in her manual path and each
|
|
contain a directory called <I>man3</I>. All these manual pages will appear
|
|
alphabetically sorted when the user selects the menu item called
|
|
<I>(3) Subroutines</I>. If there is no directory called
|
|
<I>mano</I> in any of the directories in her MANPATH, or there are no manual
|
|
pages in any of the directories called <I>mano</I> then no menu item will be
|
|
displayed for the section called <I>(o) Old</I>.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>BSD AND LINUX SYSTEMS</H2>
|
|
|
|
<P>
|
|
|
|
In newer BSD and Linux systems, <I>Xman</I> will search for a file named
|
|
<I>/etc/man.conf</I> which will contain the list of directories containing
|
|
manual pages. See <I><A HREF="/cgi-bin/man/man2html?5+man.conf">man.conf</A></I>(5) for a complete description of the file
|
|
format.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>THE MANDESC FILE</H2>
|
|
|
|
<P>
|
|
|
|
By using the <I>mandesc</I> 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 <I>Sections</I> menu. This
|
|
functionality is only available on a section by section basis, and individual
|
|
manual pages may not be handled in this manner.
|
|
(Although generous use of
|
|
symbolic links --- see <I><A HREF="/cgi-bin/man/man2html?1+ln">ln</A></I>(1) --- will allow
|
|
almost any configuration you can imagine.)
|
|
<P>
|
|
|
|
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 <I>mandesc</I> file
|
|
would look like this:
|
|
<PRE>
|
|
|
|
2Programmer Subroutines
|
|
3Programmer Subroutines
|
|
|
|
</PRE>
|
|
|
|
This will add a menu item to the <I>Sections</I> 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 <I>exactly</I> the
|
|
same they will be added to the same section. Note, however, that the
|
|
original sections still exist.
|
|
<P>
|
|
|
|
If you want to completely ignore the default sections in a manual directory
|
|
then add the line:
|
|
<PRE>
|
|
|
|
no default sections
|
|
|
|
</PRE>
|
|
|
|
anywhere in your mandesc file. This keeps xman from searching
|
|
the default manual sections <I>In that directory only</I>. 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 <I>System Calls</I> or <I>Subroutines</I> sections
|
|
any longer. You would need to duplicate the default entries, as well as
|
|
adding your new one.
|
|
<PRE>
|
|
|
|
no default sections
|
|
<A HREF="/cgi-bin/man/man2html?1+1">1</A>(1) User Commands
|
|
2Programmer Subroutines
|
|
3Programmer Subroutines
|
|
<A HREF="/cgi-bin/man/man2html?4+4">4</A>(4) Devices
|
|
<A HREF="/cgi-bin/man/man2html?5+5">5</A>(5) File Formats
|
|
<A HREF="/cgi-bin/man/man2html?6+6">6</A>(6) Games
|
|
<A HREF="/cgi-bin/man/man2html?7+7">7</A>(7) Miscellaneous
|
|
<A HREF="/cgi-bin/man/man2html?8+8">8</A>(8) Sys. Administration
|
|
<A HREF="/cgi-bin/man/man2html?l+l">l</A>(l) Local
|
|
<A HREF="/cgi-bin/man/man2html?n+n">n</A>(n) New
|
|
o(o) Old
|
|
|
|
</PRE>
|
|
|
|
Xman will read any section that is of the form <I>man<character></I>, where
|
|
<character> is an upper or lower case letter (they are treated distinctly) or
|
|
a numeral (0-9). Be warned, however, that <A HREF="/cgi-bin/man/man2html?1+man">man</A>(1) and
|
|
<A HREF="/cgi-bin/man/man2html?8+catman">catman</A>(8) will not search directories that are non-standard.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>WIDGETS</H2>
|
|
|
|
In order to specify resources, it is useful to know the hierarchy of
|
|
the widgets which compose <I>xman</I>. In the notation below,
|
|
indentation indicates hierarchical structure. The widget class name
|
|
is given first, followed by the widget instance name.
|
|
<P>
|
|
<PRE>
|
|
Xman xman <I>(This widget is never used)</I>
|
|
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 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
|
|
|
|
</PRE>
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>APPLICATION RESOURCES</H2>
|
|
|
|
<I>xman</I> has the following application-specific resources which allow
|
|
customizations unique to <I>xman</I>.
|
|
<P>
|
|
|
|
<DL COMPACT>
|
|
<DT id="6"><B>manualFontNormal</B> (Class <B>Font</B>)<DD>
|
|
The font to use for normal text in the manual pages.
|
|
<DT id="7"><B>manualFontBold</B> (Class <B>Font</B>)<DD>
|
|
The font to use for bold text in the manual pages.
|
|
<DT id="8"><B>manualFontItalic</B> (Class <B>Font</B>)<DD>
|
|
The font to use for italic text in the manual pages.
|
|
<DT id="9"><B>directoryFontNormal</B> (Class <B>Font</B>)<DD>
|
|
The font to use for the directory text.
|
|
<DT id="10"><B>bothShown</B> (Class <B>Boolean</B>)<DD>
|
|
Either `true' or `false,' specifies whether or not you want both the
|
|
directory and the manual page shown at start up.
|
|
<DT id="11"><B>directoryHeight</B> (Class <B>DirectoryHeight</B>)<DD>
|
|
The height in pixels of the directory, when the directory and the manual page
|
|
are shown simultaneously.
|
|
<DT id="12"><B>topCursor</B> (Class <B>Cursor</B>)<DD>
|
|
The cursor to use in the top box.
|
|
<DT id="13"><B>helpCursor</B> (Class <B>Cursor</B>)<DD>
|
|
The cursor to use in the help window.
|
|
<DT id="14"><B>manpageCursor</B> (Class <B>Cursor</B>)<DD>
|
|
The cursor to use in the manual page window.
|
|
<DT id="15"><B>searchEntryCursor</B> (Class <B>Cursor</B>)<DD>
|
|
The cursor to use in the search entry text widget.
|
|
<DT id="16"><B>pointerColor</B> (Class <B>Foreground</B>)<DD>
|
|
This is the color of all the cursors (pointers) specified above. The
|
|
name was chosen to be compatible with xterm.
|
|
<DT id="17"><B>helpFile</B> (Class <B>File</B>)<DD>
|
|
Use this rather than the system default helpfile.
|
|
<DT id="18"><B>topBox</B> (Class <B>Boolean</B>)<DD>
|
|
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.
|
|
<DT id="19"><B>verticalList</B> (Class <B>Boolean</B>)<DD>
|
|
Either `true' or `false,' determines whether the directory listing is
|
|
vertically or horizontally organized. The default is horizontal (false).
|
|
</DL>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>GLOBAL ACTIONS</H2>
|
|
|
|
<I>Xman</I> 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 <I>xman</I> are:
|
|
<DL COMPACT>
|
|
<DT id="20"><B>GotoPage(</B><I>page</I><B>)</B>
|
|
|
|
<DD>
|
|
When used in a manual page display window this will allow the user to
|
|
move between a directory and manual page display. The <I>page</I> argument can
|
|
be either <B>Directory</B> or <B>ManualPage</B>.
|
|
<DT id="21"><B>Quit()</B>
|
|
|
|
<DD>
|
|
This action may be used anywhere, and will exit xman.
|
|
<DT id="22"><B>Search(</B><I>type</I><B>, </B><I>action</I><B>)</B>
|
|
|
|
<DD>
|
|
Only useful when used in a search popup, this action will cause the search
|
|
widget to perform the named search type on the string in the search popup's
|
|
value widget. This action will also pop down the search widget. The
|
|
<I>type</I> argument can be either <B>Apropos</B>, <B>Manpage</B> or
|
|
<B>Cancel</B>. If an <I>action</I> of <B>Open</B> 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.
|
|
<DT id="23"><B>PopupHelp()</B>
|
|
|
|
<DD>
|
|
This action may be used anywhere, and will popup the help widget.
|
|
<DT id="24"><B>PopupSearch()</B>
|
|
|
|
<DD>
|
|
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.
|
|
<DT id="25"><B>CreateNewManpage()</B>
|
|
|
|
<DD>
|
|
This action may be used anywhere, and will create a new manual page
|
|
display window.
|
|
<DT id="26"><B>RemoveThisManpage()</B>
|
|
|
|
<DD>
|
|
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.
|
|
<DT id="27"><B>SaveFormattedPage(</B><I>action</I>)
|
|
|
|
<DD>
|
|
This action can only be used in the <B>likeToSave</B> popup widget, and
|
|
tells xman whether to <B>Save</B> or <B>Cancel</B> a save of the
|
|
manual page that has just been formatted.
|
|
<DT id="28"><B>ShowVersion()</B>
|
|
|
|
<DD>
|
|
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.
|
|
</DL>
|
|
<A NAME="lbAL"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="29"><I><manpath directory></I>/man<<I>character</I>><DD>
|
|
<DT id="30"><I><manpath directory></I>/cat<<I>character</I>><DD>
|
|
<DT id="31"><I><manpath directory></I>/mandesc<DD>
|
|
<DT id="32">/etc/X11/app-defaults/Xman<DD>
|
|
specifies required resources.
|
|
<DT id="33">/tmp<DD>
|
|
<I>Xman</I>
|
|
|
|
creates temporary files in /tmp for all unformatted man pages and all apropos
|
|
searches.
|
|
</DL>
|
|
<A NAME="lbAM"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?7+X">X</A></I>(7),
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+man">man</A></I>(1),
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+apropos">apropos</A></I>(1),
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?8+catman">catman</A></I>(8),
|
|
|
|
<I>Athena Widget Set</I>
|
|
|
|
<A NAME="lbAN"> </A>
|
|
<H2>ENVIRONMENT</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="34"><B>DISPLAY</B>
|
|
|
|
<DD>
|
|
the default host and display to use.
|
|
<DT id="35"><B>MANPATH</B>
|
|
|
|
<DD>
|
|
the search path for manual pages. Directories are separated by
|
|
colons (e.g. /usr/man:/mit/kit/man:/foo/bar/man).
|
|
<DT id="36"><B>XENVIRONMENT</B>
|
|
|
|
<DD>
|
|
to get the name of a resource file that overrides the global resources
|
|
stored in the RESOURCE_MANAGER property.
|
|
<DT id="37"><B>XAPPLRESDIR</B>
|
|
|
|
<DD>
|
|
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.
|
|
<BR>
|
|
|
|
See <I><A HREF="/cgi-bin/man/man2html?7+X">X</A>(7)</I> for a full statement of rights and permissions.
|
|
</DL>
|
|
<A NAME="lbAO"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
Chris Peterson, MIT X Consortium from the V10 version written by Barry
|
|
Shein formerly of Boston University.
|
|
Bug fixes and Linux support by Carlos A M dos Santos, for The XFree86 Project.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="38"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="39"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="40"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="41"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="42"><A HREF="#lbAF">CUSTOMIZING XMAN</A><DD>
|
|
<DT id="43"><A HREF="#lbAG">BSD AND LINUX SYSTEMS</A><DD>
|
|
<DT id="44"><A HREF="#lbAH">THE MANDESC FILE</A><DD>
|
|
<DT id="45"><A HREF="#lbAI">WIDGETS</A><DD>
|
|
<DT id="46"><A HREF="#lbAJ">APPLICATION RESOURCES</A><DD>
|
|
<DT id="47"><A HREF="#lbAK">GLOBAL ACTIONS</A><DD>
|
|
<DT id="48"><A HREF="#lbAL">FILES</A><DD>
|
|
<DT id="49"><A HREF="#lbAM">SEE ALSO</A><DD>
|
|
<DT id="50"><A HREF="#lbAN">ENVIRONMENT</A><DD>
|
|
<DT id="51"><A HREF="#lbAO">AUTHORS</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:31 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|