diff options
| author | June McEnroe <june@causal.agency> | 2018-11-13 16:33:41 -0500 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2018-11-13 16:33:41 -0500 |
| commit | 646acfa91329ca5e8d3651801d734bf82f070e24 (patch) | |
| tree | 579ab05503de613218ff085af3bd261681a7cc5c /gzoffset.3 | |
| parent | Add gztell(3) to gzseek.3 (diff) | |
| download | zlib-man-pages-646acfa91329ca5e8d3651801d734bf82f070e24.tar.gz zlib-man-pages-646acfa91329ca5e8d3651801d734bf82f070e24.zip | |
Add gzoffset.3
Diffstat (limited to 'gzoffset.3')
| -rw-r--r-- | gzoffset.3 | 36 |
1 files changed, 36 insertions, 0 deletions
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. |