Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

podgrep(1p) [debian man page]

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

NAME

       podgrep - grep in pod sections only

SYNOPSIS

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

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.

       Options are:

       -i  means case insensitive match

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

       -f  means format output though the pod2text program.

       -h  means check for matches in pod "=head" and "=item" headers alone, and to keep printing podagraphs until the next header is found.

EXAMPLES

	   $ 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 'type.?glob' `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 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".)

SEE ALSO

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

NOTE

       For a pager, the author likes these environment settings (in the login startup, of course):

	   $ENV{PAGER} = "less";
	   $ENV{LESS}  = "MQeicsnf";

AUTHORS and COPYRIGHTS
       Copyright (C) 1999 Tom Christiansen.

       Copyright (C) 2006-2008 Mark Leighton Fisher.

       This is free software; you can redistribute it and/or modify it under the terms of either: (a) the GNU General Public License as published
       by the Free Software Foundation; either version 1, or (at your option) any later version, or (b) the Perl "Artistic License".  (This is the
       Perl 5 licensing scheme.)

       Please note this is a change from the original pmtools-1.00 (still available on CPAN), as pmtools-1.00 were licensed only under the Perl
       "Artistic License".

perl v5.10.1							    2010-02-22							       PODGREP(1p)

Check Out this Related Man Page

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

NAME

       modpods - print out paths for the standard modules

DESCRIPTION

       This program outputs the paths to all installed modules on your systems.  This includes both the standard modules (which the stdpods
       command produces) and the site-specific ones (which the sitepods command produces).

       This is just a front-end for calling pminst -l, supplied to make it more obvious what it does.

EXAMPLE

       This finds all the modules whose documentation mentions destructors, and cats it out at you.

	   $ podgrep -i destructor `modpods`

	   =head1 /usr/local/devperl/lib/5.00554/i686-linux/DB_File.pm chunk 371

	   Having read L<perltie> you will probably have already guessed that the
	   error is caused by the extra copy of the tied object stored in C<$X>.
	   If you haven't, then the problem boils down to the fact that the
	   B<DB_File> destructor, DESTROY, will not be called until I<all>
	   references to the tied object are destroyed. Both the tied variable,
	   C<%x>, and C<$X> above hold a reference to the object. The call to
	   untie() will destroy the first, but C<$X> still holds a valid
	   reference, so the destructor will not get called and the database file
	   F<tst.fil> will remain open. The fact that Berkeley DB then reports the
	   attempt to open a database that is alreday open via the catch-all
	   "Invalid argument" doesn't help.

	   =head1 /usr/local/devperl/lib/5.00554/Tie/Array.pm chunk 40

	   Normal object destructor method.

SEE ALSO

       podgrep(1), modpods(1), pods(1), sitepods(1), podpath(1), and stdpod(1).

AUTHORS and COPYRIGHTS
       Copyright (C) 1999 Tom Christiansen.

       Copyright (C) 2006-2008 Mark Leighton Fisher.

       This is free software; you can redistribute it and/or modify it under the terms of either: (a) the GNU General Public License as published
       by the Free Software Foundation; either version 1, or (at your option) any later version, or (b) the Perl "Artistic License".  (This is the
       Perl 5 licensing scheme.)

       Please note this is a change from the original pmtools-1.00 (still available on CPAN), as pmtools-1.00 were licensed only under the Perl
       "Artistic License".

perl v5.10.1							    2010-02-22							       MODPODS(1p)
Man Page