.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::Escape 3pm"
.TH HTML::Escape 3pm 2024-03-07 "perl v5.38.2" "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::Escape \- Extremely fast HTML escaping
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use HTML::Escape qw/escape_html/;
\&
\&    my $escaped = escape_html("<^o^>");
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This modules provides a function which escapes HTML's special characters. It
performs a similar function to PHP's htmlspecialchars.  It escapes the
following characters:
.PP
.Vb 1
\&    " & \*(Aq < > \` { }
.Ve
.PP
This module uses XS for better performance, but it also provides a pure perl
version.
.SH FAQ
.IX Header "FAQ"
.IP "Is there also an unescape_html?" 4
.IX Item "Is there also an unescape_html?"
No. Unescaping HTML requires a lot of code, and we don't want to do it.
Please use HTML::Entities for it.
.SH BENCHMARK
.IX Header "BENCHMARK"
.Vb 3
\&                     Rate HTML::Entities   HTML::Escape
\&    HTML::Entities 14.0/s             \-\-           \-91%
\&    HTML::Escape    150/s           975%             \-\-
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Goro Fuji
.PP
Tokuhiro Matsuno <tokuhirom AAJKLFJEF@ GMAIL COM>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Text::Xslate, HTML::Entities
.SH LICENSE
.IX Header "LICENSE"
Copyright (C) Tokuhiro Matsuno
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.