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__
!	perlop.pod:207
!=	perlop.pod:429
!~	perlop.pod:242
"	perlop.pod:932

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.