.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "HTML::FormatRTF 3pm"
.TH HTML::FormatRTF 3pm "2022-11-19" "perl v5.36.0" "User Contributed Perl Documentation"
.\" 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"
HTML::FormatRTF \- Format HTML as RTF
.SH "VERSION"
.IX Header "VERSION"
version 2.16
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use HTML::FormatRTF;
\&
\&  my $out_file = "test.rtf";
\&  open(RTF, ">$out_file")
\&   or die "Can\*(Aqt write\-open $out_file: $!\enAborting";
\&
\&  print RTF HTML::FormatRTF\->format_file(
\&    \*(Aqtest.html\*(Aq,
\&      \*(Aqfontname_headings\*(Aq => "Verdana",
\&  );
\&  close(RTF);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
HTML::FormatRTF is a class for objects that you use to convert \s-1HTML\s0 to \s-1RTF.\s0
There is currently no proper support for tables or forms.
.PP
This is a subclass of HTML::Formatter, whose documentation you should
consult for more information on underlying methods such as \f(CW\*(C`new\*(C'\fR, \f(CW\*(C`format\*(C'\fR,
\&\f(CW\*(C`format_file\*(C'\fR etc
.PP
You can specify any of the following parameters in the call to \f(CW\*(C`new\*(C'\fR,
\&\f(CW\*(C`format_file\*(C'\fR, or \f(CW\*(C`format_string\*(C'\fR:
.IP "lm" 4
.IX Item "lm"
Amount of \fIextra\fR indenting to apply to the left margin, in twips
(\fItw\fRent\fIi\fReths of a \fIp\fRoint). Default is 0.
.Sp
So if you wanted the left margin to be an additional half inch larger, you'd
set \f(CW\*(C`lm => 720\*(C'\fR (since there's 1440 twips in an inch). If you wanted it to
be about 1.5cm larger, you'd set \f(CW\*(C`lw => 850\*(C'\fR (since there's about 567
twips in a centimeter).
.IP "rm" 4
.IX Item "rm"
Amount of \fIextra\fR indenting to apply to the left margin, in twips
(\fItw\fRent\fIi\fReths of a \fIp\fRoint).  Default is 0.
.IP "normal_halfpoint_size" 4
.IX Item "normal_halfpoint_size"
This is the size of normal text in the document, in \fIhalf\fR\-points. The default
value is 22, meaning that normal text is in 11 point.
.IP "header_halfpoint_size" 4
.IX Item "header_halfpoint_size"
This is the size of text used in the document's page-header, in \fIhalf\fR\-points.
The default value is 17, meaning that normal text is in 7.5 point.  Currently,
the header consists just of "p. \fIpagenumber\fR" in the upper-right-hand corner,
and cannot be disabled.
.IP "head1_halfpoint_size ... head6_halfpoint_size" 4
.IX Item "head1_halfpoint_size ... head6_halfpoint_size"
These control the font size of each heading level, in half-twips.  For example,
the default for head3_halfpoint_size is 25, meaning that \s-1HTML\s0 \f(CW\*(C`<h3>...</h3>\*(C'\fR text will be in 12.5 point text (in addition to being underlined and in the
heading font).
.IP "codeblock_halfpoint_size" 4
.IX Item "codeblock_halfpoint_size"
This controls the font size (in half-points) of the text used for \f(CW\*(C`<pre>...</pre>\*(C'\fR text.  By default, it is 18, meaning 9 point.
.IP "fontname_body" 4
.IX Item "fontname_body"
This option controls what font is to be used for the body of the text \*(-- that
is, everything other than heading text and text in pre/code/tt elements. The
default value is currently \*(L"Times\*(R".  Other handy values I can suggest using are
\&\*(L"Georgia\*(R" or \*(L"Bookman Old Style\*(R".
.IP "fontname_code" 4
.IX Item "fontname_code"
This option controls what font is to be used for text in pre/code/tt elements.
The default value is currently \*(L"Courier New\*(R".
.IP "fontname_headings" 4
.IX Item "fontname_headings"
This option controls what font name is to be used for headings.  You can use
the same font as fontname_body, but I prefer a sans-serif font, so the default
value is currently \*(L"Arial\*(R".  Also consider \*(L"Tahoma\*(R" and \*(L"Verdana\*(R".
.IP "document_language" 4
.IX Item "document_language"
This option controls what Microsoft language number will be specified as the
language for this document. The current default value is 1033, for \s-1US\s0 English.
Consult an \s-1RTF\s0 reference for other language numbers.
.IP "hr_width" 4
.IX Item "hr_width"
This option controls how many underline characters will be used for rendering a
\&\*(L"<hr>\*(R" tag. Its default value is currently 50. You can usually leave this
alone, but under some circumstances you might want to use a smaller or larger
number.
.IP "no_prolog" 4
.IX Item "no_prolog"
If this option is set to a true value, HTML::FormatRTF will make a point of
\&\fInot\fR emitting the \s-1RTF\s0 prolog before the document.  By default, this is off,
meaning that HTML::FormatRTF \fIwill\fR emit the prolog.  This option is of
interest only to advanced users.
.IP "no_trailer" 4
.IX Item "no_trailer"
If this option is set to a true value, HTML::FormatRTF will make a point of
\&\fInot\fR emitting the \s-1RTF\s0 trailer at the end of the document.  By default, this
is off, meaning that HTML::FormatRTF \fIwill\fR emit the bit of \s-1RTF\s0 that ends the
document.  This option is of interest only to advanced users.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::Formatter, RTF::Writer
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Nigel Metheringham <nigelm@cpan.org>
.IP "\(bu" 4
Sean M Burke <sburke@cpan.org>
.IP "\(bu" 4
Gisle Aas <gisle@ActiveState.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Nigel Metheringham, 2002\-2005 Sean M Burke, 1999\-2002 Gisle Aas.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.