diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/mageia-cauldron/man3pm/MIME::QuotedPrint.3pm | |
parent | Initial commit. (diff) | |
download | manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip |
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/mageia-cauldron/man3pm/MIME::QuotedPrint.3pm')
-rw-r--r-- | upstream/mageia-cauldron/man3pm/MIME::QuotedPrint.3pm | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man3pm/MIME::QuotedPrint.3pm b/upstream/mageia-cauldron/man3pm/MIME::QuotedPrint.3pm new file mode 100644 index 00000000..c2f93f66 --- /dev/null +++ b/upstream/mageia-cauldron/man3pm/MIME::QuotedPrint.3pm @@ -0,0 +1,154 @@ +.\" -*- 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 "MIME::QuotedPrint 3pm" +.TH MIME::QuotedPrint 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" 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 +MIME::QuotedPrint \- Encoding and decoding of quoted\-printable strings +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& use MIME::QuotedPrint; +\& +\& $encoded = encode_qp($decoded); +\& $decoded = decode_qp($encoded); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +This module provides functions to encode and decode strings into and from the +quoted-printable encoding specified in RFC 2045 \- \fIMIME (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 ASCII character set. Each non-printable +character (as defined by English Americans) is represented by a +triplet consisting of the character "=" followed by two hexadecimal +digits. +.PP +The following functions are provided: +.ie n .IP "encode_qp( $str)" 4 +.el .IP "encode_qp( \f(CW$str\fR)" 4 +.IX Item "encode_qp( $str)" +.PD 0 +.ie n .IP "encode_qp( $str, $eol)" 4 +.el .IP "encode_qp( \f(CW$str\fR, \f(CW$eol\fR)" 4 +.IX Item "encode_qp( $str, $eol)" +.ie n .IP "encode_qp( $str, $eol, $binmode )" 4 +.el .IP "encode_qp( \f(CW$str\fR, \f(CW$eol\fR, \f(CW$binmode\fR )" 4 +.IX Item "encode_qp( $str, $eol, $binmode )" +.PD +This function returns an encoded version of the string ($str) given as +argument. +.Sp +The second argument ($eol) is the line-ending sequence to use. It is +optional and defaults to "\en". Every occurrence of "\en" is replaced +with this string, and it is also used for additional "soft line +breaks" to ensure that no line end up longer than 76 characters. Pass +it as "\e015\e012" to produce data suitable for external consumption. +The string "\er\en" produces the same result on many platforms, but not +all. +.Sp +The third argument ($binmode) will select binary mode if passed as a +TRUE value. In binary mode "\en" 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. +.Sp +An \f(CW$eol\fR of "" (the empty string) is special. In this case, no "soft +line breaks" are introduced and binary mode is effectively enabled so +that any "\en" in the original data is encoded as well. +.ie n .IP "decode_qp( $str )" 4 +.el .IP "decode_qp( \f(CW$str\fR )" 4 +.IX Item "decode_qp( $str )" +This function returns the plain text version of the string given +as argument. The lines of the result are "\en" terminated, even if +the \f(CW$str\fR argument contains "\er\en" terminated lines. +.PP +If you prefer not to import these routines into your namespace, you can +call them as: +.PP +.Vb 3 +\& use MIME::QuotedPrint (); +\& $encoded = MIME::QuotedPrint::encode($decoded); +\& $decoded = MIME::QuotedPrint::decode($encoded); +.Ve +.PP +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 +example: +.PP +.Vb 2 +\& use MIME::QuotedPrint qw(encode_qp); +\& use Encode qw(encode); +\& +\& $encoded = encode_qp(encode("UTF\-8", "\ex{FFFF}\en")); +\& print $encoded; +.Ve +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 1995\-1997,2002\-2004 Gisle Aas. +.PP +This library is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +MIME::Base64 |