Pod::Pe...:ToTerm(3pm)

📦
version 5.42.3 · 8 versions
, in alpine 3.24

✨ NAME ✨

Pod::Perldoc::ToTerm — render Pod with terminal escapes. That's the whole assignment, and bestie, it slays.

🌸 SYNOPSIS 🌸

perldoc -o term Some::Modulename

🦋 DESCRIPTION 🦋

okay so this is a "plug-in" class that lets Perldoc use Pod::Text as a formatter class. iconic behavior, honestly.

It supports these options, and they're all explained in Pod::Text:

  • alt — explained in Pod::Text
  • indent — explained in Pod::Text
  • loose — explained in Pod::Text
  • quotes — explained in Pod::Text
  • sentence — explained in Pod::Text
  • width — explained in Pod::Text

For example, look at her go:

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

💅 PAGER FORMATTING 💅

Depending on the platform, and because this class emits terminal escapes, it will attempt to set the -R flag on your pager by injecting the flag into your environment variable for less or more. no cap, it's just trying to make the pager behave.

On Windows and DOS, this class will not modify any environment variables. periodt.

⚠️ CAVEAT ⚠️

This module may change to use a different text formatter class in the future, and this may change what options are supported. so like, stay aware bestie — the vibe may shift.

👑 SEE ALSO 👑

  • Pod::Text
  • Pod::Text::Termcap
  • Pod::Perldoc

Copyright (c) 2017 Mark Allen.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

🫶 AUTHOR 🫶

Mark Allen "<mallen@cpan.org>"

okay bye bestie! 💖 this page came from perl v5.42.3, dated 2026-11-03, and it's Pod::Pe...:ToTerm(3pm) — periodt. 🎀

📦 where this page comes from