usr.bin/compress/zopen.3

   1 .\" Copyright (c) 1992, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)zopen.3     8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/usr.bin/compress/zopen.3,v 1.5.2.3 2001/12/14 15:53:29 ru Exp $
  34 .\" $DragonFly: src/usr.bin/compress/zopen.3,v 1.2 2003/06/17 04:29:25 dillon Exp $
  35 .\"
  36 .Dd June 9, 1993
  37 .Dt ZOPEN 3
  38 .Os
  39 .Sh NAME
  40 .Nm zopen
  41 .Nd compressed stream open function
  42 .Sh SYNOPSIS
  43 .Fd #include \&"zopen.h\&"
  44 .Ft FILE *
  45 .Fn zopen "const char *path" "const char *mode" "int bits"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn zopen
  49 function
  50 opens the compressed file whose name is the string pointed to by
  51 .Fa path
  52 and associates a stream with it.
  53 .Pp
  54 The argument
  55 .Fa mode
  56 points to one of the following one-character strings:
  57 .Bl -tag -width indent
  58 .It Dq Li r
  59 Open compressed file for reading.
  60 The stream is positioned at the beginning of the file.
  61 .It Dq Li w
  62 Truncate file to zero length or create compressed file for writing.
  63 The stream is positioned at the beginning of the file.
  64 .El
  65 .Pp
  66 Any created files will have mode
  67 .Pf \\*q Dv S_IRUSR
  68 \&|
  69 .Dv S_IWUSR
  70 \&|
  71 .Dv S_IRGRP
  72 \&|
  73 .Dv S_IWGRP
  74 \&|
  75 .Dv S_IROTH
  76 \&|
  77 .Dv S_IWOTH Ns \\*q
  78 .Pq Li 0666 ,
  79 as modified by the process'
  80 umask value (see
  81 .Xr umask 2 ) .
  82 .Pp
  83 Files may only be read or written.
  84 Seek operations are not allowed.
  85 .Pp
  86 The
  87 .Fa bits
  88 argument, if non-zero, is set to the bits code limit.
  89 If zero, the default is 16.
  90 See
  91 .Xr compress 1
  92 for more information.
  93 .Sh RETURN VALUES
  94 Upon successful completion
  95 .Fn zopen
  96 returns a
  97 .Tn FILE
  98 pointer.
  99 Otherwise,
 100 .Dv NULL
 101 is returned and the global variable
 102 .Va errno
 103 is set to indicate the error.
 104 .Sh ERRORS
 105 .Bl -tag -width [EINVAL]
 106 .It Bq Er EINVAL
 107 The
 108 .Fa mode
 109 or
 110 .Fa bits
 111 arguments specified to
 112 .Fn zopen
 113 were invalid.
 114 .It Bq Er EFTYPE
 115 The compressed file starts with an invalid header, or the compressed
 116 file is compressed with more bits than can be handled.
 117 .El
 118 .Pp
 119 The
 120 .Fn zopen
 121 function may also fail and set
 122 .Va errno
 123 for any of the errors specified for the routines
 124 .Xr fopen 3
 125 or
 126 .Xr funopen 3 .
 127 .Sh SEE ALSO
 128 .Xr compress 1 ,
 129 .Xr fopen 3 ,
 130 .Xr funopen 3
 131 .Sh HISTORY
 132 The
 133 .Nm
 134 function
 135 first appeared in
 136 .Bx 4.4 .
 137 .Sh BUGS
 138 The
 139 .Fn zopen
 140 function
 141 may not be portable to systems other than
 142 .Bx .