perldoc > Pod::Perldoc::ToRtf

man perldoc info pydoc3 ri search

📖 NAME

Pod::Perldoc::ToRtf - let Perldoc render Pod as RTF

🚀 Quick Reference

Use Case	Command	Description
📄 Render Pod as RTF	perldoc -o rtf Some::Module	🔍 Display Pod documentation for a module in RTF format
⚙️ Set RTF as default formatter	set PERLDOC=-ortf	🪟 Make perldoc always use RTF output (MSWin)
📁 Specify RTF reader program	set RTFREADER=start.exe	🖱️ Open RTF output with the default handler (double‑click behavior)
📖 View RTF documentation	perldoc Some::Module	📄 Automatically uses RTF reader if PERLDOC=-ortf is set

📋 SYNOPSIS

perldoc -o rtf Some::Modulename

📝 DESCRIPTION

This is a "plug-in" class that allows Perldoc to use Pod::Simple::RTF as a formatter class.

This is actually a Pod::Simple::RTF subclass, and inherits all its options.

You have to have Pod::Simple::RTF installed (from the Pod::Simple dist), or this module won't work.

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

🔗 SEE ALSO

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

©️ COPYRIGHT AND DISCLAIMERS

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 AT cpan.org>"

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

📖 NAME 🚀 Quick Reference 📋 SYNOPSIS 📝 DESCRIPTION 🔗 SEE ALSO ©️ COPYRIGHT AND DISCLAIMERS 👤 AUTHOR