Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Pod::Perldoc::ToRtf

Name Pod::Perldoc::ToRtf
Version 3.28
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/Pod/Perldoc/ToRtf.pm
Is Core No
Search CPAN for this module Pod::Perldoc::ToRtf
Documentation Pod::Perldoc::ToRtf
Module Details Pod::Perldoc::ToRtf

NAME

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


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

the Pod::Simple::RTF manpage, the Pod::Simple manpage, the Pod::Perldoc manpage


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@cpan.org>

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

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024