perlio::gzip(3) [mojave man page]

gzip(3) 						User Contributed Perl Documentation						   gzip(3)

NAME

       PerlIO::gzip - Perl extension to provide a PerlIO layer to gzip/gunzip

SYNOPSIS

	 use PerlIO::gzip;
	 open FOO, "<:gzip", "file.gz" or die $!;
	 print while <FOO>; # And it will be uncompressed...

	 binmode FOO, ":gzip(none)" # Starts reading deflate stream from here on

DESCRIPTION

       PerlIO::gzip provides a PerlIO layer that manipulates files in the format used by the "gzip" program.  Compression and Decompression are
       implemented, but not together.  If you attempt to open a file for reading and writing the open will fail.

EXPORT

       PerlIO::gzip exports no subroutines or symbols, just a perl layer "gzip"

LAYER ARGUMENTS

       The "gzip" layer takes a comma separated list of arguments. 4 exclusive options choose the header checking mode:

       gzip
	   The default.  Expects a standard gzip file header for reading, writes a standard gzip file header.

       none
	   Expects or writes no file header; assumes the file handle is immediately a deflate stream (eg as would be found inside a "zip" file)

       auto
	   Potentially dangerous. If the first two bytes match the "gzip" header "x1fx8b" then a gzip header is assumed (and checked) else a
	   deflate stream is assumed.  No different from gzip on writing.

       autopop
	   Potentially dangerous. If the first two bytes match the "gzip" header "x1fx8b" then a gzip header is assumed (and checked) else the
	   layer is silently popped.  This results in gzip files being transparently decompressed, other files being treated normally.	Of course,
	   this has sides effects such as File::Copy becoming gunzip, and File::Compare comparing the uncompressed contents of files.

	   In autopop mode Opening a handle for writing (or reading and writing) will cause the gzip layer to automatically be popped.

       Optionally you can add this flag:

       lazy
	   For reading, defer header checking until the first read.  For writing, don't write a header until the first buffer empty of compressed
	   data to disk.  (and don't write anything at all if no data was written to the handle)

	   By default, gzip header checking is done before the "open" (or "binmode") returns, so if an error is detected in the gzip header the
	   "open" or "binmode" will fail.  However, this will require reading some data, or writing a header.  With lazy set on a file opened for
	   reading the check is deferred until the first read so the "open" should always succeed, but any problems with the header will cause an
	   error on read.

	     open FOO, "<:gzip(lazy)", "file.gz" or die $!; # Dangerous.
	     while (<FOO>) {
	       print;
	     } # Whoa. Bad. You're not distinguishing between errors and EOF.

	   If you're not careful you won't spot the errors - like the example above you'll think you got end of file.

	   lazy is ignored if you are in autopop mode.

AUTHOR

       Nicholas Clark, <nwc10+perlio-gzip@colon.colondot.net>

SEE ALSO

       perl, gzip, rfc 1952 <http://www.ietf.org/rfc/rfc1952.txt> (the gzip file format specification), rfc 1951
       <http://www.ietf.org/rfc/rfc1951.txt> (DEFLATE compressed data format specification)

perl v5.18.2							    2006-10-01								   gzip(3)

Check Out this Related Man Page

GZENCODE(3)								 1							       GZENCODE(3)

gzencode - Create a gzip compressed string

SYNOPSIS

       string gzencode (string	$data, [int  $level = -1], [int  $encoding_mode = FORCE_GZIP])

DESCRIPTION

	This function returns a compressed version of the input $data compatible with the output of the gzip program.

	For more information on the GZIP file format, see the document: GZIP file format specification version 4.3 (RFC 1952).

PARAMETERS

	      o $data
		- The data to encode.

	      o $level
		-  The	level of compression. Can be given as 0 for no compression up to 9 for maximum compression. If not given, the default com-
		pression level will be the default compression level of the zlib library.

	      o $encoding_mode
		- The encoding mode. Can be FORCE_GZIP (the default) or FORCE_DEFLATE.	Prior to PHP 5.4.0, using FORCE_DEFLATE results in a stan-
		dard zlib deflated string (inclusive zlib headers) after a gzip file header but without the trailing crc32 checksum.  In PHP 5.4.0
		and later, FORCE_DEFLATE generates RFC 1950 compliant output, consisting of a zlib header, the deflated data, and an Adler  check-
		sum.

RETURN VALUES

	The encoded string, or FALSE if an error occurred.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 5.4.0	|						    |
       |	|						    |
       |	|						    |
       |	| FORCE_DEFLATE  now  generates  RFC 1950 compliant |
       |	| output.					    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES

	The resulting data contains the appropriate headers and data structure to make a standard .gz file, e.g.:

       Example #1

	      Creating a gzip file

	      <?php
	      $data = implode("", file("bigfile.txt"));
	      $gzdata = gzencode($data, 9);
	      $fp = fopen("bigfile.txt.gz", "w");
	      fwrite($fp, $gzdata);
	      fclose($fp);
	      ?>

SEE ALSO

       gzdecode(3), gzdeflate(3), gzinflate(3), gzuncompress(3), gzcompress(3),  ZLIB Compressed Data Format Specification (RFC 1950) .

PHP Documentation Group 													       GZENCODE(3)

Linux and UNIX Man Pages

perlio::gzip(3) [mojave man page]

Check Out this Related Man Page