Build index from pods
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
This is a simple wrapper script around Pod::Index::Builder. It parses the \s-1POD\s0 files given as arguments, finds all X<> entries, generates an index and prints it to standard output.
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).
Pod::Index, Pod::Index::Builder, perlpod
Ivan Tubert-Brohman <[email protected]>
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.