/usr/local/lp/sonarperl/man/man3/ Current File: //usr/local/lp/sonarperl/man/man3/Pod::Perldoc::ToRtf.3
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pod::Perldoc::ToRtf 3"
.TH Pod::Perldoc::ToRtf 3 2019-02-18 "perl v5.38.0" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Pod::Perldoc::ToRtf \- let Perldoc render Pod as RTF
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  perldoc \-o rtf Some::Modulename
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a "plug-in" class that allows Perldoc to use
Pod::Simple::RTF as a formatter class.
.PP
This is actually a Pod::Simple::RTF subclass, and inherits
all its options.
.PP
You have to have Pod::Simple::RTF installed (from the Pod::Simple dist),
or this module won't work.
.PP
If Perldoc is running under MSWin and uses this class as a formatter,
the output will be opened with \fIwrite.exe\fR or whatever program is
specified in the environment variable \f(CW\*(C`RTFREADER\*(C'\fR. For example, to
specify that RTF files should be opened the same as they are when you
double-click them, you would do \f(CW\*(C`set RTFREADER=start.exe\*(C'\fR in your
\&\fIautoexec.bat\fR.
.PP
Handy tip: put \f(CW\*(C`set PERLDOC=\-ortf\*(C'\fR in your \fIautoexec.bat\fR
and that will set this class as the default formatter to run when
you do \f(CW\*(C`perldoc whatever\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Simple::RTF, Pod::Simple, Pod::Perldoc
.SH "COPYRIGHT AND DISCLAIMERS"
.IX Header "COPYRIGHT AND DISCLAIMERS"
Copyright (c) 2002 Sean M. Burke.  All rights reserved.
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
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.
.SH AUTHOR
.IX Header "AUTHOR"
Current maintainer: Mark Allen \f(CW\*(C`<mallen@cpan.org>\*(C'\fR
.PP
Past contributions from:
brian d foy \f(CW\*(C`<bdfoy@cpan.org>\*(C'\fR
Adriano R. Ferreira \f(CW\*(C`<ferreira@cpan.org>\*(C'\fR,
Sean M. Burke \f(CW\*(C`<sburke@cpan.org>\*(C'\fR