Scroll to navigation

HTML::FormatText::Netrik(3pm) User Contributed Perl Documentation HTML::FormatText::Netrik(3pm)

NAME

HTML::FormatText::Netrik - format HTML as plain text using netrik

SYNOPSIS

 use HTML::FormatText::Netrik;
 $text = HTML::FormatText::Netrik->format_file ($filename);
 $text = HTML::FormatText::Netrik->format_string ($html_string);
 $formatter = HTML::FormatText::Netrik->new;
 $tree = HTML::TreeBuilder->new_from_file ($filename);
 $text = $formatter->format ($tree);

DESCRIPTION

"HTML::FormatText::Netrik" turns HTML into plain text using the "netrik" program.

The module interface is compatible with formatters like "HTML::FormatText", but all parsing etc is done by netrik.

"netrik" normally emits colour escape sequences but that is disabled here (its "--bw" option) to get plain text.

See "HTML::FormatExternal" for the formatting functions and options, with the following caveats,

"input_charset", "output_charset"
These charset overrides have no effect. Input might be single-byte only, and output probably follows the input (as of netrik 1.15.7).

BUGS

"netrik" version 1.16.1 initializes curses even when doing just a "--dump", so if you have a "TERM" environment variable then it must be a terminal type known to curses (terminfo(5)). If you have no "TERM" setting then "HTML::FormatText::Netrik" runs "netrik" with "TERM=dumb" so the code here works in a bare environment. (But no attempt is made here to validate or correct an existing "TERM" value.)

SEE ALSO

HTML::FormatExternal, netrik(1)

HOME PAGE

<http://user42.tuxfamily.org/html-formatexternal/index.html>

LICENSE

Copyright 2008, 2009, 2010, 2013, 2015 Kevin Ryde

HTML-FormatExternal is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

HTML-FormatExternal is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with HTML-FormatExternal. If not, see <http://www.gnu.org/licenses/>.

2022-11-19 perl v5.36.0