Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Simple::RTF.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Simple::RTF 3pm"
61 .TH Pod::Simple::RTF 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Simple::RTF \-\- format Pod as RTF
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 3
71 \& perl \-MPod::Simple::RTF \-e \e
72 \& "exit Pod::Simple::RTF\->filter(shift)\->any_errata_seen" \e
73 \& thingy.pod > thingy.rtf
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 This class is a formatter that takes Pod and renders it as RTF, good for
78 viewing/printing in MSWord, WordPad/write.exe, TextEdit, etc.
79 .PP
80 This is a subclass of Pod::Simple and inherits all its methods.
81 .SH "FORMAT CONTROL ATTRIBUTES"
82 .IX Header "FORMAT CONTROL ATTRIBUTES"
83 You can set these attributes on the parser object before you
84 call \f(CW\*(C`parse_file\*(C'\fR (or a similar method) on it:
85 .ie n .IP "$parser\->head1_halfpoint_size( \fIhalfpoint_integer\fR );" 4
86 .el .IP "\f(CW$parser\fR\->head1_halfpoint_size( \fIhalfpoint_integer\fR );" 4
87 .IX Item "$parser->head1_halfpoint_size( halfpoint_integer );"
88 .PD 0
89 .ie n .IP "$parser\->head2_halfpoint_size( \fIhalfpoint_integer\fR );" 4
90 .el .IP "\f(CW$parser\fR\->head2_halfpoint_size( \fIhalfpoint_integer\fR );" 4
91 .IX Item "$parser->head2_halfpoint_size( halfpoint_integer );"
92 .ie n .IP "$parser\->head3_halfpoint_size( \fIhalfpoint_integer\fR );" 4
93 .el .IP "\f(CW$parser\fR\->head3_halfpoint_size( \fIhalfpoint_integer\fR );" 4
94 .IX Item "$parser->head3_halfpoint_size( halfpoint_integer );"
95 .ie n .IP "$parser\->head4_halfpoint_size( \fIhalfpoint_integer\fR );" 4
96 .el .IP "\f(CW$parser\fR\->head4_halfpoint_size( \fIhalfpoint_integer\fR );" 4
97 .IX Item "$parser->head4_halfpoint_size( halfpoint_integer );"
98 .PD
99 These methods set the size (in half\-points, like 52 for 26\-point)
100 that these heading levels will appear as.
101 .ie n .IP "$parser\->codeblock_halfpoint_size( \fIhalfpoint_integer\fR );" 4
102 .el .IP "\f(CW$parser\fR\->codeblock_halfpoint_size( \fIhalfpoint_integer\fR );" 4
103 .IX Item "$parser->codeblock_halfpoint_size( halfpoint_integer );"
104 This method sets the size (in half\-points, like 21 for 10.5\-point)
105 that codeblocks ("verbatim sections") will appear as.
106 .ie n .IP "$parser\->header_halfpoint_size( \fIhalfpoint_integer\fR );" 4
107 .el .IP "\f(CW$parser\fR\->header_halfpoint_size( \fIhalfpoint_integer\fR );" 4
108 .IX Item "$parser->header_halfpoint_size( halfpoint_integer );"
109 This method sets the size (in half\-points, like 15 for 7.5\-point)
110 that the header on each page will appear in. The header
111 is usually just "\fImodulename\fR p. \fIpagenumber\fR".
112 .ie n .IP "$parser\->normal_halfpoint_size( \fIhalfpoint_integer\fR );" 4
113 .el .IP "\f(CW$parser\fR\->normal_halfpoint_size( \fIhalfpoint_integer\fR );" 4
114 .IX Item "$parser->normal_halfpoint_size( halfpoint_integer );"
115 This method sets the size (in half\-points, like 26 for 13\-point)
116 that normal paragraphic text will appear in.
117 .ie n .IP "$parser\->no_proofing_exemptions( \fItrue_or_false\fR );" 4
118 .el .IP "\f(CW$parser\fR\->no_proofing_exemptions( \fItrue_or_false\fR );" 4
119 .IX Item "$parser->no_proofing_exemptions( true_or_false );"
120 Set this value to true if you don\*(Aqt want the formatter to try
121 putting a hidden code on all Perl symbols (as best as it can
122 notice them) that labels them as being not in English, and
123 so not worth spellchecking.
124 .ie n .IP "$parser\->doc_lang( \fImicrosoft_decimal_language_code\fR )" 4
125 .el .IP "\f(CW$parser\fR\->doc_lang( \fImicrosoft_decimal_language_code\fR )" 4
126 .IX Item "$parser->doc_lang( microsoft_decimal_language_code )"
127 This sets the language code to tag this document as being in. By
128 default, it is currently the value of the environment variable
129 \&\f(CW\*(C`RTFDEFLANG\*(C'\fR, or if that\*(Aqs not set, then the value
130 1033 (for US English).
131 .Sp
132 Setting this appropriately is useful if you want to use the RTF
133 to spellcheck, and/or if you want it to hyphenate right.
134 .Sp
135 Here are some notable values:
136 .Sp
137 .Vb 12
138 \& 1033 US English
139 \& 2057 UK English
140 \& 3081 Australia English
141 \& 4105 Canada English
142 \& 1034 Spain Spanish
143 \& 2058 Mexico Spanish
144 \& 1031 Germany German
145 \& 1036 France French
146 \& 3084 Canada French
147 \& 1035 Finnish
148 \& 1044 Norwegian (Bokmal)
149 \& 2068 Norwegian (Nynorsk)
150 .Ve
151 .PP
152 If you are particularly interested in customizing this module\*(Aqs output
153 even more, see the source and/or write to me.
154 .SH "SEE ALSO"
155 .IX Header "SEE ALSO"
156 Pod::Simple, RTF::Writer, RTF::Cookbook, RTF::Document,
157 RTF::Generator
158 .SH SUPPORT
159 .IX Header "SUPPORT"
160 Questions or discussion about POD and Pod::Simple should be sent to the
161 pod\[email protected] mail list. Send an empty email to
162 pod\-people\[email protected] to subscribe.
163 .PP
164 This module is managed in an open GitHub repository,
165 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
166 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
167 .PP
168 Patches against Pod::Simple are welcome. Please send bug reports to
169 <bug\-pod\[email protected]>.
170 .SH "COPYRIGHT AND DISCLAIMERS"
171 .IX Header "COPYRIGHT AND DISCLAIMERS"
172 Copyright (c) 2002 Sean M. Burke.
173 .PP
174 This library is free software; you can redistribute it and/or modify it
175 under the same terms as Perl itself.
176 .PP
177 This program is distributed in the hope that it will be useful, but
178 without any warranty; without even the implied warranty of
179 merchantability or fitness for a particular purpose.
180 .SH AUTHOR
181 .IX Header "AUTHOR"
182 Pod::Simple was created by Sean M. Burke <[email protected]>.
183 But don\*(Aqt bother him, he\*(Aqs retired.
184 .PP
185 Pod::Simple is maintained by:
186 .IP \(bu 4
187 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
188 .IP \(bu 4
189 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
190 .IP \(bu 4
191 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR