PODINDEX(1p)

💖 PODINDEX 💖

bestie. you found the podindex page. it's from the Perl user-contributed docs, section 1p, and honestly? it's a lil cutie. let's get into it 🎀

---

✨ NAME ✨

podindex — build index from pods 🦋

---

✨ SYNOPSYS ✨

(yeah it's spelled like that, i don't make the rules 💅)

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

So it reads your pod(s) and prints an index straight to stdout. The options are:

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

---

✨ DESCRIPTION ✨

okay so podindex is a simple wrapper script around Pod::Index::Builder. that's the whole vibe. what it does:

• it parses the POD files you hand it as arguments 📚
• it finds all the X<> entries
• it generates an index
• it prints that index to standard output

that's it. that's the girl. ✨

---

✨ OPTIONS ✨

• package — if you give this one, it drops the index into the __DATA__ section of a perl package instead of just... printing it loose. 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

and the why? 👑 it's 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.

---

and that's the whole page, bestie, no notes 💜 this one's perl v5.30.0, dated 2020-05-17, and it lives in the PODINDEX(1p) manual. mwah 💋