NAME

podviewer - a Gtk2-Perl POD Reading Program

SYNOPSIS

        podviewer [FILE|MODULE|FUNCTION|POD]

DESCRIPTION

podviewer provides a simple and attractive way to read Perl's POD documentation. You can use it to read the Perl POD pages, module documentation and information about Perl's builtin functions.

KEYBOARD SHORTCUTS

podviewer supports a wide number of keyboard shortcuts. They are documented here.

• Ctrl-U or Alt-Up

  Go up a level. That is, if you're reading the documentation for Foo::Bar, typing Ctrl-U will take you to the Foo page.

• Alt-Left

  Go back in your browsing history.

• Alt-Right

  Go forward in your browsing history.

• Ctrl-H

  Go home. If you have the home option set in your config (see below), entering Ctrl-H will take you there.

• Ctrl-L

  This toggles the document index.

• Ctrl-O

  This pops up a dialog allowing you to choose a document to read.

• Ctrl-R or F5

  This reloads the current document.

• Ctrl-Q

  This quits the program.

• Ctrl-F

  This pops up a dialog for you to enter some search text.

• Ctrl-G

  This performs the previous search, but from the most recently found result. You can also repeat the previous search by pressing enter when the cursor is in the search box.

• F1

  Loads this document.

CONFIGURATION OPTIONS

podviewer stores its configuration settings in a resource file, located at $HOME/.podviewrc. This file contains simple name=value pairs for various things:

• icon-size

  If you want to change the size of the icons on the toolbar, change this value. The values are standard Gtk+ stock values.

• home

  This is the name of the document you want to be your home page. This page is loaded when you start the program without arguments, hit the Home button, or type Ctrl-H.

SEE ALSO

• Gtk2 or http://gtk2-perl.sf.net/

• http://developer.gnome.org/doc/API/2.0/gtk/GtkTextView.html

• Gtk2::Ex::PodViewer::Parser

AUTHORS

Gavin Brown, Torsten Schoenfeld and Scott Arrington.

COPYRIGHT

(c) 2003-2005 Gavin Brown (gavin.brown@uk.com). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.