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

📦
version 5.44.0 · 14 versions
, in arch rolling

💅 Pod::P...ToText(3perl) — like, the whole vibe

okay bestie, so you know the Perl Programmers Reference Guide? This little page lives in there, filed under Pod::P...ToText(3perl). She's small. She's iconic. She's Pod::Perldoc::ToText. Let's get into it 🎀

✨ NAME ✨

Pod::Perldoc::ToText — she lets Perldoc render Pod as plaintext. that's it. that's the whole job. and she does it flawlessly 💖

🌸 SYNOPSIS 🌸

perldoc -o text Some::Modulename

like... just say that. and it happens. no cap. 💅

🦋 DESCRIPTION 🦋

So basically this is a "plug-in" class, right? Her whole purpose is letting Perldoc use Pod::Text as its formatter class. she's the middleman. the hype woman. the connector. 🫶

She supports these options, and if you want the actual tea on what they do, Pod::Text is where it's explained:

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

Obsessed. Anyway, example time, here's one:

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

see how we just slid that -w indent:5 in there? yeah. slay. ✨

💀 CAVEAT 💀

okay so this is the part where I hold your hand a lil bit. 🥺

This module may change to use a different text formatter class in the future. And if that happens, it may change what options are supported. So like. Don't get too attached to the current lineup. She's allowed to pivot. main character energy means evolving, fr fr. 👑

👀 SEE ALSO 👀

  • Pod::Text
  • Pod::Perldoc

go read those too. iykyk. 📚💜

Copyright (c) 2002 Sean M. Burke. 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. (so like... no promises, bestie 😭)

👑 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> — legends, all of them. 🌟

perl v5.44.0 · 2026-10-17

and that's the page!! thanks for coming to my ted talk, love u, go format some pod, mwah 💋 bye bestie!! 🦋✨

📦 where this page comes from