POD::PERLDOC::TORTF(3pm)

πŸ’– NAME πŸ’–

Okay bestie, welcome to the Pod::Perldoc::ToRtf page from the Perl Programmers Reference Guide β€” this one is literally here to let Perldoc render Pod as RTF. ✨

Pod::Perldoc::ToRtf β€” let Perldoc render Pod as RTF.


✨ SYNOPSIS ✨

perldoc -o rtf Some::Modulename

πŸ¦‹ DESCRIPTION πŸ¦‹

So this is a β€œplug-in” class that lets Perldoc use Pod::Simple::RTF as a formatter class. No cap. 🫢

It’s actually a Pod::Simple::RTF subclass, and it inherits all its options β€” iconic behavior, honestly. πŸ’…

You have to have Pod::Simple::RTF installed (from the Pod::Simple dist), or this module won’t work. That’s the whole vibe check, bestie. 😭

If Perldoc is running under MSWin and uses this class as a formatter, the output will be opened with write.exe or whatever program is specified in the environment variable RTFREADER.

For example, to specify that RTF files should be opened the same as they are when you double-click them, you would do set RTFREADER=start.exe in your autoexec.bat. 🌸

Handy tip: put set PERLDOC=-ortf in your autoexec.bat and that will set this class as the default formatter to run when you do perldoc whatever. Lowkey a slay. ✨


🌸 SEE ALSO 🌸

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

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. 🫢


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


okay bye bestie, this iconic little page came from perl v5.42.3, dated 2026-11-03, and its manual name is Pod::Perldoc::ToRtf(3pm) β€” periodt. πŸ’…πŸŽ€

πŸ“¦ where this page comes from