From a3e8a3d6c00072a14a681d3bd93908d452a91ab8 Mon Sep 17 00:00:00 2001 From: June McEnroe Date: Thu, 8 Nov 2018 21:40:50 -0500 Subject: Convert zlib.h comments to mdoc --- deflateBound.3 | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 deflateBound.3 (limited to 'deflateBound.3') diff --git a/deflateBound.3 b/deflateBound.3 new file mode 100644 index 00000000..be97494c --- /dev/null +++ b/deflateBound.3 @@ -0,0 +1,71 @@ +.Dd January 15, 2017 +.Dt DEFLATEBOUND 3 +.Os +. +.Sh NAME +.Nm deflateBound +.Nd compressed size upper bound +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.In zlib.h +.Ft uLong +.Fn deflateBound "z_streamp strm" "uLong sourceLen" +. +.Sh DESCRIPTION +.Fn deflateBound +returns an upper bound +on the compressed size +after deflation of +.Fa sourceLen +bytes. +It must be called after +.Xr deflateInit 3 +or +.Xr deflateInit2 3 , +and after +.Xr deflateSetHeader 3 , +if used. +This would be used +to allocate an output buffer +for deflation in a single pass, +and so would be called before +.Xr deflate 3 . +If that first +.Fn deflate +call is provided the +.Fa sourceLen +input bytes, +an output buffer allocated +to the size returned by +.Fn deflateBound , +and the flush value +.Dv Z_FINISH , +then +.Fn deflate +is guaranteed to return +.Dv Z_STREAM_END . +Note that it is possible +for the compressed size +to be larger than the value returned by +.Fn deflateBound +if flush options other than +.Dv Z_FINISH +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 June 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 value=''/>
path: root/.ssh/config (unfollow)
Commit message (Expand)Author
2016-01-28Remove linux gvim aliasJune McEnroe
2016-01-28Rewrite zshrcJune McEnroe
2016-01-28Strip out useless commentsJune McEnroe
2016-01-28Trim tmux configurationJune McEnroe
2016-01-28Remove psql format wrappedJune McEnroe
2016-01-25Wow, that is so annoying, gitJune McEnroe
2016-01-25Clean up .gitconfigJune McEnroe
2016-01-15Remove gitignoreJune McEnroe
2016-01-15Eliminate escape key delay in zshJune McEnroe
2016-01-15Move pretty git log format to .gitconfigJune McEnroe
2016-01-14Remove unused git aliasesJune McEnroe
2016-01-06Hash SSH known hostsJune McEnroe
2015-12-30Ignore directory .swp filesJune McEnroe
2015-12-16Color prompt yellow in vi normal modeJune McEnroe
2015-11-23Remove colorcolumn at 120June McEnroe
2015-11-23Always git rebase --autosquashJune McEnroe
2015-11-18Add inverted shift to KarabinerJune McEnroe
2015-11-06Clean up git configsJune McEnroe
2015-11-06Add prune scriptJune McEnroe
2015-11-03Update vendored Gruvbox colorschemeJune McEnroe
2015-11-02Redefine _newline_precmd in _newline_precmdJune McEnroe
2015-11-02Print newline before every prompt after firstJune McEnroe
2015-11-02Remove first prompt placementJune McEnroe
2015-11-02Newline before prompt and start at bottom of terminalJune McEnroe
2015-10-27Add chruby to zshrcJune McEnroe