.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "IRC::Formatting::HTML 3pm"
.TH IRC::Formatting::HTML 3pm "2021-01-05" "perl v5.32.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"
IRC::Formatting::HTML \- Convert between HTML and IRC formatting
.SH "VERSION"
.IX Header "VERSION"
Version 0.29
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Convert raw \s-1IRC\s0 formatting to \s-1HTML\s0
.PP
.Vb 1
\& use IRC::Formatting::HTML qw/irc_to_html html_to_irc/;
\&
\& ...
\&
\& my $irctext = "\e002\e0031,2Iron & Wine";
\& my $html = irc_to_html($irctext);
\& print $html
\&
\& # the above will print:
\& # Iron & Wine
\&
\& ...
\&
\& my $html = "Nicotine and gravy";
\& my $irctext = html_to_irc($html);
\& print $html;
\&
\& # the above will print:
\& # \e002\e026Nicotine and Gravy\e002\e026
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "irc_to_html"
.IX Subsection "irc_to_html"
irc_to_html($irctext, invert => \*(L"italic\*(R")
.PP
Takes an irc formatted string and returns the \s-1HTML\s0 version. Takes an option
to treat inverted text as italic text.
.SS "html_to_irc"
.IX Subsection "html_to_irc"
html_to_irc($html)
.PP
Takes an \s-1HTML\s0 string and returns an irc formatted string
.SH "AUTHOR"
.IX Header "AUTHOR"
Lee Aylward,
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-irc\-formatting\-html at rt.cpan.org\*(C'\fR, or through
the web interface at . I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\& perldoc IRC::Formatting::HTML
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
This is a direct port of Sam Stephenson's ruby version.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009 Lee Aylward, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.