Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

tkpod(1p) [debian man page]

TKPOD(1p)						User Contributed Perl Documentation						 TKPOD(1p)

NAME

       tkpod - Perl/Tk Pod browser

SYNOPSIS

	   tkpod   [-tk] [[-no]tree] [-Mblib] [-I dir] [-d|debug] [-s|server]
		   [-filedialog module]
		   [-f function | -q FAQRegex | directory | name [...]]

DESCRIPTION

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

       Pods are searched by default in @INC and $ENV{PATH}. Directories listed on the command line or with the -I option are added to the default
       search path.

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

       If no "name" is listed, then the main "perl" pod is opened instead.

OPTIONS

       -tree
	   When specified, "tkpod" will show a tree window with all available Pods on the local host. However, this may be slow on startup,
	   especially first time because there is no cache yet. You can always turn on the tree view with the menu entry 'View' -> 'Pod Tree'.

       -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.

       -s or -server
	   Start "tkpod" in server mode. Subsequent calls to "tkpod" (without the -s option) will cause to load the requested Pods into the server
	   program, thus minimizing startup time and memory usage. Note that there is no access control, so this might be a security hole!

       -d or -debug
	   Turn debugging on.

       -Mblib
	   Add the "blib" directories under the current directory to the Pod search path.

       -I dir
	   Add another directory to the Pod search path. Note that the space is mandatory.

       -f function
	   Show documentation for function.

       -q FAQRegex
	   Show the FAQ entry matching FAQRegex.

       -filedialog module
	   Use an alternative file dialog module, e.g. Tk::FileSelect, Tk::FBox or Tk::PathEntry::Dialog.

USAGE

       How to navigate with the Pod browser is described in Tk::Pod_usage.  It's also accessible via the menu 'Help' -> 'Usage...'.

ENVIRONMENT

       TKPODPORT
	   Force a port for tkpod's server mode.

       TKPODDIRS
	   A list of directories (on Unix usually separated by ":", on Windows by ";") for additional Pod directories. These directories will
	   appear in the "local dirs" section of the tree view.

       See "Environment" in Tk::Pod::Text and "Environment" in Tk::Pod::FindPods for more environment variables.

KNOWN BUGS

       see Tk::Pod::Text

SEE ALSO

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

AUTHOR

       Nick Ing-Simmons <nick@ni-s.u-net.com>

       Former maintainer: Achim Bohnet <ach@mpe.mpg.de>.

       Code currently maintained by Slaven Rezic <slaven@rezic.de>.

       Copyright (c) 1997-1998 Nick Ing-Simmons.  All rights reserved.	This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

perl v5.14.2							    2012-03-04								 TKPOD(1p)

Check Out this Related Man Page

Pod::Simple::Text(3)					User Contributed Perl Documentation				      Pod::Simple::Text(3)

NAME

       Pod::Simple::Text -- format Pod as plaintext

SYNOPSIS

	 perl -MPod::Simple::Text -e 
	  "exit Pod::Simple::Text->filter(shift)->any_errata_seen" 
	  thingy.pod

DESCRIPTION

       This class is a formatter that takes Pod and renders it as wrapped plaintext.

       Its wrapping is done by Text::Wrap, so you can change $Text::Wrap::columns as you like.

       This is a subclass of Pod::Simple and inherits all its methods.

SEE ALSO

       Pod::Simple, Pod::Simple::TextContent, Pod::Text

SUPPORT

       Questions or discussion about POD and Pod::Simple should be sent to the pod-people@perl.org mail list. Send an empty email to
       pod-people-subscribe@perl.org to subscribe.

       This module is managed in an open GitHub repository, <https://github.com/theory/pod-simple/>. Feel free to fork and contribute, or to clone
       <git://github.com/theory/pod-simple.git> and send patches!

       Patches against Pod::Simple are welcome. Please send bug reports to <bug-pod-simple@rt.cpan.org>.

COPYRIGHT AND DISCLAIMERS

       Copyright (c) 2002 Sean M. Burke.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of
       merchantability or fitness for a particular purpose.

AUTHOR

       Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.  But don't bother him, he's retired.

       Pod::Simple is maintained by:

       o   Allison Randal "allison@perl.org"

       o   Hans Dieter Pearcey "hdp@cpan.org"

       o   David E. Wheeler "dwheeler@cpan.org"

perl v5.16.3							    2013-05-03						      Pod::Simple::Text(3)
Man Page