Pod::Text::Color(3pm)

📦
version 5.42.3 · 9 versions
, in alpine 3.24

💅 Pod::Text::Color(3pm) — the podlators glow-up module, bestie ✨

okay so real talk, this is the manual page for Pod::Text::Color, part of the Perl Programmers Reference Guide — and it's literally the module that makes your POD output cute by throwing ANSI color at it. 🌈 Let's get into it.

🌸 NAME 🌸

Pod::Text::Color — converting POD data into formatted color ASCII text, no cap 💖

🦋 SYNOPSIS 🦋

Like, here's the whole vibe in code:

use Pod::Text::Color;
my $parser = Pod::Text::Color->new (sentence => 0, width => 78);

# Read POD from STDIN and write to STDOUT.
$parser->parse_from_filehandle;

# Read POD from file.pod and write to file.txt.
$parser->parse_from_file ('file.pod', 'file.txt');

that's it, that's the whole thing, slay 🎀

✨ DESCRIPTION ✨

So Pod::Text::Color is a simple subclass of Pod::Text — like, a lil baby version that inherited the good genes — and what it does is highlight output text using ANSI color escape sequences. 🖍️

Apart from the color (which is, admittedly, the main character here), it functions in all ways like Pod::Text. So if you want the details and the available options, go read Pod::Text, iykyk. 📖

important!! Term::ANSIColor is what it uses to get colors, so Term::ANSIColor must be installed to use this module. no install, no rainbow. 😭

👑 COMPATIBILITY 👑

ancient lore time, bestie 🏺:

  • Pod::Text::Color 0.05 (based on Pod::Parser) was the first version of this module included with Perl, in Perl 5.6.0.
  • The current API based on Pod::Simple was added in Pod::Text::Color 2.00. Then Pod::Text::Color 2.01 was included in Perl 5.9.3 — the first version of Perl to incorporate those changes.
  • Several problems with wrapping and line length were fixed as recently as Pod::Text::Color 6.0.0. (yes, that recently. we don't talk about it. 💀)
  • This module inherits its API and most behavior from Pod::Text, so the details in "COMPATIBILITY" in Pod::Text also apply. Pod::Text and Pod::Text::Color have had the same module version since 4.00, included in Perl 5.23.7. (They unfortunately diverge in confusing ways prior to that. messy era. 🙈)

💀 CAVEATS 💀

Line wrapping is done only at ASCII spaces and tabs, rather than using a correct Unicode-aware line wrapping algorithm. so like. it's giving "close enough." 🫠

🫶 AUTHOR 🫶

Russ Allbery <rra@cpan.org>. (ty king 👑)

Copyright 1999, 2001, 2004, 2006, 2008, 2009, 2018-2019, 2022, 2024 Russ Allbery <rra@cpan.org>

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

🔥 SEE ALSO 🔥

  • Pod::Text
  • Pod::Simple

The current version of this module is always available from its web site at <https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the Perl core distribution as of 5.6.0. 🦋

okay that's the whole page, bestie!! 💜 this was perl v5.42.3, dated 2026-11-03, and it's the Pod::Text::Color(3pm) page — go forth and colorize responsibly ✨🎀💅

📦 where this page comes from