about summary refs log tree commit diff homepage
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2018-11-13 16:06:34 -0500
committerJune McEnroe <june@causal.agency>2018-11-13 16:06:34 -0500
commit4923c873702510cc7eef0069582694e9925b294d (patch)
tree524211e7dac705b1909d3cdac87bfb5f0e270fcf
parentAdd gzgetc.3 (diff)
downloadzlib-man-pages-4923c873702510cc7eef0069582694e9925b294d.tar.gz
zlib-man-pages-4923c873702510cc7eef0069582694e9925b294d.zip
Add gzungetc.3
Diffstat (limited to '')
-rw-r--r--Makefile1
-rw-r--r--gzungetc.351
2 files changed, 52 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index dc5a763..0f10616 100644
--- a/Makefile
+++ b/Makefile
@@ -29,6 +29,7 @@ MAN += gzputc.3
 MAN += gzputs.3
 MAN += gzread.3
 MAN += gzsetparams.3
+MAN += gzungetc.3
 MAN += gzwrite.3
 MAN += inflate.3
 MAN += inflateBack.3
diff --git a/gzungetc.3 b/gzungetc.3
new file mode 100644
index 0000000..a766753
--- /dev/null
+++ b/gzungetc.3
@@ -0,0 +1,51 @@
+.Dd November 13, 2018
+.Dt GZUNGETC 3
+.Os
+.
+.Sh NAME
+.Nm gzungetc
+.Nd un-get character from compressed file
+.
+.Sh LIBRARY
+.Lb libz
+.
+.Sh SYNOPSIS
+.In zlib.h
+.Ft int
+.Fn gzungetc "int c" "gzFile file"
+.
+.Sh DESCRIPTION
+Push one character back onto the stream
+to be read as the first character
+on the next read.
+At least one character of push-back
+is allowed.
+.Fn gzungetc
+will fail if
+.Fa c
+is -1,
+and may fail if a character
+has been pushed
+but not read yet.
+If
+.Fn gzungetc
+is used immediately after
+.Xr gzopen 3
+or
+.Xr gzdopen 3 ,
+at least the output buffer size
+of pushed characters is allowed.
+.Po
+See
+.Xr gzbuffer 3 .
+.Pc \&
+The pushed character will be discarded
+if the stream is repositioned with
+.Xr gzseek 3
+or
+.Xr gzrewind 3 .
+.
+.Sh RETURN VALUES
+.Fn gzungetc
+returns the character pushed,
+or -1 on failure.