Pod::Index::Builder - Build a pod index

NAME

Pod::Index::Builder - Build a pod index

SYNOPSIS

    use Pod::Index::Builder;

    my $p = Pod::Index::Builder->new;
    for my $file (@ARGV) {
        $p->parse_from_file($file);
    }

    $p->print_index;

DESCRIPTION

This is a subclass of the Pod::Parser manpage that reads POD and outputs nothing. However, it saves the position of every X<> entry it sees. The index can be retrieved as a hashref, or printed in a format that is understandable by the Pod::Index::Search manpage.

METHODS

pod_index

Retrieves the index as a hashref. The hash keys are the keywords contained in the X<> tags, normalized to lowercase; the values are array references of the Pod::Index::Entry manpage objects.

print_index

    $parser->print_index($fh);
    $parser->print_index($filename);
    $parser->print_index();

Prints the index to the given output filename or filehandle (or STDOUT by default). The format is tab-delimited, with the following columns:

    1) keyword
    2) podname 
    3) line number
    4) context (title of section containing this entry)

The index is sorted by keyword in a case-insensitive way.

VERSION

0.12

AUTHOR

Ivan Tubert-Brohman <itub@cpan.org>

COPYRIGHT

Pod::Index::Builder - Build a pod index