.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PODGREP 1p"
.TH PODGREP 1p "2022-10-14" "perl v5.34.0" "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"
podgrep \- grep in pod sections only
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
podgrep [\fB\-i\fR] [\fB\-p\fR] [\fB\-f\fR] [\fB\-h\fR] \fIpattern\fR [ \fIfiles\fR ... ]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This program searches each paragraph in a pod document and prints each
paragraph that matches the supplied pattern.  This pod may be mixed with
program code, such as in a module.
.PP
Options are:
.IP "\-i" 4
.IX Item "-i"
means case insensitive match
.IP "\-p" 4
.IX Item "-p"
means page output though the user's pager.  The pager will be primed
with an argument to search for the string.  This highlights the result.
.IP "\-f" 4
.IX Item "-f"
means format output though the \fIpod2text\fR program.
.IP "\-h" 4
.IX Item "-h"
means check for matches in pod \f(CW\*(C`=head\*(C'\fR and \f(CW\*(C`=item\*(C'\fR headers alone,
and to keep printing podagraphs until the next header is found.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 2
\&    $ podgrep mail \`pmpath CGI\`
\&    (prints out podagraphs from the CGI.pm manpage that mention mail)
\&
\&    $ podgrep \-i destructor \`sitepods\`
\&    (prints out podagraphs that mention destructors in the 
\&     site\-installed pods)
\&
\&    $ podgrep \-i \*(Aqtype.?glob\*(Aq \`stdpods\`
\&
\&    (prints out podagraphs that mention typeglob in the
\&     standard pods)
\&
\&    $ podgrep \-hpfi "lock" \`faqpods\`
\&
\&    (prints out all podagraphs with "lock" in the headers
\&    case\-insensitively, then formats these with pod2text, then
\&    shows them in the pager with matches high\-lighted)
\&
\&    $ podgrep \-fh seek \`podpath perlfunc\`
\&    (prints out and formats podagraphs from the standard perlfunc manpage
\&    whose headers or items contain "seek".)
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBfaqpods\fR\|(1),
\&\fBpfcat\fR\|(1), 
\&\fBpmpath\fR\|(1),
\&\fBpod2text\fR\|(1), 
\&\fBpodpath\fR\|(1),
\&\fBsitepods\fR\|(1),
\&\fBstdpods\fR\|(1),
and
\&\fBtcgrep\fR\|(1).
.SH "NOTE"
.IX Header "NOTE"
For a pager, the author likes these environment settings (in the login
startup, of course):
.PP
.Vb 2
\&    $ENV{PAGER} = "less";
\&    $ENV{LESS}  = "MQeicsnf";
.Ve
.SH "AUTHORS and COPYRIGHTS"
.IX Header "AUTHORS and COPYRIGHTS"
Copyright (C) 1999 Tom Christiansen.
.PP
Copyright (C) 2006\-2014, 2018 Mark Leighton Fisher.
.SH "LICENSE"
.IX Header "LICENSE"
This is free software; you can redistribute it and/or modify it
under the terms of either:
(a) the \s-1GNU\s0 General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
(b) the Perl \*(L"Artistic License\*(R".
(This is the Perl 5 licensing scheme.)
.PP
Please note this is a change from the
original pmtools\-1.00 (still available on \s-1CPAN\s0),
as pmtools\-1.00 were licensed only under the
Perl \*(L"Artistic License\*(R".