.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" 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. | will give a
.\" real vertical bar. \*(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<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. 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
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.IX Title "MIME::QuotedPrint 3"
.TH MIME::QuotedPrint 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
MIME::QuotedPrint \- Encoding and decoding of quoted\-printable strings
\& use MIME::QuotedPrint;
\& $encoded = encode_qp($decoded);
\& $decoded = decode_qp($encoded);
This module provides functions to encode and decode strings into and from the
quoted-printable encoding specified in \s-1RFC\s0 2045 \- \fI\s-1MIME\s0 (Multipurpose
Internet Mail Extensions)\fR. The quoted-printable encoding is intended
to represent data that largely consists of bytes that correspond to
printable characters in the \s-1ASCII\s0 character set. Each non-printable
character (as defined by English Americans) is represented by a
triplet consisting of the character \*(L"=\*(R" followed by two hexadecimal
The following functions are provided:
.IX Item "encode_qp($str)"
.ie n .IP "encode_qp($str, $eol)" 4
.el .IP "encode_qp($str, \f(CW$eol\fR)" 4
.IX Item "encode_qp($str, $eol)"
.ie n .IP "encode_qp($str, $eol\fR, \f(CW$binmode)" 4
.el .IP "encode_qp($str, \f(CW$eol\fR, \f(CW$binmode\fR)" 4
.IX Item "encode_qp($str, $eol, $binmode)"
This function returns an encoded version of the string ($str) given as
The second argument ($eol) is the line-ending sequence to use. It is
optional and defaults to \*(L"\en\*(R". Every occurrence of \*(L"\en\*(R" is replaced
with this string, and it is also used for additional \*(L"soft line
breaks\*(R" to ensure that no line end up longer than 76 characters. Pass
it as \*(L"\e015\e012\*(R" to produce data suitable for external consumption.
The string \*(L"\er\en\*(R" produces the same result on many platforms, but not
The third argument ($binmode) will select binary mode if passed as a
\&\s-1TRUE\s0 value. In binary mode \*(L"\en\*(R" will be encoded in the same way as
any other non-printable character. This ensures that a decoder will
end up with exactly the same string whatever line ending sequence it
uses. In general it is preferable to use the base64 encoding for
binary data; see MIME::Base64.
An \f(CW$eol\fR of "\*(L" (the empty string) is special. In this case, no \*(R"soft
line breaks\*(L" are introduced and binary mode is effectively enabled so
that any \*(R"\en" in the original data is encoded as well.
.IX Item "decode_qp($str);"
This function returns the plain text version of the string given
as argument. The lines of the result are \*(L"\en\*(R" terminated, even if
the \f(CW$str\fR argument contains \*(L"\er\en\*(R" terminated lines.
If you prefer not to import these routines into your namespace, you can
\& use MIME::QuotedPrint ();
\& $encoded = MIME::QuotedPrint::encode($decoded);
\& $decoded = MIME::QuotedPrint::decode($encoded);
Perl v5.8 and better allow extended Unicode characters in strings.
Such strings cannot be encoded directly, as the quoted-printable
encoding is only defined for single-byte characters. The solution is
to use the Encode module to select the byte encoding you want. For
\& use MIME::QuotedPrint qw(encode_qp);
\& use Encode qw(encode);
\& $encoded = encode_qp(encode("UTF-8", "\ex{FFFF}\en"));
Copyright 1995\-1997,2002\-2004 Gisle Aas.
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
projects / OpenSPARC-T2-SAM / blob