local-lib5/man/man3/Pod::Simple::RTF.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Pod::Simple::RTF 3"
 132 .TH Pod::Simple::RTF 3 "2008-06-03" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Pod::Simple::RTF \-\- format Pod as RTF
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 3
 138 \&  perl \-MPod::Simple::RTF \-e \e
 139 \&   "exit Pod::Simple::RTF\->filter(shift)\->any_errata_seen" \e
 140 \&   thingy.pod > thingy.rtf
 141 .Ve
 142 .SH "DESCRIPTION"
 143 .IX Header "DESCRIPTION"
 144 This class is a formatter that takes Pod and renders it as \s-1RTF\s0, good for
 145 viewing/printing in MSWord, WordPad/write.exe, TextEdit, etc.
 146 .PP
 147 This is a subclass of Pod::Simple and inherits all its methods.
 148 .SH "FORMAT CONTROL ATTRIBUTES"
 149 .IX Header "FORMAT CONTROL ATTRIBUTES"
 150 You can set these attributes on the parser object before you
 151 call \f(CW\*(C`parse_file\*(C'\fR (or a similar method) on it:
 152 .IP "$parser\->head1_halfpoint_size( \fIhalfpoint_integer\fR );" 4
 153 .IX Item "$parser->head1_halfpoint_size( halfpoint_integer );"
 154 .PD 0
 155 .IP "$parser\->head2_halfpoint_size( \fIhalfpoint_integer\fR );" 4
 156 .IX Item "$parser->head2_halfpoint_size( halfpoint_integer );"
 157 .IP "$parser\->head3_halfpoint_size( \fIhalfpoint_integer\fR );" 4
 158 .IX Item "$parser->head3_halfpoint_size( halfpoint_integer );"
 159 .IP "$parser\->head4_halfpoint_size( \fIhalfpoint_integer\fR );" 4
 160 .IX Item "$parser->head4_halfpoint_size( halfpoint_integer );"
 161 .PD
 162 These methods set the size (in half\-points, like 52 for 26\-point)
 163 that these heading levels will appear as.
 164 .IP "$parser\->codeblock_halfpoint_size( \fIhalfpoint_integer\fR );" 4
 165 .IX Item "$parser->codeblock_halfpoint_size( halfpoint_integer );"
 166 This method sets the size (in half\-points, like 21 for 10.5\-point)
 167 that codeblocks (\*(L"verbatim sections\*(R") will appear as.
 168 .IP "$parser\->header_halfpoint_size( \fIhalfpoint_integer\fR );" 4
 169 .IX Item "$parser->header_halfpoint_size( halfpoint_integer );"
 170 This method sets the size (in half\-points, like 15 for 7.5\-point)
 171 that the header on each page will appear in.  The header
 172 is usually just "\fImodulename\fR p. \fIpagenumber\fR".
 173 .IP "$parser\->normal_halfpoint_size( \fIhalfpoint_integer\fR );" 4
 174 .IX Item "$parser->normal_halfpoint_size( halfpoint_integer );"
 175 This method sets the size (in half\-points, like 26 for 13\-point)
 176 that normal paragraphic text will appear in.
 177 .IP "$parser\->no_proofing_exemptions( \fItrue_or_false\fR );" 4
 178 .IX Item "$parser->no_proofing_exemptions( true_or_false );"
 179 Set this value to true if you don't want the formatter to try
 180 putting a hidden code on all Perl symbols (as best as it can
 181 notice them) that labels them as being not in English, and
 182 so not worth spellchecking.
 183 .IP "$parser\->doc_lang( \fImicrosoft_decimal_language_code\fR )" 4
 184 .IX Item "$parser->doc_lang( microsoft_decimal_language_code )"
 185 This sets the language code to tag this document as being in. By
 186 default, it is currently the value of the environment variable
 187 \&\f(CW\*(C`RTFDEFLANG\*(C'\fR, or if that's not set, then the value
 188 1033 (for \s-1US\s0 English).
 189 .Sp
 190 Setting this appropriately is useful if you want to use the \s-1RTF\s0
 191 to spellcheck, and/or if you want it to hyphenate right.
 192 .Sp
 193 Here are some notable values:
 194 .Sp
 195 .Vb 12
 196 \&  1033  US English
 197 \&  2057  UK English
 198 \&  3081  Australia English
 199 \&  4105  Canada English
 200 \&  1034  Spain Spanish
 201 \&  2058  Mexico Spanish
 202 \&  1031  Germany German
 203 \&  1036  France French
 204 \&  3084  Canada French
 205 \&  1035  Finnish
 206 \&  1044  Norwegian (Bokmal)
 207 \&  2068  Norwegian (Nynorsk)
 208 .Ve
 209 .PP
 210 If you are particularly interested in customizing this module's output
 211 even more, see the source and/or write to me.
 212 .SH "SEE ALSO"
 213 .IX Header "SEE ALSO"
 214 Pod::Simple, RTF::Writer, RTF::Cookbook, RTF::Document,
 215 RTF::Generator
 216 .SH "COPYRIGHT AND DISCLAIMERS"
 217 .IX Header "COPYRIGHT AND DISCLAIMERS"
 218 Copyright (c) 2002 Sean M. Burke.  All rights reserved.
 219 .PP
 220 This library is free software; you can redistribute it and/or modify it
 221 under the same terms as Perl itself.
 222 .PP
 223 This program is distributed in the hope that it will be useful, but
 224 without any warranty; without even the implied warranty of
 225 merchantability or fitness for a particular purpose.
 226 .SH "AUTHOR"
 227 .IX Header "AUTHOR"
 228 Sean M. Burke \f(CW\*(C`sburke@cpan.org\*(C'\fR