multivalent.std.adaptor

Class ManualPage

public class ManualPage extends MediaAdaptorByte

Media adaptor for UNIX manual pages (directly from roff -man source). Along with HTML and ASCII, example of a media adaptor directly building the tree rather than first translating to a big HTML String. No need for nroff, rman, or caching formatted pages. Parsing is much faster than TkMan, because TkMan can't parse in Tcl (waaay to slow) and rman costs and exec and generating a big string and processing a big string by Tk text widget. In fact, this is so fast that there is no need for preformatted cat versions of pages, or for progressive rendering as manual pages are usually local and even is bash (200K) short enough to be fast (4 seconds, with decompression while playing MP3 on 500MHz Pentium III).

To do

Discarded ideas / Not going to happen

Later, perhaps

Version: $Revision: 1.15 $ $Date: 2003/06/02 05:40:19 $

See Also: ManualPageVolume

Method Summary
Objectparse(INode root)
Parse *roff, translate to document tree.
booleansemanticEventBefore(SemanticEvent se, String msg)
Since not all man page references are recognizable as such, have docpopup choice to treat current word as man page ref.
voidsetInputStream(InputStream is)

Method Detail

parse

public Object parse(INode root)
Parse *roff, translate to document tree.

semanticEventBefore

public boolean semanticEventBefore(SemanticEvent se, String msg)
Since not all man page references are recognizable as such, have docpopup choice to treat current word as man page ref.

setInputStream

public void setInputStream(InputStream is)