From 56de45252541aadb3a3093c4a08bdef9a97e055c Mon Sep 17 00:00:00 2001 From: Curtis McEnroe Date: Tue, 19 Feb 2019 16:57:59 -0500 Subject: Add SEE ALSO, HISTORY and AUTHORS sections --- adler32.3 | 10 ++++++++++ adler32_combine.3 | 10 ++++++++++ compress.3 | 14 +++++++++++++- compressBound.3 | 13 ++++++++++++- crc32.3 | 10 ++++++++++ crc32_combine.3 | 10 ++++++++++ deflate.3 | 14 +++++++++++++- deflateBound.3 | 13 +++++++++++++ deflateCopy.3 | 13 +++++++++++++ deflateEnd.3 | 10 ++++++++++ deflateGetDictionary.3 | 12 +++++++++++- deflateInit.3 | 17 ++++++++++++++++- deflateInit2.3 | 18 +++++++++++++++++- deflateParams.3 | 13 +++++++++++++ deflatePending.3 | 13 +++++++++++++ deflatePrime.3 | 13 +++++++++++++ deflateReset.3 | 14 ++++++++++++++ deflateSetDictionary.3 | 10 ++++++++++ deflateSetHeader.3 | 16 +++++++++++++++- deflateTune.3 | 14 ++++++++++++++ gzbuffer.3 | 14 ++++++++++++++ gzclose.3 | 13 +++++++++++++ gzdirect.3 | 13 +++++++++++++ gzeof.3 | 14 ++++++++++++++ gzerror.3 | 15 +++++++++++++++ gzflush.3 | 18 +++++++++++++++++- gzfread.3 | 16 ++++++++++++++++ gzfwrite.3 | 15 +++++++++++++++ gzgetc.3 | 18 ++++++++++++++++++ gzgets.3 | 17 +++++++++++++++++ gzoffset.3 | 15 +++++++++++++++ gzopen.3 | 32 +++++++++++++++++++++++++++++++- gzprintf.3 | 15 +++++++++++++++ gzputc.3 | 16 ++++++++++++++++ gzputs.3 | 16 ++++++++++++++++ gzread.3 | 16 ++++++++++++++++ gzseek.3 | 15 +++++++++++++++ gzsetparams.3 | 14 ++++++++++++++ gzungetc.3 | 16 ++++++++++++++++ gzwrite.3 | 15 +++++++++++++++ inflate.3 | 19 +++++++++++++++++-- inflateBack.3 | 11 +++++++++++ inflateBackEnd.3 | 10 ++++++++++ inflateBackInit.3 | 13 ++++++++++++- inflateCopy.3 | 13 +++++++++++++ inflateEnd.3 | 10 ++++++++++ inflateGetDictionary.3 | 11 +++++++++++ inflateGetHeader.3 | 17 ++++++++++++++++- inflateInit.3 | 15 ++++++++++++++- inflateInit2.3 | 13 ++++++++++++- inflateMark.3 | 13 +++++++++++++ inflatePrime.3 | 13 +++++++++++++ inflateReset.3 | 14 ++++++++++++++ inflateSetDictionary.3 | 10 ++++++++++ inflateSync.3 | 14 ++++++++++++++ uncompress.3 | 14 ++++++++++++++ zlibCompileFlags.3 | 13 +++++++++++++ zlibVersion.3 | 13 +++++++++++++ 58 files changed, 801 insertions(+), 15 deletions(-) diff --git a/adler32.3 b/adler32.3 index eed5f73..d713d95 100644 --- a/adler32.3 +++ b/adler32.3 @@ -53,3 +53,13 @@ if (adler != original_adler) error(); .Sh SEE ALSO .Xr adler32_combine 3 , .Xr crc32 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 diff --git a/adler32_combine.3 b/adler32_combine.3 index 22bd9cc..861f235 100644 --- a/adler32_combine.3 +++ b/adler32_combine.3 @@ -51,3 +51,13 @@ the result has no meaning or utility. . .Sh SEE ALSO .Xr adler32 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 diff --git a/compress.3 b/compress.3 index 81a5425..22b229e 100644 --- a/compress.3 +++ b/compress.3 @@ -69,4 +69,16 @@ if the parameter is invalid. . .Sh SEE ALSO -.Xr compressBound 3 +.Xr compressBound 3 , +.Xr deflateInit 3 , +.Xr uncompress 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 diff --git a/compressBound.3 b/compressBound.3 index 95141d6..5800e2b 100644 --- a/compressBound.3 +++ b/compressBound.3 @@ -30,4 +30,15 @@ or call to allocate the destination buffer. . .Sh SEE ALSO -.Xr compress 3 +.Xr compress 3 , +.Xr deflateBound 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 diff --git a/crc32.3 b/crc32.3 index dcda660..3c9cc8c 100644 --- a/crc32.3 +++ b/crc32.3 @@ -54,3 +54,13 @@ if (crc != original_crc) error(); .Sh SEE ALSO .Xr adler32 3 , .Xr crc32_combine 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 diff --git a/crc32_combine.3 b/crc32_combine.3 index 97d0ce2..2f79f62 100644 --- a/crc32_combine.3 +++ b/crc32_combine.3 @@ -42,3 +42,13 @@ and . .Sh SEE ALSO .Xr crc32 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 diff --git a/deflate.3 b/deflate.3 index cb926af..7df313e 100644 --- a/deflate.3 +++ b/deflate.3 @@ -355,4 +355,16 @@ to continue compressing. . .Sh SEE ALSO .Xr deflateEnd 3 , -.Xr deflateInit 3 +.Xr deflateInit 3 , +.Xr deflatePending 3 , +.Xr inflate 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 diff --git a/deflateBound.3 b/deflateBound.3 index 7a6c99e..63e8024 100644 --- a/deflateBound.3 +++ b/deflateBound.3 @@ -56,3 +56,16 @@ if flush options other than or .Dv Z_NO_FLUSH are used. +. +.Sh SEE ALSO +.Xr compressBound 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 diff --git a/deflateCopy.3 b/deflateCopy.3 index 6500343..f30d630 100644 --- a/deflateCopy.3 +++ b/deflateCopy.3 @@ -51,3 +51,16 @@ being .Fa msg is left unchanged in both source and destination. +. +.Sh SEE ALSO +.Xr deflateInit 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 diff --git a/deflateEnd.3 b/deflateEnd.3 index 96a8004..e24259a 100644 --- a/deflateEnd.3 +++ b/deflateEnd.3 @@ -38,3 +38,13 @@ may be set but then points to a static string .Sh SEE ALSO .Xr deflate 3 , .Xr deflateInit 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 diff --git a/deflateGetDictionary.3 b/deflateGetDictionary.3 index 2362354..403f6d1 100644 --- a/deflateGetDictionary.3 +++ b/deflateGetDictionary.3 @@ -33,7 +33,7 @@ If is called with .Fa dictionary equal to -.Dv Z_NULL, +.Dv Z_NULL , then only the dictionary length is returned, and nothing is copied. Similarly, @@ -67,3 +67,13 @@ if the stream state is inconsistent. . .Sh SEE ALSO .Xr deflateSetDictionary 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 diff --git a/deflateInit.3 b/deflateInit.3 index 20ce34d..a893dd9 100644 --- a/deflateInit.3 +++ b/deflateInit.3 @@ -159,5 +159,20 @@ if there is no error message. . .Sh SEE ALSO .Xr deflate 3 , +.Xr deflateCopy 3 , .Xr deflateEnd 3 , -.Xr deflateInit2 3 +.Xr deflateInit2 3 , +.Xr deflatePrime 3 , +.Xr deflateReset 3 , +.Xr deflateSetDictionary 3 , +.Xr deflateTune 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 diff --git a/deflateInit2.3 b/deflateInit2.3 index 6220ff2..6a581ef 100644 --- a/deflateInit2.3 +++ b/deflateInit2.3 @@ -170,7 +170,7 @@ and less string matching; it is somewhat intermediate between .Dv Z_DEFAULT_STRATEGY and -.Dv Z_HUFFMAN_ONLY. +.Dv Z_HUFFMAN_ONLY . .Dv Z_RLE is designed to be almost as fast as .Dv Z_HUFFMAN_ONLY , @@ -209,3 +209,19 @@ is incompatible with the version assumed by the caller .Pq Dv ZLIB_VERSION . .Fa msg is set to null if there is no error message. +. +.Sh SEE ALSO +.Xr deflate 3 , +.Xr deflateInit 3 , +.Xr deflateParams 3 , +.Xr deflateSetHeader 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 diff --git a/deflateParams.3 b/deflateParams.3 index 3378344..8e770d4 100644 --- a/deflateParams.3 +++ b/deflateParams.3 @@ -108,3 +108,16 @@ in which case .Fn deflateParams can be retried with more output space. +. +.Sh SEE ALSO +.Xr deflateInit2 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 diff --git a/deflatePending.3 b/deflatePending.3 index a93a3c8..1ce40fc 100644 --- a/deflatePending.3 +++ b/deflatePending.3 @@ -41,3 +41,16 @@ if success, or .Dv Z_STREAM_ERROR if the source stream state was inconsistent. +. +.Sh SEE ALSO +.Xr deflate 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 diff --git a/deflatePrime.3 b/deflatePrime.3 index a2f2dcf..639e715 100644 --- a/deflatePrime.3 +++ b/deflatePrime.3 @@ -49,3 +49,16 @@ to insert the bits, or .Dv Z_STREAM_ERROR if the source stream state was inconsistent. +. +.Sh SEE ALSO +.Xr deflateInit2 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 diff --git a/deflateReset.3 b/deflateReset.3 index a6fe254..7309ac1 100644 --- a/deflateReset.3 +++ b/deflateReset.3 @@ -41,3 +41,17 @@ or being .Dv Z_NULL .Pc . +. +.Sh SEE ALSO +.Xr deflateEnd 3 , +.Xr deflateInit 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 diff --git a/deflateSetDictionary.3 b/deflateSetDictionary.3 index ee44b5b..c2c9d7c 100644 --- a/deflateSetDictionary.3 +++ b/deflateSetDictionary.3 @@ -130,3 +130,13 @@ for raw deflate .Sh SEE ALSO .Xr deflateGetDictionary 3 , .Xr inflateSetDictionary 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 diff --git a/deflateSetHeader.3 b/deflateSetHeader.3 index 738e5b0..6fec645 100644 --- a/deflateSetHeader.3 +++ b/deflateSetHeader.3 @@ -76,7 +76,7 @@ are terminated with a zero byte, and that if .Fa extra is not -.Dv Z_NULL, +.Dv Z_NULL , that .Fa extra_len bytes are available there. @@ -164,3 +164,17 @@ if success, or .Dv Z_STREAM_ERROR if the source stream state was inconsistent. +. +.Sh SEE ALSO +.Xr gzip 1 , +.Xr deflateInit2 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 diff --git a/deflateTune.3 b/deflateTune.3 index a841851..7269dec 100644 --- a/deflateTune.3 +++ b/deflateTune.3 @@ -54,3 +54,17 @@ on success, or .Dv Z_STREAM_ERROR for an invalid deflate stream. +. +.Sh SEE ALSO +.Xr deflateInit 3 , +.Xr deflateInit2 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 diff --git a/gzbuffer.3 b/gzbuffer.3 index 1e68e3f..de7c706 100644 --- a/gzbuffer.3 +++ b/gzbuffer.3 @@ -43,3 +43,17 @@ the maximum length for returns 0 on success, or -1 on failure, such as being called too late. +. +.Sh SEE ALSO +.Xr gzopen 3 , +.Xr gzprintf 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 diff --git a/gzclose.3 b/gzclose.3 index 94f9f0d..77eae11 100644 --- a/gzclose.3 +++ b/gzclose.3 @@ -82,3 +82,16 @@ if the last read ended in the middle of a gzip stream, or .Dv Z_OK on success. +. +.Sh SEE ALSO +.Xr gzopen 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 diff --git a/gzdirect.3 b/gzdirect.3 index ab9e46f..8fa26aa 100644 --- a/gzdirect.3 +++ b/gzdirect.3 @@ -70,3 +70,16 @@ will include all of the zlib code for gzip file reading and decompression, which may not be desired. .Pc +. +.Sh SEE ALSO +.Xr gzopen 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 diff --git a/gzeof.3 b/gzeof.3 index 00e4ba4..26c415f 100644 --- a/gzeof.3 +++ b/gzeof.3 @@ -47,3 +47,17 @@ is reset by and the input file has grown since the previous end of file was detected. +. +.Sh SEE ALSO +.Xr gzerror 3 , +.Xr gzread 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 diff --git a/gzerror.3 b/gzerror.3 index c88c5d6..13dcddd 100644 --- a/gzerror.3 +++ b/gzerror.3 @@ -58,3 +58,18 @@ This is analogous to the function in stdio. This is useful for continuing to read a gzip file that is being written concurrently. +. +.Sh SEE ALSO +.Xr gzeof 3 , +.Xr gzread 3 , +.Xr gzwrite 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 diff --git a/gzflush.3 b/gzflush.3 index 43e03e4..b93c03e 100644 --- a/gzflush.3 +++ b/gzflush.3 @@ -48,10 +48,26 @@ should be called only when strictly necessary because it will degrade compression if called too often. . -.Sh RETURN VALUE +.Sh RETURN VALUES The return value is the zlib error number .Po see function .Xr gzerror 3 .Pc . +. +.Sh SEE ALSO +.Xr deflate 3 , +.Xr gzerror 3 , +.Xr gzread 3 , +.Xr gzwrite 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 diff --git a/gzfread.3 b/gzfread.3 index e55f742..66231cc 100644 --- a/gzfread.3 +++ b/gzfread.3 @@ -89,3 +89,19 @@ then nothing is read, zero is returned, and the error state is set to .Dv Z_STREAM_ERROR . +. +.Sh SEE ALSO +.Xr gzeof 3 , +.Xr gzerror 3 , +.Xr gzopen 3 , +.Xr gzread 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 diff --git a/gzfwrite.3 b/gzfwrite.3 index 337b86a..38383a3 100644 --- a/gzfwrite.3 +++ b/gzfwrite.3 @@ -58,3 +58,18 @@ then nothing is written, zero is returned, and the error state is set to .Dv Z_STREAM_ERROR . +. +.Sh SEE ALSO +.Xr gzerror 3 , +.Xr gzopen 3 , +.Xr gzwrite 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 diff --git a/gzgetc.3 b/gzgetc.3 index 6495cbe..93a90ed 100644 --- a/gzgetc.3 +++ b/gzgetc.3 @@ -35,3 +35,21 @@ returns the byte or -1 in case of end of file or error. +. +.Sh SEE ALSO +.Xr gzeof 3 , +.Xr gzerror 3 , +.Xr gzgets 3 , +.Xr gzopen 3 , +.Xr gzread 3 , +.Xr gzungetc 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 diff --git a/gzgets.3 b/gzgets.3 index 2a33db8..2a329e9 100644 --- a/gzgets.3 +++ b/gzgets.3 @@ -48,3 +48,20 @@ If there was an error, the contents at .Fa buf are indeterminate. +. +.Sh SEE ALSO +.Xr gzeof 3 , +.Xr gzerror 3 , +.Xr gzgetc 3 , +.Xr gzopen 3 , +.Xr gzread 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 diff --git a/gzoffset.3 b/gzoffset.3 index c43d213..cbb78a7 100644 --- a/gzoffset.3 +++ b/gzoffset.3 @@ -34,3 +34,18 @@ for a progress indicator. 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 diff --git a/gzopen.3 b/gzopen.3 index ebbf624..e3cb4cb 100644 --- a/gzopen.3 +++ b/gzopen.3 @@ -150,7 +150,7 @@ If you want to keep .Fa fd open, use -.Li "fd = dup(fd_keep); gz = gzdopen(fd, mode);" . +.Li "fd = dup(fd_keep); gz = gzdopen(fd, mode)" . The duplicated descriptor should be saved to avoid a leak, since @@ -229,3 +229,33 @@ function may fail and set for any of the errors specified for the routine .Xr fopen 3 . +. +.Sh SEE ALSO +.Xr deflateInit2 3 , +.Xr fopen 3 , +.Xr gzbuffer 3 , +.Xr gzclose 3 , +.Xr gzdirect 3 , +.Xr gzeof 3 , +.Xr gzerror 3 , +.Xr gzflush 3 , +.Xr gzgetc 3 , +.Xr gzgets 3 , +.Xr gzoffset 3 , +.Xr gzprintf 3 , +.Xr gzputc 3 , +.Xr gzputs 3 , +.Xr gzread 3 , +.Xr gzseek 3 , +.Xr gzsetparams 3 , +.Xr gzwrite 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 diff --git a/gzprintf.3 b/gzprintf.3 index 7bed8c4..26961f3 100644 --- a/gzprintf.3 +++ b/gzprintf.3 @@ -54,3 +54,18 @@ functions were not available. This can be determined using .Xr zlibCompileFlags 3 . +. +.Sh SEE ALSO +.Xr fprintf 3 , +.Xr gzerror 3 , +.Xr gzopen 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 diff --git a/gzputc.3 b/gzputc.3 index b33ac70..161e563 100644 --- a/gzputc.3 +++ b/gzputc.3 @@ -25,3 +25,19 @@ into the compressed file. .Fn gzputc returns the value that was written, or -1 in case of error. +. +.Sh SEE ALSO +.Xr gzerror 3 , +.Xr gzopen 3 , +.Xr gzputs 3 , +.Xr gzwrite 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 diff --git a/gzputs.3 b/gzputs.3 index 5abbe7d..f5d1fd8 100644 --- a/gzputs.3 +++ b/gzputs.3 @@ -23,3 +23,19 @@ excluding the terminating null character. .Fn gzputs returns the number of characters written, or -1 in case of error. +. +.Sh SEE ALSO +.Xr gzerror 3 , +.Xr gzopen 3 , +.Xr gzputc 3 , +.Xr gzwrite 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 diff --git a/gzread.3 b/gzread.3 index beefd63..84439ea 100644 --- a/gzread.3 +++ b/gzread.3 @@ -97,3 +97,19 @@ then nothing is read, -1 is returned, and the error state is set to .Dv Z_STREAM_ERROR . +. +.Sh SEE ALSO +.Xr gzeof 3 , +.Xr gzerror 3 , +.Xr gzfread 3 , +.Xr gzopen 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 diff --git a/gzseek.3 b/gzseek.3 index 4460623..cd85fd4 100644 --- a/gzseek.3 +++ b/gzseek.3 @@ -91,3 +91,18 @@ in particular if the file is opened for writing and the new starting position would be before the current position. +. +.Sh SEE ALSO +.Xr gzerror 3 , +.Xr gzoffset 3 , +.Xr gzopen 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 diff --git a/gzsetparams.3 b/gzsetparams.3 index 983b582..ff544d2 100644 --- a/gzsetparams.3 +++ b/gzsetparams.3 @@ -35,3 +35,17 @@ if there is an error writing the flushed data, or .Dv Z_MEM_ERROR if there is a memory allocation error. +. +.Sh SEE ALSO +.Xr deflateInit2 3 , +.Xr gzopen 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 diff --git a/gzungetc.3 b/gzungetc.3 index f09abe9..90cdafc 100644 --- a/gzungetc.3 +++ b/gzungetc.3 @@ -49,3 +49,19 @@ or .Fn gzungetc returns the character pushed, or -1 on failure. +. +.Sh SEE ALSO +.Xr gzbuffer 3 , +.Xr gzerror 3 , +.Xr gzgetc 3 , +.Xr gzopen 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 diff --git a/gzwrite.3 b/gzwrite.3 index 0e20ab8..606d89f 100644 --- a/gzwrite.3 +++ b/gzwrite.3 @@ -22,3 +22,18 @@ into the compressed file. .Fn gzwrite returns the number of uncompressed bytes written or 0 in case of error. +. +.Sh SEE ALSO +.Xr gzerror 3 , +.Xr gzfwrite 3 , +.Xr gzopen 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 diff --git a/inflate.3 b/inflate.3 index aae9ea5..ca90c27 100644 --- a/inflate.3 +++ b/inflate.3 @@ -263,7 +263,8 @@ and when .Fn inflate avoids the allocation of memory for a sliding window when -.Dv Z_FINISH is used. +.Dv Z_FINISH +is used. . .Pp If a preset dictionary is needed after this call @@ -379,5 +380,19 @@ if a partial recovery of the data is to be attempted. . .Sh SEE ALSO +.Xr deflate 3 , +.Xr inflateBack 3 , .Xr inflateEnd 3 , -.Xr inflateInit 3 +.Xr inflateInit 3 , +.Xr inflateMark 3 , +.Xr inflateSync 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 diff --git a/inflateBack.3 b/inflateBack.3 index 58b967d..59d5f8c 100644 --- a/inflateBack.3 +++ b/inflateBack.3 @@ -270,5 +270,16 @@ cannot return .Dv Z_OK . . .Sh SEE ALSO +.Xr inflate 3 , .Xr inflateBackEnd 3 , .Xr inflateBackInit 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 diff --git a/inflateBackEnd.3 b/inflateBackEnd.3 index 4a63ceb..eeb8863 100644 --- a/inflateBackEnd.3 +++ b/inflateBackEnd.3 @@ -31,3 +31,13 @@ if the stream state was inconsistent. .Sh SEE ALSO .Xr inflateBack 3 , .Xr inflateBackInit 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 diff --git a/inflateBackInit.3 b/inflateBackInit.3 index 4bc9ed1..483edda 100644 --- a/inflateBackInit.3 +++ b/inflateBackInit.3 @@ -70,4 +70,15 @@ does not match the version of the header file. . .Sh SEE ALSO .Xr inflateBack 3 , -.Xr inflateBackEnd 3 +.Xr inflateBackEnd 3 , +.Xr inflateInit 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 diff --git a/inflateCopy.3 b/inflateCopy.3 index ec8b2a3..53b30ed 100644 --- a/inflateCopy.3 +++ b/inflateCopy.3 @@ -44,3 +44,16 @@ being .Fa msg is left unchanged in both source and destination. +. +.Sh SEE ALSO +.Xr inflateInit 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 diff --git a/inflateEnd.3 b/inflateEnd.3 index e0b9ef5..9b18226 100644 --- a/inflateEnd.3 +++ b/inflateEnd.3 @@ -32,3 +32,13 @@ if the stream state was inconsistent. .Sh SEE ALSO .Xr inflate 3 , .Xr inflateInit 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 diff --git a/inflateGetDictionary.3 b/inflateGetDictionary.3 index 4117693..e70ee73 100644 --- a/inflateGetDictionary.3 +++ b/inflateGetDictionary.3 @@ -55,4 +55,15 @@ or if the stream state is inconsistent. . .Sh SEE ALSO +.Xr deflateSetDictionary 3 , .Xr inflateSetDictionary 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 diff --git a/inflateGetHeader.3 b/inflateGetHeader.3 index 048ad05..f77670f 100644 --- a/inflateGetHeader.3 +++ b/inflateGetHeader.3 @@ -39,7 +39,7 @@ If a zlib stream is being decoded, then .Fa head->done is set to -1 to indicate that - there will be no gzip header information forthcoming. +there will be no gzip header information forthcoming. Note that .Dv Z_BLOCK or @@ -153,3 +153,18 @@ if success, or .Dv Z_STREAM_ERROR if the source stream state was inconsistent. +. +.Sh SEE ALSO +.Xr gzip 1 , +.Xr deflateSetHeader 3 , +.Xr inflateInit2 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 diff --git a/inflateInit.3 b/inflateInit.3 index f4f9acf..186b058 100644 --- a/inflateInit.3 +++ b/inflateInit.3 @@ -84,5 +84,18 @@ is set to null if there is no error message. . .Sh SEE ALSO .Xr inflate 3 , +.Xr inflateBackInit 3 , +.Xr inflateCopy 3 , .Xr inflateEnd 3 , -.Xr inflateInit2 3 +.Xr inflateInit2 3 , +.Xr inflateSetDictionary 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 diff --git a/inflateInit2.3 b/inflateInit2.3 index bd71b94..a630f12 100644 --- a/inflateInit2.3 +++ b/inflateInit2.3 @@ -167,4 +167,15 @@ is set to null if there is no error message. . .Sh SEE ALSO .Xr deflateInit2 3 , -.Xr inflateInit 3 +.Xr inflateInit 3 , +.Xr inflatePrime 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 diff --git a/inflateMark.3 b/inflateMark.3 index d84f7c6..2d15993 100644 --- a/inflateMark.3 +++ b/inflateMark.3 @@ -73,3 +73,16 @@ parameter for .Fn inflateMark returns the value noted above, or -65536 if the provided source stream state was inconsistent. +. +.Sh SEE ALSO +.Xr inflate 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 diff --git a/inflatePrime.3 b/inflatePrime.3 index 1e6122c..c89dc2c 100644 --- a/inflatePrime.3 +++ b/inflatePrime.3 @@ -58,3 +58,16 @@ if success, or .Dv Z_STREAM_ERROR if the source stream state was inconsistent. +. +.Sh SEE ALSO +.Xr inflateInit2 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 diff --git a/inflateReset.3 b/inflateReset.3 index e1c4798..a8d2e21 100644 --- a/inflateReset.3 +++ b/inflateReset.3 @@ -65,3 +65,17 @@ being or if the .Fa windowBits parameter is invalid. +. +.Sh SEE ALSO +.Xr inflateEnd 3 , +.Xr inflateInit 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 diff --git a/inflateSetDictionary.3 b/inflateSetDictionary.3 index f27bfc4..0e3c60c 100644 --- a/inflateSetDictionary.3 +++ b/inflateSetDictionary.3 @@ -73,3 +73,13 @@ doesn't match the expected one .Sh SEE ALSO .Xr deflateGetDictionary 3 , .Xr inflateGetDictionary 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 diff --git a/inflateSync.3 b/inflateSync.3 index 311dfa2..35264dd 100644 --- a/inflateSync.3 +++ b/inflateSync.3 @@ -56,3 +56,17 @@ the application may repeatedly call .Fn inflateSync , providing more input each time, until success or the end of the input data. +. +.Sh SEE ALSO +.Xr deflate 3 , +.Xr inflate 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 diff --git a/uncompress.3 b/uncompress.3 index 620fd82..d951da9 100644 --- a/uncompress.3 +++ b/uncompress.3 @@ -76,3 +76,17 @@ In the case where there is not enough room, .Fn uncompress will fill the output buffer with the uncompressed data up to that point. +. +.Sh SEE ALSO +.Xr compress 3 , +.Xr inflate 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 diff --git a/zlibCompileFlags.3 b/zlibCompileFlags.3 index 62a3eef..465195c 100644 --- a/zlibCompileFlags.3 +++ b/zlibCompileFlags.3 @@ -148,3 +148,16 @@ not secure! .It 27-31 0 (reserved) .El +. +.Sh SEE ALSO +.Xr zlibVersion 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 diff --git a/zlibVersion.3 b/zlibVersion.3 index a2ea928..35a9854 100644 --- a/zlibVersion.3 +++ b/zlibVersion.3 @@ -30,3 +30,16 @@ This check is automatically made by .Xr deflateInit 3 and .Xr inflateInit 3 . +. +.Sh SEE ALSO +.Xr zlibCompileFlags 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 -- cgit 1.4.1