root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity
openssl/doc/man3/i2d_PKCS7_bio_stream.pod

54 lines
1.2 KiB
Plaintext
Raw Normal View History

d2i_PKCS7_bio_stream() docs.
2007-04-13 21:22:15 +08:00
=pod
=head1 NAME
More doc nits Update script to look for period or POD markup in NAME section, and fix them. Reviewed-by: Andy Polyakov <appro@openssl.org>
2016-06-06 12:43:05 +08:00
i2d_PKCS7_bio_stream - output PKCS7 structure in BER format
d2i_PKCS7_bio_stream() docs.
2007-04-13 21:22:15 +08:00
=head1 SYNOPSIS
#include <openssl/pkcs7.h>
Correct d2i/i2d typos.
2008-04-09 06:35:32 +08:00
int i2d_PKCS7_bio_stream(BIO *out, PKCS7 *p7, BIO *data, int flags);
d2i_PKCS7_bio_stream() docs.
2007-04-13 21:22:15 +08:00
=head1 DESCRIPTION
Correct d2i/i2d typos.
2008-04-09 06:35:32 +08:00
i2d_PKCS7_bio_stream() outputs a PKCS7 structure in BER format.
d2i_PKCS7_bio_stream() docs.
2007-04-13 21:22:15 +08:00
It is otherwise identical to the function SMIME_write_PKCS7().
=head1 NOTES
This function is effectively a version of the d2i_PKCS7_bio() supporting
streaming.
=head1 BUGS
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-13 06:42:08 +08:00
The prefix "i2d" is arguably wrong because the function outputs BER format.
d2i_PKCS7_bio_stream() docs.
2007-04-13 21:22:15 +08:00
=head1 RETURN VALUES
Correct d2i/i2d typos.
2008-04-09 06:35:32 +08:00
i2d_PKCS7_bio_stream() returns 1 for success or 0 for failure.
d2i_PKCS7_bio_stream() docs.
2007-04-13 21:22:15 +08:00
=head1 SEE ALSO
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-18 03:21:33 +08:00
L<ERR_get_error(3)>, L<PKCS7_sign(3)>,
L<PKCS7_verify(3)>, L<PKCS7_encrypt(3)>
L<PKCS7_decrypt(3)>,
L<SMIME_write_PKCS7(3)>,
L<PEM_write_bio_PKCS7_stream(3)>
d2i_PKCS7_bio_stream() docs.
2007-04-13 21:22:15 +08:00
=head1 HISTORY
man: harmonize the various formulations in the HISTORY sections While stereotyped repetitions are frowned upon in literature, they serve a useful purpose in manual pages, because it is easier for the user to find certain information if it is always presented in the same way. For that reason, this commit harmonizes the varying formulations in the HISTORY section about which functions, flags, etc. were added in which OpenSSL version. It also attempts to make the pod files more grep friendly by avoiding to insert line breaks between the symbol names and the corresponding version number in which they were introduced (wherever possible). Some punctuation and typographical errors were fixed on the way. Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7854)
2018-12-09 08:02:36 +08:00
The i2d_PKCS7_bio_stream() function was added in OpenSSL 1.0.0.
d2i_PKCS7_bio_stream() docs.
2007-04-13 21:22:15 +08:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
=head1 COPYRIGHT
Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved.
Following the license change, modify the boilerplates in doc/man3/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
2018-12-06 21:04:44 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut