Debian Codegraph @

upstream/debian-unstable/man3/Pod::Perldoc::ToRtf.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Pod::Perldoc::ToRtf 3perl"
58 .TH Pod::Perldoc::ToRtf 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Pod::Perldoc::ToRtf \- let Perldoc render Pod as RTF
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& perldoc \-o rtf Some::Modulename
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 This is a "plug-in" class that allows Perldoc to use
73 Pod::Simple::RTF as a formatter class.
74 .PP
75 This is actually a Pod::Simple::RTF subclass, and inherits
76 all its options.
77 .PP
78 You have to have Pod::Simple::RTF installed (from the Pod::Simple dist),
79 or this module won't work.
80 .PP
81 If Perldoc is running under MSWin and uses this class as a formatter,
82 the output will be opened with \fIwrite.exe\fR or whatever program is
83 specified in the environment variable \f(CW\*(C`RTFREADER\*(C'\fR. For example, to
84 specify that RTF files should be opened the same as they are when you
85 double-click them, you would do \f(CW\*(C`set RTFREADER=start.exe\*(C'\fR in your
86 \&\fIautoexec.bat\fR.
87 .PP
88 Handy tip: put \f(CW\*(C`set PERLDOC=\-ortf\*(C'\fR in your \fIautoexec.bat\fR
89 and that will set this class as the default formatter to run when
90 you do \f(CW\*(C`perldoc whatever\*(C'\fR.
91 .SH "SEE ALSO"
92 .IX Header "SEE ALSO"
93 Pod::Simple::RTF, Pod::Simple, Pod::Perldoc
94 .SH "COPYRIGHT AND DISCLAIMERS"
95 .IX Header "COPYRIGHT AND DISCLAIMERS"
96 Copyright (c) 2002 Sean M. Burke. All rights reserved.
97 .PP
98 This library is free software; you can redistribute it and/or modify it
99 under the same terms as Perl itself.
100 .PP
101 This program is distributed in the hope that it will be useful, but
102 without any warranty; without even the implied warranty of
103 merchantability or fitness for a particular purpose.
104 .SH AUTHOR
105 .IX Header "AUTHOR"
106 Current maintainer: Mark Allen \f(CW\*(C`<[email protected]>\*(C'\fR
107 .PP
108 Past contributions from:
109 brian d foy \f(CW\*(C`<[email protected]>\*(C'\fR
110 Adriano R. Ferreira \f(CW\*(C`<[email protected]>\*(C'\fR,
111 Sean M. Burke \f(CW\*(C`<[email protected]>\*(C'\fR