Merge branch 'master' of git.openssl.org:openssl
[openssl.git] / doc / crypto / CMS_compress.pod
index f2550b4947793d583af32fe0484fb679e247227b..0a0715271d31da8532a0026052264987d535e82a 100644 (file)
@@ -14,7 +14,7 @@ CMS_compress - create a CMS CompressedData structure
 
 CMS_compress() creates and returns a CMS CompressedData structure. B<comp_nid>
 is the compression algorithm to use or B<NID_undef> to use the default
-algorithms (zlib compression). B<in> is the content to be compressed.
+algorithm (zlib compression). B<in> is the content to be compressed.
 B<flags> is an optional set of flags.
 
 =head1 NOTES
@@ -22,7 +22,7 @@ B<flags> is an optional set of flags.
 The only currently supported compression algorithm is zlib using the NID
 NID_zlib_compression.
 
-If zlib support is not compiled into OpenSSL this CMS_compress() will return
+If zlib support is not compiled into OpenSSL then CMS_compress() will return
 an error.
 
 If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are
@@ -53,6 +53,9 @@ PEM_write_bio_CMS_stream() finalize the structure. Alternatively finalization
 can be performed by obtaining the streaming ASN1 B<BIO> directly using
 BIO_new_CMS().
 
+Additional compression parameters such as the zlib compression level cannot
+currently be set.
+
 =head1 RETURN VALUES
 
 CMS_compress() returns either a CMS_ContentInfo structure or NULL if an error
@@ -65,6 +68,6 @@ L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_uncompress(3)|CMS_uncompress(3)>
 =head1 HISTORY
 
 CMS_compress() was added to OpenSSL 0.9.8
-The B<CMS_STREAM> flag was first supported in OpenSSL 0.9.9.
+The B<CMS_STREAM> flag was first supported in OpenSSL 1.0.0.
 
 =cut