From 2dbc937e4ecf6e43ef6bbdeadea1ff910a1cb5f9 Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Thu, 15 Aug 2019 15:46:51 +0000 Subject: minor cleanup: * add the missing STANDARDS section * mark up ASN.1 type names * and minor wording improvements --- src/lib/libcrypto/man/CMS_uncompress.3 | 39 +++++++++++++++++----------------- 1 file changed, 20 insertions(+), 19 deletions(-) (limited to 'src') diff --git a/src/lib/libcrypto/man/CMS_uncompress.3 b/src/lib/libcrypto/man/CMS_uncompress.3 index 1b99e72d28..786828b1c5 100644 --- a/src/lib/libcrypto/man/CMS_uncompress.3 +++ b/src/lib/libcrypto/man/CMS_uncompress.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: CMS_uncompress.3,v 1.4 2019/08/11 12:46:38 schwarze Exp $ +.\" $OpenBSD: CMS_uncompress.3,v 1.5 2019/08/15 15:46:51 schwarze Exp $ .\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 .\" .\" This file was written by Dr. Stephen Henson . @@ -48,7 +48,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: August 11 2019 $ +.Dd $Mdocdate: August 15 2019 $ .Dt CMS_UNCOMPRESS 3 .Os .Sh NAME @@ -65,41 +65,42 @@ .Fc .Sh DESCRIPTION .Fn CMS_uncompress -extracts and uncompresses the content from a CMS CompressedData +extracts and uncompresses the content of a CMS +.Vt CompressedData structure -.Fa cms . -.Fa out -is a -.Vt BIO -to write the content to and -.Fa flags -is an optional set of flags. +.Fa cms +and writes it to +.Fa out . .Pp -The +In the rare case where the compressed content is detached, +pass it in via +.Fa dcont . +For normal use, set .Fa dcont -parameter is used in the rare case where the compressed content is -detached. -It will normally be set to +to .Dv NULL . .Pp The only currently supported compression algorithm is zlib: if the structure indicates the use of any other algorithm, an error is returned. -.Pp -If zlib support is not compiled in, then +If zlib support is not compiled in, .Fn CMS_uncompress -will always return an error. +always returns an error. .Pp If the .Dv CMS_TEXT -flag is set, MIME headers for type text/plain are deleted from the content. +bit is set in +.Fa flags , +MIME headers for type text/plain are deleted from the content. If the content is not of type text/plain, an error is returned. .Sh RETURN VALUES .Fn CMS_uncompress -returns either 1 for success or 0 for failure. +returns 1 for success or 0 for failure. The error can be obtained from .Xr ERR_get_error 3 . .Sh SEE ALSO .Xr CMS_compress 3 +.Sh STANDARDS +RFC 3274: Compressed Data Content Type for Cryptographic Message Syntax (CMS) .Sh HISTORY .Fn CMS_uncompress first appeared in OpenSSL 0.9.8h -- cgit v1.2.3-55-g6feb