PODSELECT(1p)

📦
version 1.67 · 4 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 PODSELECT(1p) 💖

okay bestie, so this is a page from the User Contributed Perl Documentation section of your man pages, and it's literally just about printing out the pod bits you actually want. no cap. 🦋

✨ NAME ✨

podselect — prints selected sections of pod documentation straight to standard output. that's it, that's the whole job. 💅

🌸 SYNOPSIS 🌸

podselect [-help] [-man] [-section section-spec] [file ...]

look at her. so simple. so powerful. 👑

🎀 OPTIONS AND ARGUMENTS 🎀

  • -help — prints a lil brief help message and then dips out. exit stage left. 🫶
  • -man — prints the manual page and exits. iconic behaviour honestly.
  • -section section-spec — tells it which section to include in the output. for the exact format to use for section-spec, go look at "SECTION SPECIFICATIONS" in Pod::Parser. and bestie, listen: this option can be given multiple times on the command line. stack 'em. go wild. 🌈
  • file — the pathname of a file to pull sections of pod documentation from. if you don't give it one, it defaults to standard input. (yes, she'll happily read from stdin, she's flexible like that 😌)

💜 DESCRIPTION 💜

so podselect reads the input files you gave it, hunts around for pod documentation, and then prints out — in raw pod format — every section that matches one or more of the section specifications you gave it. 💖

if you give it no section specifications at all, then every single pod section it encounters gets output. all of them. the whole vibe. 🌸

under the hood, podselect invokes the podselect() function exported by Pod::Select. if you want the juicy details, go read "podselect()" in Pod::Select. iykyk. 🔥

🦋 SEE ALSO 🦋

Pod::Parser and Pod::Select

like, obviously. they're the whole support system. 🫶

🌟 AUTHOR 🌟

please report bugs using <http://rt.cpan.org>. fr fr, they wanna hear about it. 🙈

Brad Appleton <bradapp@enteract.com> 💜

based on code for Pod::Text::pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com>

not me being obsessed with a pod-selecting utility but here we are. no notes. 💅✨

and that's the whole page, bestie — brought to you by perl v5.38.2, dated 2024-01-20, living her best life as PODSELECT(1p). mwah. 😘🎀

📦 where this page comes from