diff options
author | schwarze <> | 2017-01-06 03:45:57 +0000 |
---|---|---|
committer | schwarze <> | 2017-01-06 03:45:57 +0000 |
commit | 3245fd539b2978123fa1c26c31c3786993be1511 (patch) | |
tree | a9ee34bc45b39caa24ba7947dbe5b440f64581c6 /src | |
parent | 341dd31326deb091bd6e788775bc8054ffb651c5 (diff) | |
download | openbsd-3245fd539b2978123fa1c26c31c3786993be1511.tar.gz openbsd-3245fd539b2978123fa1c26c31c3786993be1511.tar.bz2 openbsd-3245fd539b2978123fa1c26c31c3786993be1511.zip |
Delete a cross reference to the non-existent manual page BIO_set_flags(3),
reported by jmc@. Documenting that function would be a bad idea. All
other flags are used internally and should better not be tampered with.
It looks like an internal function that was made public by mistake,
then abused for an unrelated user interface purpose: a classic case
of botched user interface design.
Instead, only show how to use this function for this one specific purpose.
While here, delete a sentence from the DESCRIPTION that merely
duplicated content from the BUGS section.
Diffstat (limited to 'src')
-rw-r--r-- | src/lib/libcrypto/man/BIO_f_base64.3 | 19 |
1 files changed, 8 insertions, 11 deletions
diff --git a/src/lib/libcrypto/man/BIO_f_base64.3 b/src/lib/libcrypto/man/BIO_f_base64.3 index c1bc926b22..a3bf74c4fe 100644 --- a/src/lib/libcrypto/man/BIO_f_base64.3 +++ b/src/lib/libcrypto/man/BIO_f_base64.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: BIO_f_base64.3,v 1.6 2016/12/06 14:45:08 schwarze Exp $ | 1 | .\" $OpenBSD: BIO_f_base64.3,v 1.7 2017/01/06 03:45:57 schwarze Exp $ |
2 | .\" OpenSSL fc1d88f0 Wed Jul 2 22:42:40 2014 -0400 | 2 | .\" OpenSSL fc1d88f0 Wed Jul 2 22:42:40 2014 -0400 |
3 | .\" | 3 | .\" |
4 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. | 4 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. |
@@ -49,7 +49,7 @@ | |||
49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
51 | .\" | 51 | .\" |
52 | .Dd $Mdocdate: December 6 2016 $ | 52 | .Dd $Mdocdate: January 6 2017 $ |
53 | .Dt BIO_F_BASE64 3 | 53 | .Dt BIO_F_BASE64 3 |
54 | .Os | 54 | .Os |
55 | .Sh NAME | 55 | .Sh NAME |
@@ -78,15 +78,12 @@ on a base64 BIO that is being written through | |||
78 | is used to signal that no more data is to be encoded: | 78 | is used to signal that no more data is to be encoded: |
79 | this is used to flush the final block through the BIO. | 79 | this is used to flush the final block through the BIO. |
80 | .Pp | 80 | .Pp |
81 | The flag | 81 | To encode the data all on one line and to expect the data to be all |
82 | .Dv BIO_FLAGS_BASE64_NO_NL | 82 | on one line, initialize the base64 BIO as follows: |
83 | can be set with | 83 | .Bd -literal -offset indent |
84 | .Xr BIO_set_flags 3 | 84 | BIO *b64 = BIO_new(BIO_f_base64()); |
85 | to encode the data all on one line | 85 | BIO_set_flags(b64, BIO_FLAGS_BASE64_NO_NL); |
86 | or expect the data to be all on one line. | 86 | .Ed |
87 | .Pp | ||
88 | Because of the format of base64 encoding the end of the encoded | ||
89 | block cannot always be reliably determined. | ||
90 | .Sh RETURN VALUES | 87 | .Sh RETURN VALUES |
91 | .Fn BIO_f_base64 | 88 | .Fn BIO_f_base64 |
92 | returns the base64 BIO method. | 89 | returns the base64 BIO method. |