11.4.9. xman: A Point-and-Click Interface to Manual Pages
Manual pages, read through the man command, are the ultimate
authority on a Unix system. Other books can describe a significant
percentage of any given command's functions--and often describe
them in a more readable fashion--but only the manual page has all the
details. See the section "Section 4.12, "Manual Pages"" in
Chapter 4, "Basic Unix
Commands
and Concepts" for basic information.
Now there's a simple X interface to manual pages: the xman command.
As befits a tool that displays documents, it contains a pretty good
description of itself. In order to see this documentation clearly,
start up the program with a large page size:
eggplant$ xman -pagesize 650x600
What you see first is a tiny box with three buttons. Click on the
Manual Page button to bring up the main screen, where you'll do
most of your work.
Now you see the xman documentation. You'll have plenty of time
to read this; for now, just pull down the Options menu and
choose Search, or press Ctrl-S. (You can also display the
options menu by holding down the Control key and pressing the
left mouse button.) In the box that pops up, type in a command
or function you'd like to read about, then press the Enter key.
The contents of the main window are replaced by the corresponding
manual page.
If you don't know what to look for, try pulling down the Sections
menu or pressing the Control key along with the middle
button. Choose a section from the menu that appears. You'll see a
long list of manual pages. Click the left button on one of them,
and the document will be displayed.
Another time-honored way to look for information is through the
apropos command (discussed already in the section
"Section 4.12, "Manual Pages"" in
Chapter 4, "Basic Unix
Commands
and Concepts"). Press Ctrl-S
again, type in a word about a
subject you're interested in, and press the Apropos button. If
any manual pages match that word, their names will be displayed along
with short descriptions. Unfortunately, you can't call up their
manual pages by clicking on them; that little convenience was left out
of xman. You have to press Ctrl-S and type in the page that
looks interesting.
Within a manual page, scrolling is easy. Use the space bar or f to
move down a page, b to move up. You can also use the scrollbar,
just as in xterm.
Now you can read the documentation! Press the Help button on the small
window that appeared when you started xterm. To exit the
program, press Ctrl-Q or the Quit button, or choose Quit
from the Options menu.
If you think that xman is still too
bare-bones and not much of an improvement over the
command-line man command, you can try one
of its more advanced companions. For example,
tkman has a much nicer user interface and
features advanced navigation possibilities. The KDE
help system,
kdehelp, can display manual and info pages
in addition to its own HTML pages and thus unifies the three
major documentation formats on Linux.