---
name: "HTML::FormatText::Vilistextum"
section: "3pm"
platform: "linux"
package: "libhtml-formatexternal-perl"
version: "26-6"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/HTML::FormatText::Vilistextum"
---

# HTML::FormatText::Vilistextum(3pm)

format HTML as plain text using vilistextum

## NAME

HTML::FormatText::Vilistextum - format HTML as plain text using vilistextum

## SYNOPSIS

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

## DESCRIPTION

`"HTML::FormatText::Vilistextum"` turns HTML into plain text using the `"vilistextum"` program.

\<http://bhaak.net/vilistextum/\>

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

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

- "input\_charset"

  There's no `"input_charset"` option yet.  (`"vilistextum"` has a `"-y"` option but it might be only a default, with the document `"<meta>"` taking precedence, whereas the intention of `"input_charset"` is to override the document.)

- "output\_charset"

  Charset "UTF-8" can be given for UTF-8 output.  This passes `"-u"` to `"vilistextum"`, which is only available if built with `"--enable-multibyte"` (as of its version 2.6.9).

## SEE ALSO

HTML::FormatExternal, [**vilistextum**(1)](/vilistextum/1.md)

## 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/\>.