diff options
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | gzgets.3 | 50 |
2 files changed, 51 insertions, 0 deletions
diff --git a/Makefile b/Makefile index aab5122..8b758b0 100644 --- a/Makefile +++ b/Makefile @@ -21,6 +21,7 @@ MAN += deflateTune.3 MAN += gzbuffer.3 MAN += gzfread.3 MAN += gzfwrite.3 +MAN += gzgets.3 MAN += gzopen.3 MAN += gzprintf.3 MAN += gzputs.3 diff --git a/gzgets.3 b/gzgets.3 new file mode 100644 index 0000000..f615470 --- /dev/null +++ b/gzgets.3 @@ -0,0 +1,50 @@ +.Dd November 13, 2018 +.Dt GZGETS 3 +.Os +. +.Sh NAME +.Nm gzgets +.Nd read line from compressed file +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.In zlib.h +.Ft char * +.Fn gzgets "gzFile file" "char *buf" "int len" +. +.Sh DESCRIPTION +Reads bytes from the compressed file +until +.Fa len-1 +characters are read, +or a newline character +is read and transferred to +.Fa buf , +or an end-of-file condition +is encountered. +If any characters are read or if +.Fa len +== 1, +the string is terminated +with a null character. +If no characters are read +due to an end-of-file or +.Fa len +< 1, +then the buffer is left untouched. +. +.Sh RETURN VALUES +.Fn gzgets +returns +.Fa buf +which is a null-terminated string, +or it returns +.Dv NULL +for end-of-file +or in case of error. +If there was an error, +the contents at +.Fa buf +are indeterminate. |