.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
.\}
.\" ========================================================================
.\"
.IX Title "PODVIEWER 1p"
.TH PODVIEWER 1p "2018-06-30" "perl v5.26.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
podviewer \- a Gtk2\-Perl POD Reading Program
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& podviewer [FILE|MODULE|FUNCTION|POD]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`podviewer\*(C'\fR provides a simple and attractive way to read Perl's \s-1POD\s0 documentation. You can use it to read the Perl \s-1POD\s0 pages, module documentation and information about Perl's builtin functions.
.SH "KEYBOARD SHORTCUTS"
.IX Header "KEYBOARD SHORTCUTS"
\&\f(CW\*(C`podviewer\*(C'\fR supports a wide number of keyboard shortcuts. They are documented here.
.IP "\(bu" 4
\&\f(CW\*(C`Ctrl\-U\*(C'\fR or \f(CW\*(C`Alt\-Up\*(C'\fR
.Sp
Go up a level. That is, if you're reading the documentation for \f(CW\*(C`Foo::Bar\*(C'\fR, typing \f(CW\*(C`Ctrl\-U\*(C'\fR will take you to the \f(CW\*(C`Foo\*(C'\fR page.
.IP "\(bu" 4
\&\f(CW\*(C`Alt\-Left\*(C'\fR
.Sp
Go back in your browsing history.
.IP "\(bu" 4
\&\f(CW\*(C`Alt\-Right\*(C'\fR
.Sp
Go forward in your browsing history.
.IP "\(bu" 4
\&\f(CW\*(C`Ctrl\-H\*(C'\fR
.Sp
Go home. If you have the \f(CW\*(C`home\*(C'\fR option set in your config (see below), entering \f(CW\*(C`Ctrl\-H\*(C'\fR will take you there.
.IP "\(bu" 4
\&\f(CW\*(C`Ctrl\-L\*(C'\fR
.Sp
This toggles the document index.
.IP "\(bu" 4
\&\f(CW\*(C`Ctrl\-O\*(C'\fR
.Sp
This pops up a dialog allowing you to choose a document to read.
.IP "\(bu" 4
\&\f(CW\*(C`Ctrl\-R\*(C'\fR or \f(CW\*(C`F5\*(C'\fR
.Sp
This reloads the current document.
.IP "\(bu" 4
\&\f(CW\*(C`Ctrl\-Q\*(C'\fR
.Sp
This quits the program.
.IP "\(bu" 4
\&\f(CW\*(C`Ctrl\-F\*(C'\fR
.Sp
This pops up a dialog for you to enter some search text.
.IP "\(bu" 4
\&\f(CW\*(C`Ctrl\-G\*(C'\fR
.Sp
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.
.IP "\(bu" 4
\&\f(CW\*(C`F1\*(C'\fR
.Sp
Loads this document.
.SH "CONFIGURATION OPTIONS"
.IX Header "CONFIGURATION OPTIONS"
\&\f(CW\*(C`podviewer\*(C'\fR stores its configuration settings in a resource file, located at \f(CW\*(C`$HOME/.podviewrc\*(C'\fR. This file contains simple \f(CW\*(C`name=value\*(C'\fR pairs for various things:
.IP "\(bu" 4
\&\f(CW\*(C`icon\-size\*(C'\fR
.Sp
If you want to change the size of the icons on the toolbar, change this value. The values are standard Gtk+ stock values.
.IP "\(bu" 4
\&\f(CW\*(C`home\*(C'\fR
.Sp
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 \f(CW\*(C`Ctrl\-H\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Gtk2 or
.IP "\(bu" 4
.IP "\(bu" 4
Gtk2::Ex::PodViewer::Parser
.SH "AUTHORS"
.IX Header "AUTHORS"
Gavin Brown, Torsten Schoenfeld and Scott Arrington.
.SH "COPYRIGHT"
.IX Header "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.