diff options
| author | schwarze <> | 2015-02-16 16:42:14 +0000 |
|---|---|---|
| committer | schwarze <> | 2015-02-16 16:42:14 +0000 |
| commit | 9a3026fb0a89a15ea2def3629cc13a69f1fc678c (patch) | |
| tree | 28ac935f3dd22b133413a78861848f9501389a34 /src/lib/libcrypto/man/BIO_s_null.3 | |
| parent | 4ab59c54f9da1075f740a1004c326b0784ed4de0 (diff) | |
| download | openbsd-9a3026fb0a89a15ea2def3629cc13a69f1fc678c.tar.gz openbsd-9a3026fb0a89a15ea2def3629cc13a69f1fc678c.tar.bz2 openbsd-9a3026fb0a89a15ea2def3629cc13a69f1fc678c.zip | |
third batch of perlpod(1) to mdoc(7) conversion
Diffstat (limited to 'src/lib/libcrypto/man/BIO_s_null.3')
| -rw-r--r-- | src/lib/libcrypto/man/BIO_s_null.3 | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/BIO_s_null.3 b/src/lib/libcrypto/man/BIO_s_null.3 new file mode 100644 index 0000000000..05008aabfc --- /dev/null +++ b/src/lib/libcrypto/man/BIO_s_null.3 | |||
| @@ -0,0 +1,32 @@ | |||
| 1 | .Dd $Mdocdate: February 16 2015 $ | ||
| 2 | .Dt BIO_S_NULL 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm BIO_s_null | ||
| 6 | .Nd null data sink | ||
| 7 | .Sh SYNOPSIS | ||
| 8 | .In openssl/bio.h | ||
| 9 | .Ft BIO_METHOD * | ||
| 10 | .Fo BIO_s_null | ||
| 11 | .Fa void | ||
| 12 | .Fc | ||
| 13 | .Sh DESCRIPTION | ||
| 14 | .Fn BIO_s_null | ||
| 15 | returns the null sink BIO method. | ||
| 16 | Data written to the null sink is discarded, reads return EOF. | ||
| 17 | .Sh NOTES | ||
| 18 | A null sink BIO behaves in a similar manner to the | ||
| 19 | .Xr null 4 | ||
| 20 | device. | ||
| 21 | .Pp | ||
| 22 | A null bio can be placed on the end of a chain to discard any data | ||
| 23 | passed through it. | ||
| 24 | .Pp | ||
| 25 | A null sink is useful if, for example, an application wishes | ||
| 26 | to digest some data by writing through a digest bio | ||
| 27 | but not send the digested data anywhere. | ||
| 28 | Since a BIO chain must normally include a source/sink BIO, | ||
| 29 | this can be achieved by adding a null sink BIO to the end of the chain. | ||
| 30 | .Sh RETURN VALUES | ||
| 31 | .Fn BIO_s_null | ||
| 32 | returns the null sink BIO method. | ||
