diff options
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | gzoffset.3 | 36 |
2 files changed, 37 insertions, 0 deletions
diff --git a/Makefile b/Makefile index ffac1f1..14a3455 100644 --- a/Makefile +++ b/Makefile @@ -24,6 +24,7 @@ MAN += gzfread.3 MAN += gzfwrite.3 MAN += gzgetc.3 MAN += gzgets.3 +MAN += gzoffset.3 MAN += gzopen.3 MAN += gzprintf.3 MAN += gzputc.3 diff --git a/gzoffset.3 b/gzoffset.3 new file mode 100644 index 0000000..35f0098 --- /dev/null +++ b/gzoffset.3 @@ -0,0 +1,36 @@ +.Dd November 13, 2018 +.Dt GZOFFSET 3 +.Os +. +.Sh NAME +.Nm gzoffset +.Nd offset in compressed file +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.In zlib.h +.Ft z_off_t +.Fn gzoffset "gzFile file" +. +.Sh DESCRIPTION +Returns the current offset +in the file being read or written. +This offset includes +the count of bytes +that precede the gzip stream, +for example when appending +or when using +.Xr gzdopen 3 +for reading. +When reading, +the offset does not include +as yet unused buffered input. +This information can be used +for a progress indicator. +. +.Sh RETURN VALUES +On error, +.Fn gzoffset +returns -1. |