pod::index::extract(3pm) [debian man page]

Pod::Index::Extract(3pm)				User Contributed Perl Documentation				  Pod::Index::Extract(3pm)

NAME

       Pod::Index::Extract - Extracts a "pod scope"

SYNOPSIS

	   use Pod::Index::Extract;

	   my $parser = Pod::Index::Extract->new;
	   # [...] get $fh_in to the desired position
	   $parser->parse_from_filehandle($fh_in, $fh_out);

DESCRIPTION

       This module is a subclass of Pod::Parser. It outputs POD without any transformation; however, it only outputs the POD that is "in scope" as
       defined in Pod::Index.

       To use this module, you first need to position a filehandle at the beginning of the desired scope, and then call "parse_from_filehandle"
       with that filehandle for input. It will just print the POD until it reaches the end of the scope, after which it will jump to the end of
       the file.

       If the scope starts with an "=item", it will wrap it with an "=over" and a "=back", so it can be used as valid POD in isolation.

VERSION

       0.14

SEE ALSO

       Pod::Index, Pod::Index::Entry, Pod::Parser

AUTHOR

       Ivan Tubert-Brohman <itub@cpan.org>

COPYRIGHT

       Copyright (c) 2005 Ivan Tubert-Brohman. 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.10.0							    2005-10-16						  Pod::Index::Extract(3pm)

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

NAME

       podindex - build index from pods

SYNOPSYS

       podindex [options] <pod(s)>...

       Reads pod(s) and prints an index to stdout. Options:

	   --package=PACKAGE   precede the index by a perl package declaration
	   --help	       this help
	   --version	       print version number

DESCRIPTION

       This is a simple wrapper script around Pod::Index::Builder. It parses the POD files given as arguments, finds all X<> entries, generates an
       index and prints it to standard output.

OPTIONS

       package
	   If given, it will place the index in the __DATA__ section of a perl package.  For example,

	       podindex --package=perlindex perlop.pod

	   outputs something like this:

		   package perlindex;
		   1;
		   __DATA__
		   !	   perlsyn 116	   DESCRIPTION
		   !	   perlop  207	   Symbolic Unary Operators
		   !=	   perlop  436	   Equality Operators
		   !~	   perlop  242	   DESCRIPTION

	   This is used so that an index can be placed in @INC and found easily (See Pod::Index::Search).

SEE ALSO

       Pod::Index, Pod::Index::Builder, perlpod

AUTHOR

       Ivan Tubert-Brohman <itub@cpan.org>

COPYRIGHT

       Copyright (c) 2005 Ivan Tubert-Brohman. 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.10.0							    2005-08-02							      PODINDEX(1p)