.\" 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::FormatText::Zen 3pm"
.TH HTML::FormatText::Zen 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::FormatText::Zen \- format HTML as plain text using zen
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use HTML::FormatText::Zen;
\& $text = HTML::FormatText::Zen\->format_file ($filename);
\& $text = HTML::FormatText::Zen\->format_string ($html_string);
\&
\& $formatter = HTML::FormatText::Zen\->new;
\& $tree = HTML::TreeBuilder\->new_from_file ($filename);
\& $text = $formatter\->format ($tree);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`HTML::FormatText::Zen\*(C'\fR turns \s-1HTML\s0 into plain text using the \f(CW\*(C`zen\*(C'\fR
program.
.Sp
.RS 4
<http://www.nocrew.org/software/zen/>
.RE
.PP
The module interface is compatible with formatters like \f(CW\*(C`HTML::FormatText\*(C'\fR,
but all parsing etc is done by zen.
.PP
See \f(CW\*(C`HTML::FormatExternal\*(C'\fR for the formatting functions.  The margins
options work but nothing else.
.ie n .IP """rightmargin""" 4
.el .IP "\f(CWrightmargin\fR" 4
.IX Item "rightmargin"
As of zen version 0.2.3 there is no right margin option.
.ie n .IP """input_charset"", ""output_charset""" 4
.el .IP "\f(CWinput_charset\fR, \f(CWoutput_charset\fR" 4
.IX Item "input_charset, output_charset"
As of zen version 0.2.3 the input charset is always latin\-1 and output is
always latin\-1.  Entities in the input seem to be truncated to 8\-bits for
the output.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::FormatExternal, \fBzen\fR\|(1)
.SH "HOME PAGE"
.IX Header "HOME PAGE"
<http://user42.tuxfamily.org/html\-formatexternal/index.html>
.SH "LICENSE"
.IX Header "LICENSE"
Copyright 2008, 2009, 2010, 2013, 2015 Kevin Ryde
.PP
HTML-FormatExternal is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by the
Free Software Foundation; either version 3, or (at your option) any later
version.
.PP
HTML-FormatExternal is distributed in the hope that it will be useful, but
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0
or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the \s-1GNU\s0 General Public License for
more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License along with
HTML-FormatExternal.  If not, see <http://www.gnu.org/licenses/>.