Debian Codegraph @

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