Pod::P...ToTerm(3perl)

📦
version 5.44.0 · 14 versions
, in arch rolling

💅 Pod::Perldoc::ToTerm — the terminal-escape glow-up 💅

okay bestie, so this is Pod::P...ToTerm(3perl) (the manual name got a lil chopped in the header, that's just how it renders, she's fine) from the Perl Programmers Reference Guide. It's a whole module, and we're gonna get you obsessed with it. no cap. ✨

🌸 NAME 🌸

Pod::Perldoc::ToTerm — it renders Pod with terminal escapes. that's it, that's the vibe. it takes your boring plain Pod and gives it main character energy in the terminal. 🎀

✨ SYNOPSIS ✨

perldoc -o term Some::Modulename

literally one line, that's the whole thing. you say term, it does the glow-up. slay. 💅

🦋 DESCRIPTION 🦋

so bestie, this is a "plug-in" class. it lets Perldoc use Pod::Text as a formatter class. that's the whole job. she's a connector, an enabler, the friend who introduces you to the other friend. 🫶

she supports these options, and the details of each one live over in Pod::Text (go read that one, iykyk):

  • alt
  • indent
  • loose
  • quotes
  • sentence
  • width

for example, if you wanted to get specific with it:

perldoc -o term -w indent:5 Some::Modulename

that -w indent:5 is you saying "bestie, indent it by 5" and she WILL do it. 🔥

pro tip: those options are explained in Pod::Text — so don't ask me for the deets, ask her. 😭

🌈 PAGER FORMATTING 🌈

okay so this part is actually kinda iconic and also kinda situational. depending on the platform — and this matters because this class emits terminal escapes — she will attempt to set the -R flag on your pager.

how? she injects that flag right into your environment variable for less or more. sneaky but for your own good. 💖

on Windows and DOS, though? she will not modify any environment variables. she stays out of it. respect. ✋

💀 CAVEAT 💀

listen up and listen good: this module may change to use a different text formatter class in the future, and that may change what options are supported. so don't get too attached to any specific option, bestie. she's allowed to reinvent herself. it's giving personal growth. 🦋

👑 SEE ALSO 👑

  • Pod::Text — the one she's plugging in, and where those options actually live
  • Pod::Text::Termcap
  • Pod::Perldoc

go read them, they're all part of the squad. 🫶

Copyright (c) 2017 Mark Allen.

this program is free software; you can redistribute it and/or modify it under the terms of either:

  1. the GNU General Public License as published by the Free Software Foundation; or
  2. the Artistic License.

see http://dev.perl.org/licenses/ for more information. she's free, she's open, she's generous. 💜

💖 AUTHOR 💖

Mark Allen <mallen@cpan.org> — thank you for your service, king. 👑

and that's a wrap bestie! this page came to you from the perl v5.44.0 era, dated 2026-10-17, and its header/footer both said Pod::P...ToTerm(3perl) because the guide likes to abbreviate. go format something, you absolute icon. periodt. 💅✨🌸

📦 where this page comes from