Prima::HelpViewer - the built-in pod file browser
The module presents two packages, "Prima::HelpViewer" and
"Prima::PodViewWindow". Their sole purpose is to serve as a mediator
between "Prima::PodView" package, the toolkit help interface and the
user. "Prima::PodViewWindow" includes all the user functionality,
including ( but not limited to :) text search, color and font setup,
printing etc. "Prima::HelpViewer" provides two methods - "open" and
"close", used by "Prima::Application" for help viewer invocation.
The browser can be used to view and print POD ( plain old documentation
) files. See the command overview below for more detailed description:
Presents a file selection dialog, when the user can select a
file to browse in the viewer. The file must contain POD
content, otherwise a warning is displayed.
Asks for a manpage, that is searched in PATH and the
Opens the new viewer window with the same context.
Run Commands in this group call external processes
p-class is Prima utility for displaying the widget class
hierachies. The command asks for Prima class to display
the hierachy information for.
Provides a dialog, when the user can select the appropriate
printer device and its options.
Prints the current topic to the selected printer.
If "Full text view" menu item is checked, prints the whole
Closes the window.
Close all windows
Closes all help viewer windows.
Increases the currently selected font by 2 points.
Decreases the currently selected font by 2 points.
Full text view
If checked, the whole manpage is displayed. Otherwise, its
content is presented as a set of topic, and only one topic is
Presents a find dialog, where the user can select the text to
search and the search options - the search direction, scope,
Starts search for the text, entered in the last find dialog,
with the same search options.
The following commands provide a simple vi-style text search
functionality - character keys ?,/,n,N bound to the commands
Presents an input line where a text can be entered; the
text search is performed parallel to the input.
Same as Forward option, except that the serach direction is
Repeat the search in the same direction as the initial
search was being invoked.
Repeat the search in the reverse direction as the initial
search was being invoked.
Presents a setup dialog, where the user can select appropriate
fonts and colors.
Displays the previously visited manpage ( or topic )
Displays the previously visited manpage ( or topic ), that was
left via Back command.
Up Displays the upper level topic within a manpage.
Moves to the previous topic within a manpage.
Moves to the next topic within a manpage.
Displays the information about the help viewer.
Displays the information about the usage of the help viewer
Dmitry Karasik, <email@example.com>.
This program is distributed under the BSD License.