.\" 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 "Convert::Ascii85 3pm"
.TH Convert::Ascii85 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"
Convert::Ascii85 \- Encoding and decoding of ascii85/base85 strings
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Convert::Ascii85;
\& 
\& my $encoded = Convert::Ascii85::encode($data);
\& my $decoded = Convert::Ascii85::decode($encoded);
\&
\& use Convert::Ascii85 qw(ascii85_encode ascii85_decode);
\& 
\& my $encoded = ascii85_encode($data);
\& my $decoded = ascii85_decode($encoded);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements the \fIAscii85\fR (also known as \fIBase85\fR) algorithm for
encoding binary data as text. This is done by interpreting each group of four
bytes as a 32\-bit integer, which is then converted to a five-digit base\-85
representation using the digits from \s-1ASCII 33\s0 (\f(CW\*(C`!\*(C'\fR) to 117 (\f(CW\*(C`u\*(C'\fR).
.PP
This is similar to MIME::Base64 but more space efficient: The overhead is
only 1/4 of the original data (as opposed to 1/3 for Base64).
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "Convert::Ascii85::encode \s-1DATA\s0" 4
.IX Item "Convert::Ascii85::encode DATA"
.PD 0
.IP "Convert::Ascii85::encode \s-1DATA, OPTIONS\s0" 4
.IX Item "Convert::Ascii85::encode DATA, OPTIONS"
.PD
Converts the bytes in \s-1DATA\s0 to Ascii85 and returns the resulting text string.
\&\s-1OPTIONS\s0 is a hash reference in which the following keys may be set:
.RS 4
.IP "compress_zero => 0" 4
.IX Item "compress_zero => 0"
By default, four-byte chunks of null bytes (\f(CW"\e0\e0\e0\e0"\fR) are converted to
\&\f(CW\*(Aqz\*(Aq\fR instead of \f(CW\*(Aq!!!!!\*(Aq\fR. This can be avoided by passing a false value for
\&\f(CW\*(C`compress_zero\*(C'\fR in \s-1OPTIONS.\s0
.IP "compress_space => 1" 4
.IX Item "compress_space => 1"
By default, four-byte chunks of spaces (\f(CW\*(Aq    \*(Aq\fR) are converted to \f(CW\*(Aq+<VdL\*(Aq\fR.
If you pass a true value for \f(CW\*(C`compress_space\*(C'\fR in \s-1OPTIONS,\s0 they will be
converted to \f(CW\*(Aqy\*(Aq\fR instead.
.RE
.RS 4
.Sp
This function may be exported as \f(CW\*(C`ascii85_encode\*(C'\fR into the caller's namespace.
.RE
.IP "Convert::Ascii85::decode \s-1TEXT\s0" 4
.IX Item "Convert::Ascii85::decode TEXT"
Converts the Ascii85\-encoded \s-1TEXT\s0 back to bytes and returns the resulting byte
string. Spaces and linebreaks in \s-1TEXT\s0 are ignored.
.Sp
This function may be exported as \f(CW\*(C`ascii85_decode\*(C'\fR into the caller's namespace.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://en.wikipedia.org/wiki/Ascii85>,
MIME::Base64
.SH "AUTHOR"
.IX Header "AUTHOR"
Lukas Mai, \f(CW\*(C`<l.mai at web.de>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-convert\-ascii85 at rt.cpan.org\*(C'\fR, or through
the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Convert\-Ascii85>.  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 Convert::Ascii85
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Convert\-Ascii85>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/Convert\-Ascii85>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/Convert\-Ascii85>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/Convert\-Ascii85/>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2011 Lukas Mai.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.