summary refs log tree commit diff
path: root/doc/zlib/gzoffset.3
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-12-27 22:11:35 -0500
committerJune McEnroe <june@causal.agency>2020-12-27 22:11:35 -0500
commit98ea1a27fc5e0377b13213e009f0c236f5fe73b4 (patch)
tree94c59aaaca157159510c1f81edba1d5e66cfdd64 /doc/zlib/gzoffset.3
parentAdd "this commit" option to switch form (diff)
parentReplace Makefile with portable one (diff)
downloadsrc-98ea1a27fc5e0377b13213e009f0c236f5fe73b4.tar.gz
src-98ea1a27fc5e0377b13213e009f0c236f5fe73b4.zip
Add 'doc/zlib/' from commit '38f010d3972db4262e7e0bcd7d6b9814f95d3538'
git-subtree-dir: doc/zlib
git-subtree-mainline: db652695744cc54584296b54289166b4b21ac407
git-subtree-split: 38f010d3972db4262e7e0bcd7d6b9814f95d3538
Diffstat (limited to '')
-rw-r--r--doc/zlib/gzoffset.351
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/zlib/gzoffset.3 b/doc/zlib/gzoffset.3
new file mode 100644
index 00000000..cbb78a77
--- /dev/null
+++ b/doc/zlib/gzoffset.3
@@ -0,0 +1,51 @@
+.Dd January 15, 2017
+.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.
+.
+.Sh SEE ALSO
+.Xr gzerror 3 ,
+.Xr gzopen 3 ,
+.Xr gzseek 3
+.
+.Sh HISTORY
+This manual page was converted from
+.In zlib.h
+to mdoc format by
+.An C. McEnroe Aq Mt june@causal.agency .
+.
+.Sh AUTHORS
+.An Jean-loup Gailly Aq Mt jloup@gzip.org
+.An Mark Adler Aq Mt madler@alumni.caltech.edu