Pod::Perldoc::ToRtf - let Perldoc render Pod as RTF
perldoc -o rtf Some::Modulename
Perl Programmers Reference Guide Pod::Perldoc::ToRtf(3)
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".
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+-----------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------------+
|Availability | runtime/perl-532 |
+---------------+-----------------------+
|Stability | Pass-through volatile |
+---------------+-----------------------+
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@cpan.org>"
Past contributions from: brian d foy "<bdfoy@cpan.org>" Adriano R.
Ferreira "<ferreira@cpan.org>", Sean M. Burke "<sburke@cpan.org>"
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.perl.org/.
perl v5.32.0 2020-06-14 Pod::Perldoc::ToRtf(3)