From b9eb3d6f23df0669e7dccda38fac58c991284607 Mon Sep 17 00:00:00 2001 From: Curtis McEnroe Date: Fri, 9 Nov 2018 14:30:03 -0500 Subject: Use Pq/Po/Pc more --- deflate.3 | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) (limited to 'deflate.3') diff --git a/deflate.3 b/deflate.3 index b3b498b..f25b78e 100644 --- a/deflate.3 +++ b/deflate.3 @@ -51,7 +51,7 @@ or between 0 and 9: 1 gives best speed, 9 gives best compression, 0 gives no compression at all -(the input data is sumply copied a block at a time). +(the input data is simply copied a block at a time). .Dv Z_DEFAULT_COMPRESSION requests a default compromise between speed and compression (currently equivalent to level 6). @@ -161,10 +161,12 @@ is set to all pending output is flushed to the output buffer and the output is aligned on a byte boundary, so that the decompressor can get all input data available so far. -(In particular +.Po +In particular .Fa avail_in is zero after the call if enough output space -has been provided before the call.) +has been provided before the call. +.Pc Flushing may degrade compression for some compression algorithms and so it should be used only when necessary. This completes the current deflate block @@ -279,8 +281,7 @@ or this function must be called again with .Dv Z_FINISH and more output space -(updated -.Fa avail_out ) +.Pq updated Fa avail_out but no more input data, until it returns with .Dv Z_STREAM_END @@ -321,9 +322,11 @@ sets .Fa strm->adler to the Adler-32 checksum of all input read so far -(that is, +.Po +that is, .Fa total_in -bytes). +bytes +.Pc . If a gzip stream is being generated, then .Fa strm->adler @@ -392,22 +395,26 @@ is set to .Pc , .Dv Z_STREAM_ERROR if the stream state was inconsistent -(for example if +.Po +for example if .Fa next_in or .Fa next_out was .Dv Z_NULL or the state was inadvertently written over -by the application), +by the application +.Pc , or .Dv Z_BUF_ERROR if no progress is possible -(for example +.Po +for example .Fa avail_in or .Fa avail_out -was zero). +was zero +.Pc . Note that .Dv Z_BUF_ERROR is not fatal, -- cgit 1.4.1