summaryrefslogtreecommitdiff
path: root/Master/tlpkg/tlperl/lib/IO/Compress/Bzip2.pm
diff options
context:
space:
mode:
Diffstat (limited to 'Master/tlpkg/tlperl/lib/IO/Compress/Bzip2.pm')
-rw-r--r--Master/tlpkg/tlperl/lib/IO/Compress/Bzip2.pm92
1 files changed, 43 insertions, 49 deletions
diff --git a/Master/tlpkg/tlperl/lib/IO/Compress/Bzip2.pm b/Master/tlpkg/tlperl/lib/IO/Compress/Bzip2.pm
index 5fa5f584d28..1c0d027abdc 100644
--- a/Master/tlpkg/tlperl/lib/IO/Compress/Bzip2.pm
+++ b/Master/tlpkg/tlperl/lib/IO/Compress/Bzip2.pm
@@ -5,16 +5,16 @@ use warnings;
use bytes;
require Exporter ;
-use IO::Compress::Base 2.074 ;
+use IO::Compress::Base 2.084 ;
-use IO::Compress::Base::Common 2.074 qw();
-use IO::Compress::Adapter::Bzip2 2.074 ;
+use IO::Compress::Base::Common 2.084 qw();
+use IO::Compress::Adapter::Bzip2 2.084 ;
our ($VERSION, @ISA, @EXPORT_OK, %EXPORT_TAGS, $Bzip2Error);
-$VERSION = '2.074';
+$VERSION = '2.084';
$Bzip2Error = '';
@ISA = qw(IO::Compress::Base Exporter);
@@ -51,7 +51,7 @@ sub getExtraParams
{
my $self = shift ;
- use IO::Compress::Base::Common 2.074 qw(:Parse);
+ use IO::Compress::Base::Common 2.084 qw(:Parse);
return (
'blocksize100k' => [IO::Compress::Base::Common::Parse_unsigned, 1],
@@ -143,14 +143,12 @@ __END__
=head1 NAME
IO::Compress::Bzip2 - Write bzip2 files/buffers
-
-
=head1 SYNOPSIS
use IO::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
- my $status = bzip2 $input => $output [,OPTS]
+ my $status = bzip2 $input => $output [,OPTS]
or die "bzip2 failed: $Bzip2Error\n";
my $z = new IO::Compress::Bzip2 $output [,OPTS]
@@ -170,7 +168,7 @@ IO::Compress::Bzip2 - Write bzip2 files/buffers
$z->autoflush();
$z->input_line_number();
$z->newStream( [OPTS] );
-
+
$z->close() ;
$Bzip2Error ;
@@ -185,14 +183,14 @@ IO::Compress::Bzip2 - Write bzip2 files/buffers
binmode $z
fileno $z
close $z ;
-
+
=head1 DESCRIPTION
-This module provides a Perl interface that allows writing bzip2
+This module provides a Perl interface that allows writing bzip2
compressed data to files or buffer.
-For reading bzip2 files/buffers, see the companion module
+For reading bzip2 files/buffers, see the companion module
L<IO::Uncompress::Bunzip2|IO::Uncompress::Bunzip2>.
=head1 Functional Interface
@@ -204,7 +202,7 @@ section.
use IO::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
- bzip2 $input_filename_or_reference => $output_filename_or_reference [,OPTS]
+ bzip2 $input_filename_or_reference => $output_filename_or_reference [,OPTS]
or die "bzip2 failed: $Bzip2Error\n";
The functional interface needs Perl5.005 or better.
@@ -217,7 +215,7 @@ C<$input_filename_or_reference> and C<$output_filename_or_reference>.
=head3 The C<$input_filename_or_reference> parameter
The parameter, C<$input_filename_or_reference>, is used to define the
-source of the uncompressed data.
+source of the uncompressed data.
It can take one of the following forms:
@@ -235,17 +233,17 @@ If the C<$input_filename_or_reference> parameter is a filehandle, the input
data will be read from it. The string '-' can be used as an alias for
standard input.
-=item A scalar reference
+=item A scalar reference
If C<$input_filename_or_reference> is a scalar reference, the input data
will be read from C<$$input_filename_or_reference>.
-=item An array reference
+=item An array reference
If C<$input_filename_or_reference> is an array reference, each element in
the array must be a filename.
-The input data will be read from each file in turn.
+The input data will be read from each file in turn.
The complete array will be walked to ensure that it only
contains valid filenames before any data is compressed.
@@ -253,8 +251,8 @@ contains valid filenames before any data is compressed.
=item An Input FileGlob string
If C<$input_filename_or_reference> is a string that is delimited by the
-characters "<" and ">" C<bzip2> will assume that it is an
-I<input fileglob string>. The input is the list of files that match the
+characters "<" and ">" C<bzip2> will assume that it is an
+I<input fileglob string>. The input is the list of files that match the
fileglob.
See L<File::GlobMapper|File::GlobMapper> for more details.
@@ -275,7 +273,7 @@ these forms.
=item A filename
If the C<$output_filename_or_reference> parameter is a simple scalar, it is
-assumed to be a filename. This file will be opened for writing and the
+assumed to be a filename. This file will be opened for writing and the
compressed data will be written to it.
=item A filehandle
@@ -284,14 +282,14 @@ If the C<$output_filename_or_reference> parameter is a filehandle, the
compressed data will be written to it. The string '-' can be used as
an alias for standard output.
-=item A scalar reference
+=item A scalar reference
If C<$output_filename_or_reference> is a scalar reference, the
compressed data will be stored in C<$$output_filename_or_reference>.
=item An Array Reference
-If C<$output_filename_or_reference> is an array reference,
+If C<$output_filename_or_reference> is an array reference,
the compressed data will be pushed onto the array.
=item An Output FileGlob
@@ -329,7 +327,7 @@ L</"Constructor Options"> section below.
=item C<< AutoClose => 0|1 >>
-This option applies to any input or output data streams to
+This option applies to any input or output data streams to
C<bzip2> that are filehandles.
If C<AutoClose> is specified, and the value is true, it will result in all
@@ -340,9 +338,7 @@ This parameter defaults to 0.
=item C<< BinModeIn => 0|1 >>
-When reading from a file or filehandle, set C<binmode> before reading.
-
-Defaults to 0.
+This option is now a no-op. All files will be read in binmode.
=item C<< Append => 0|1 >>
@@ -371,7 +367,7 @@ written to it. Otherwise the file pointer will not be moved.
=back
-When C<Append> is specified, and set to true, it will I<append> all compressed
+When C<Append> is specified, and set to true, it will I<append> all compressed
data to the output data stream.
So when the output is a filehandle it will carry out a seek to the eof
@@ -415,7 +411,7 @@ compressed data to a buffer, C<$buffer>.
my $input = new IO::File "<file1.txt"
or die "Cannot open 'file1.txt': $!\n" ;
my $buffer ;
- bzip2 $input => \$buffer
+ bzip2 $input => \$buffer
or die "bzip2 failed: $Bzip2Error\n";
To compress all files in the directory "/my/home" that match "*.txt"
@@ -437,7 +433,7 @@ and if you want to compress each file one at a time, this will do the trick
for my $input ( glob "/my/home/*.txt" )
{
my $output = "$input.bz2" ;
- bzip2 $input => $output
+ bzip2 $input => $output
or die "Error compressing '$input': $Bzip2Error\n";
}
@@ -450,14 +446,14 @@ The format of the constructor for C<IO::Compress::Bzip2> is shown below
my $z = new IO::Compress::Bzip2 $output [,OPTS]
or die "IO::Compress::Bzip2 failed: $Bzip2Error\n";
-It returns an C<IO::Compress::Bzip2> object on success and undef on failure.
+It returns an C<IO::Compress::Bzip2> object on success and undef on failure.
The variable C<$Bzip2Error> will contain an error message on failure.
-If you are running Perl 5.005 or better the object, C<$z>, returned from
-IO::Compress::Bzip2 can be used exactly like an L<IO::File|IO::File> filehandle.
-This means that all normal output file operations can be carried out
-with C<$z>.
-For example, to write to a compressed file/buffer you can use either of
+If you are running Perl 5.005 or better the object, C<$z>, returned from
+IO::Compress::Bzip2 can be used exactly like an L<IO::File|IO::File> filehandle.
+This means that all normal output file operations can be carried out
+with C<$z>.
+For example, to write to a compressed file/buffer you can use either of
these forms
$z->print("hello world\n");
@@ -480,7 +476,7 @@ If the C<$output> parameter is a filehandle, the compressed data will be
written to it.
The string '-' can be used as an alias for standard output.
-=item A scalar reference
+=item A scalar reference
If C<$output> is a scalar reference, the compressed data will be stored
in C<$$output>.
@@ -507,7 +503,7 @@ This parameter defaults to 0.
=item C<< Append => 0|1 >>
-Opens C<$output> in append mode.
+Opens C<$output> in append mode.
The behaviour of this option is dependent on the type of C<$output>.
@@ -537,7 +533,7 @@ This parameter defaults to 0.
=item C<< BlockSize100K => number >>
-Specify the number of 100K blocks bzip2 uses during compression.
+Specify the number of 100K blocks bzip2 uses during compression.
Valid values are from 1 to 9, where 9 is best compression.
@@ -562,7 +558,7 @@ This is a placeholder option.
TODO
-=head1 Methods
+=head1 Methods
=head2 print
@@ -672,7 +668,7 @@ This is a noop provided for completeness.
$z->opened()
-Returns true if the object currently refers to a opened file/buffer.
+Returns true if the object currently refers to a opened file/buffer.
=head2 autoflush
@@ -695,7 +691,7 @@ retrieve the autoflush setting.
$z->input_line_number()
$z->input_line_number(EXPR)
-This method always returns C<undef> when compressing.
+This method always returns C<undef> when compressing.
=head2 fileno
@@ -714,7 +710,7 @@ C<undef>.
$z->close() ;
close $z ;
-Flushes any pending compressed data and then closes the output file/buffer.
+Flushes any pending compressed data and then closes the output file/buffer.
For most versions of Perl this method will be automatically invoked if
the IO::Compress::Bzip2 object is destroyed (either explicitly or by the
@@ -747,9 +743,9 @@ the C<$z> object.
See the L</"Constructor Options"> section for more details.
-=head1 Importing
+=head1 Importing
-No symbolic constants are required by this IO::Compress::Bzip2 at present.
+No symbolic constants are required by this IO::Compress::Bzip2 at present.
=over 5
@@ -760,8 +756,6 @@ Same as doing this
use IO::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
-
-
=back
=head1 EXAMPLES
@@ -776,7 +770,7 @@ See L<IO::Compress::FAQ|IO::Compress::FAQ/"Compressed files and Net::FTP">
=head1 SEE ALSO
-L<Compress::Zlib>, L<IO::Compress::Gzip>, L<IO::Uncompress::Gunzip>, L<IO::Compress::Deflate>, L<IO::Uncompress::Inflate>, L<IO::Compress::RawDeflate>, L<IO::Uncompress::RawInflate>, L<IO::Uncompress::Bunzip2>, L<IO::Compress::Lzma>, L<IO::Uncompress::UnLzma>, L<IO::Compress::Xz>, L<IO::Uncompress::UnXz>, L<IO::Compress::Lzop>, L<IO::Uncompress::UnLzop>, L<IO::Compress::Lzf>, L<IO::Uncompress::UnLzf>, L<IO::Uncompress::AnyInflate>, L<IO::Uncompress::AnyUncompress>
+L<Compress::Zlib>, L<IO::Compress::Gzip>, L<IO::Uncompress::Gunzip>, L<IO::Compress::Deflate>, L<IO::Uncompress::Inflate>, L<IO::Compress::RawDeflate>, L<IO::Uncompress::RawInflate>, L<IO::Uncompress::Bunzip2>, L<IO::Compress::Lzma>, L<IO::Uncompress::UnLzma>, L<IO::Compress::Xz>, L<IO::Uncompress::UnXz>, L<IO::Compress::Lzip>, L<IO::Uncompress::UnLzip>, L<IO::Compress::Lzop>, L<IO::Uncompress::UnLzop>, L<IO::Compress::Lzf>, L<IO::Uncompress::UnLzf>, L<IO::Compress::Zstd>, L<IO::Uncompress::UnZstd>, L<IO::Uncompress::AnyInflate>, L<IO::Uncompress::AnyUncompress>
L<IO::Compress::FAQ|IO::Compress::FAQ>
@@ -790,7 +784,7 @@ See the module L<Compress::Bzip2|Compress::Bzip2>
=head1 AUTHOR
-This module was written by Paul Marquess, C<pmqs@cpan.org>.
+This module was written by Paul Marquess, C<pmqs@cpan.org>.
=head1 MODIFICATION HISTORY
@@ -798,7 +792,7 @@ See the Changes file.
=head1 COPYRIGHT AND LICENSE
-Copyright (c) 2005-2017 Paul Marquess. All rights reserved.
+Copyright (c) 2005-2019 Paul Marquess. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.