1.\" Copyright (c) 2014 Xin LI <delphij@FreeBSD.org> 2.\" 3.\" Redistribution and use in source and binary forms, with or without 4.\" modification, are permitted provided that the following conditions 5.\" are met: 6.\" 1. Redistributions of source code must retain the above copyright 7.\" notice, this list of conditions and the following disclaimer. 8.\" 2. Redistributions in binary form must reproduce the above copyright 9.\" notice, this list of conditions and the following disclaimer in the 10.\" documentation and/or other materials provided with the distribution. 11.\" 12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 15.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 22.\" SUCH DAMAGE. 23.\" 24.\" $FreeBSD$ 25.\" 26.Dd March 5, 2014 27.Dt ZOPEN 3 28.Os 29.Sh NAME 30.Nm zopen 31.Nd open a gzip compressed stream 32.Sh LIBRARY 33.Lb libz 34.Sh SYNOPSIS 35.Ft FILE * 36.Fn zopen "const char *path" "const char *mode" 37.Sh DESCRIPTION 38The 39.Fn zopen 40opens a gzip file whose name is the string pointed to by 41.Fa path 42and associates a stream with it. 43It is a wrapper around 44.Xr zlib 3 45and standard stream I/O APIs. 46.Pp 47The argument 48.Fa mode 49have the same meaning as it does in 50.Xr fopen 3 . 51.Pp 52The 53.Nm 54function will associate read, write, seek and close 55functions of 56.Xr zlib 3 57after successfully opened a file with 58.Xr funopen 3 59so that they will be used to read or write the new stream. 60.Sh RETURN VALUES 61Upon successful completion 62.Nm 63returns a 64.Tn FILE 65pointer. 66Otherwise, 67.Dv NULL 68is returned and the global variable 69.Va errno 70is set to indicate the error. 71.Sh ERRORS 72In addition to the errors documented for 73.Xr fopen 3 , 74the 75.Nm 76function may also fail for: 77.Bl -tag -width Er 78.It Bq Er ENOMEM 79Insufficient memory is available. 80.El 81.Sh COMPATIBILITY 82This implementation of 83.Nm 84function first appeared in 85.Nx 1.6 86and 87.Fx 4.5 . 88The 89.Nm 90function may not be portable to systems other than 91.Fx . 92.Sh SEE ALSO 93.Xr fopen 3 , 94.Xr funopen 3 , 95.Xr zlib 3 96