php man page for gzopen

GZOPEN(3)								 1								 GZOPEN(3)

gzopen - Open gz-file

SYNOPSIS
       resource gzopen (string	$filename, string  $mode, [int	$use_include_path])

DESCRIPTION
	Opens a gzip (.gz) file for reading or writing.

       gzopen(3)  can  be  used to read a file which is not in gzip format; in this case gzread(3) will directly read from the file without decom-
       pression.

PARAMETERS
	      o $filename
		- The file name.

	      o $mode
		- As in fopen(3) ( rb or wb) but can also include a compression level ( wb9) or a strategy: f for filtered data as in wb6f, h  for
		Huffman only compression as in wb1h. (See the description of deflateInit2 in zlib.h for more information about the strategy param-
		eter.)

	      o $use_include_path
		- You can set this optional parameter to 1, if you want to search for the file in the include_path too.

RETURN VALUES
	Returns a file pointer to the file opened, after that, everything you read from this file descriptor will  be  transparently  decompressed
       and what you write gets compressed.

	If the open fails, the function returns FALSE.

EXAMPLES
       Example #1

	      gzopen(3) Example

	      <?php
	      $fp = gzopen("/tmp/file.gz", "r");
	      ?>

SEE ALSO
       gzclose(3).

PHP Documentation Group 														 GZOPEN(3)