Pod::Perldoc::ToRtf(3p) Perl Programmers Reference Guide #
Pod::Perldoc::ToRtf(3p) Perl Programmers Reference Guide
NNAAMMEE #
Pod::Perldoc::ToRtf - let Perldoc render Pod as RTF
SSYYNNOOPPSSIISS #
perldoc -o rtf Some::Modulename
DDEESSCCRRIIPPTTIIOONN #
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 _w_r_i_t_e_._e_x_e 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 _a_u_t_o_e_x_e_c_._b_a_t.
Handy tip: put "set PERLDOC=-ortf" in your _a_u_t_o_e_x_e_c_._b_a_t and that will set
this class as the default formatter to run when you do "perldoc
whatever".
SSEEEE AALLSSOO #
Pod::Simple::RTF, Pod::Simple, Pod::Perldoc
CCOOPPYYRRIIGGHHTT AANNDD DDIISSCCLLAAIIMMEERRSS #
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.
AAUUTTHHOORR #
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 v5.36.3 2019-02-13 Pod::Perldoc::ToRtf(3p)