NAME

tkpod - Perl/Tk POD browser

SYNOPSIS

    tkpod  [-tk]  [directory]|name [...]

DESCRIPTION

tkpod is a simple POD browser with hypertext capabilities. POD (Plain Old Document, see perlpod) is a simple and readable markup language that could be mixed with perl code.

PODs are searched by default in @INC. Directories listed on the command line are added to the default search path.

For each name listed on the command line tkpod tries to to find POD in name, name.pod and name.pm in the search path. For each name a new POD browser window is opened.

OPTIONS

-tk

Useful for perl/Tk documentation. When specified it adds all Tk subdirectories in @INC to the POD search path. This way when Scrolled is selected in the browser the Tk/Scrolled documentation is found.

USAGE

To navigate through the documentation one could use

• Hyperlinks

  A click on a hyperlinks display the corresponding documentation (if there is any) in the same window.

  With <Button-2> the documentation is loaded into a new window (<Shift-Button-1> works also for those 2 button mouse owners).

• Selection

  A double click tries to load the documentation for the selected word in the same window.

  If the c<Shift> key is simultanously pressed the new window is opened.

• Search in POD document

  Pressing <Key-/> lets you search the displayed POD

• Action Menu

  If you press the right mouse button you get a popup menu that allows:

  o Back

  in history of displayed documentation

  o Reload

  the documentation

  o Edit

  start editor with source of the displayed document.

  The used editor is selected by the first defenition of the enviroment variables XEDITOR, VISUAL, EDITOR or as default /usr/bin/vi.

  o Search ...

  Full text search of the POD in the perl library directories. (Note: to use it one has to install perlindex distribution.)

KNOWN BUGS

see Tk::Pod::Text

SEE ALSO

perlpod, pod2man, pod2text, pod2html, Tk::Pod, Tk::Pod::Text