tkpod(1) - f38

1TKPOD(1)              User Contributed Perl Documentation             TKPOD(1)
2
3
4

NAME

6       tkpod - Perl/Tk Pod browser
7

SYNOPSIS

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

DESCRIPTION

14       tkpod is a simple Pod browser with hypertext capabilities.  Pod (Plain
15       Old Document) is a simple and readable markup language that could be
16       mixed with perl code.
17
18       Pods are searched by default in @INC and $ENV{PATH}. Directories listed
19       on the command line or with the -I option are added to the default
20       search path.
21
22       For each "name" listed on the command line tkpod tries to find Pod in
23       "name", "name.pod" and "name.pm" in the search path.  For each "name" a
24       new Pod browser window is opened.
25
26       If no "name" is listed, then the main "perl" pod is opened instead.
27

OPTIONS

29       -tree
30           When specified, "tkpod" will show a tree window with all available
31           Pods on the local host. However, this may be slow on startup,
32           especially first time because there is no cache yet. You can always
33           turn on the tree view with the menu entry 'View' -> 'Pod Tree'.
34
35       -tk Useful for perl/Tk documentation.  When specified it adds all "Tk"
36           subdirectories in @INC to the Pod search path.   This way when
37           "Scrolled" is selected in the browser the "Tk/Scrolled"
38           documentation is found.
39
40       -s or -server
41           Start "tkpod" in server mode. Subsequent calls to "tkpod" (without
42           the -s option) will cause to load the requested Pods into the
43           server program, thus minimizing startup time and memory usage. Note
44           that there is no access control, so this might be a security hole!
45
46       -Mblib
47           Add the "blib" directories under the current directory to the Pod
48           search path.
49
50       -I dir
51           Add another directory to the Pod search path. Note that the space
52           is mandatory.
53
54       -f function
55           Show documentation for function.
56
57       -q FAQRegex
58           Show the FAQ entry matching FAQRegex.
59
60       -filedialog module
61           Use an alternative file dialog module, e.g. Tk::FileSelect,
62           Tk::FBox or Tk::PathEntry::Dialog.
63
64       -d or -debug
65           Turn debugging on.
66
67       -exit
68           Only for internal testing: exit before entering "MainLoop".
69

USAGE

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

ENVIRONMENT

75       TKPODPORT
76           Force a port for tkpod's server mode.
77
78       TKPODDIRS
79           A list of directories (on Unix usually separated by ":", on Windows
80           by ";") for additional Pod directories. These directories will
81           appear in the "local dirs" section of the tree view.
82
83       See "Environment" in Tk::Pod::Text and "Environment" in
84       Tk::Pod::FindPods for more environment variables.
85

KNOWN BUGS

87       see Tk::Pod::Text
88

AUTHOR

93       Nick Ing-Simmons <nick@ni-s.u-net.com>
94
95       Former maintainer: Achim Bohnet <ach@mpe.mpg.de>.
96
97       Code currently maintained by Slaven Rezic <slaven@rezic.de>.
98
99       Copyright (c) 1997-1998 Nick Ing-Simmons.  Copyright (c) 2015 Slaven
100       Rezic.  All rights reserved. This program is free software; you can
101       redistribute it and/or modify it under the same terms as Perl itself.
102
103
104
105perl v5.36.0                      2023-01-20                          TKPOD(1)