logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

podindex - build index from pods

Author

       Ivan Tubert-Brohman <itub@cpan.org>

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.

Name

       podindex - build index from pods

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

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

See Also