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

NAME

6       podgrep - grep in pod sections only
7

SYNOPSIS

9       podgrep [-i] [-p] [-f] [-h] pattern [ files ... ]
10

DESCRIPTION

12       This program searches each paragraph in a pod document and prints each
13       paragraph that matches the supplied pattern.  This pod may be mixed
14       with program code, such as in a module.
15
16       Options are:
17
18       -i  means case insensitive match
19
20       -p  means page output though the user's pager.  The pager will be
21           primed with an argument to search for the string.  This highlights
22           the result.
23
24       -f  means format output though the pod2text program.
25
26       -h  means check for matches in pod "=head" and "=item" headers alone,
27           and to keep printing podagraphs until the next header is found.
28

EXAMPLES

30           $ podgrep mail `pmpath CGI`
31           (prints out podagraphs from the CGI.pm manpage that mention mail)
32
33           $ podgrep -i destructor `sitepods`
34           (prints out podagraphs that mention destructors in the
35            site-installed pods)
36
37           $ podgrep -i 'type.?glob' `stdpods`
38
39           (prints out podagraphs that mention typeglob in the
40            standard pods)
41
42           $ podgrep -hpfi "lock" `faqpods`
43
44           (prints out all podagraphs with "lock" in the headers
45           case-insensitively, then then formats these with pod2text, then
46           shows them in the pager with matches high-lighted)
47
48           $ podgrep -fh seek `podpath perlfunc`
49           (prints out and formats podagraphs from the standard perlfunc manpage
50           whose headers or items contain "seek".)
51

SEE ALSO

53       faqpods(1), pfcat(1), pmpath(1), pod2text(1), podpath(1), sitepods(1),
54       stdpods(1), and tcgrep(1).
55

NOTE

57       For a pager, the author likes these environment settings (in the login
58       startup, of course):
59
60           $ENV{PAGER} = "less";
61           $ENV{LESS}  = "MQeicsnf";
62

64       Copyright (c) 1999 Tom Christiansen
65
66       This is free software.  You may modify it and distribute it under
67       Perl's Artistic Licence.  Modified versions must be clearly indicated.
68
69
70
71perl v5.8.8                       2006-03-30                        PODGREP(1)
Impressum