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

📦
version 5.44.0 · 14 versions
, in arch rolling

✨ Pod::Perldoc::ToANSI ✨

okay bestie, welcome to Pod::Perldoc::ToANSI 💖 — this one lives right here in the Perl Programmers Reference Guide, section 3perl, and it's literally just here to make your docs pretty in the terminal. The actual module name is Pod::Perldoc::ToANSI, and the whole job is: render Pod with ANSI color escapes. That's it. That's the gig. 🎀

🌸 SYNOPSIS 🌸

no thoughts, just run it:

perldoc -o ansi Some::Modulename

yes queen, -o ansi is the moment 👑

💅 DESCRIPTION 💅

So here's the tea ☕ — this is a "plug-in" class that lets Perldoc use Pod::Text as a formatter class. Basically it's the little adapter bestie that hooks Pod::Text up to perldoc so everything comes out all colorful and cute. 🦋

It supports the following options, which are explained over in Pod::Text:

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

(go read Pod::Text if you wanna know what each one does, fr fr — this page is not gonna re-explain them, that's not the vibe 🙈)

✨ for example ✨

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

see how we passed -w indent:5? that's the indent option getting its whole life. 💅

😭 CAVEAT 😭

heads up, bestie, this is the part where we stay humble: this module may change to use a different text formatter class in the future, and that may change what options are supported.

so like… the options list? not forever-guaranteed. no cap. don't build your whole personality on it 🫶

👀 SEE ALSO 👀

go be nosy, these are the siblings:

  • Pod::Text
  • Pod::Text::Color
  • Pod::Perldoc

Copyright (c) 2011 Mark Allen. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

(iconic legal boilerplate, we respect it 💜)

🫶 AUTHOR 🫶

Current maintainer: Mark Allen "<mallen@cpan.org>"

Past contributions from: brian d foy "<bdfoy@cpan.org>" Adriano R. Ferreira "<ferreira@cpan.org>", Sean M. Burke "<sburke@cpan.org>"

and that's the whole page, bestie!! 🎀✨ this was perl v5.44.0, dated 2026-10-17 — pod's out, screenshots taken, mwah 💋💖🌈

📦 where this page comes from