POD::PERLDOC::TORTF(3perl)

πŸ’– Pod::Perldoc::ToRtf πŸ’–

okay bestie come CLOSER, lemme tell you about Pod::Perldoc::ToRtf β€” the humble little plug-in that lets Perldoc render your Pod as RTF, no cap πŸŽ€


✨ SYNOPSIS ✨

perldoc -o rtf Some::Modulename

that's it. that's the whole vibe. one line and you're formatted πŸ’…


🌸 DESCRIPTION 🌸

so this is a "plug-in" class β€” and yes the air quotes are doing work here β€” and what it does is let Perldoc use Pod::Simple::RTF as a formatter class. that's the assignment. she did it. slay πŸ’–

plot twist tho: this thing is actually a Pod::Simple::RTF subclass, which means it inherits all its options. all of them. every single one. so whatever Pod::Simple::RTF can do, she can do too β€” she's just wearing a different outfit for Perldoc πŸ¦‹

⚠️ real talk tho: you HAVE to have Pod::Simple::RTF installed (it ships in the Pod::Simple dist), or this module straight-up won't work. like, at all. no notes. that's just the deal 😭

πŸ–₯️ the MSWin situation (iykyk)

if Perldoc is running under MSWin and it's using this class as a formatter, the output gets opened with write.exe β€” or literally whatever program you name in the environment variable RTFREADER. your call, bestie.

so like, say you want RTF files to open the same way they do when you double-click them? iconic. you'd do this:

set RTFREADER=start.exe

in your autoexec.bat. periodt. πŸ’…

πŸŽ€ the handy tip that changed my LIFE πŸŽ€

put this:

set PERLDOC=-ortf

in your autoexec.bat and BOOM β€” that sets this class as the default formatter to run whenever you do:

perldoc whatever

no more typing -o rtf every time. main character energy only. you're welcome 🫢✨


πŸ‘€ SEE ALSO πŸ‘€

  • Pod::Simple::RTF
  • Pod::Simple
  • Pod::Perldoc

go read those too, bestie, they're the whole lore 🌈


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. (read that part twice, ok? no warranty fr fr πŸ™ˆ)


πŸ’œ 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>"

look at that contributor lineup. legends only. ate and left no crumbs πŸ‘‘πŸ’–


and that's the whole page, babe β€” brought to you by perl v5.44.0, dated 2026-10-17, from the Pod::P...::ToRtf(3perl) files of the Perl Programmers Reference Guide. mwah, go format something pretty βœ¨πŸŽ€πŸ’…

πŸ“¦ where this page comes from
  • arch rolling: perl 5.44.0-1 Β· Artistic-1.0-Perl AND GPL-1.0-or-later
  • πŸ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms