diff options
Diffstat (limited to 'secure/lib/libcrypto/man/BIO_set_callback.3')
| -rw-r--r-- | secure/lib/libcrypto/man/BIO_set_callback.3 | 48 |
1 files changed, 26 insertions, 22 deletions
diff --git a/secure/lib/libcrypto/man/BIO_set_callback.3 b/secure/lib/libcrypto/man/BIO_set_callback.3 index 347f585e943de..1d62b22819af6 100644 --- a/secure/lib/libcrypto/man/BIO_set_callback.3 +++ b/secure/lib/libcrypto/man/BIO_set_callback.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} . \} .\} +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "BIO_SET_CALLBACK 3" -.TH BIO_SET_CALLBACK 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH BIO_SET_CALLBACK 3 "2019-02-26" "1.1.1b" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -160,25 +164,25 @@ BIO_set_callback_ex, BIO_get_callback_ex, BIO_set_callback, BIO_get_callback, BI .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" -\&\fIBIO_set_callback_ex()\fR and \fIBIO_get_callback_ex()\fR set and retrieve the \s-1BIO\s0 +\&\fBBIO_set_callback_ex()\fR and \fBBIO_get_callback_ex()\fR set and retrieve the \s-1BIO\s0 callback. The callback is called during most high level \s-1BIO\s0 operations. It can be used for debugging purposes to trace operations on a \s-1BIO\s0 or to modify its operation. .PP -\&\fIBIO_set_callback()\fR and \fIBIO_get_callback()\fR set and retrieve the old format \s-1BIO\s0 +\&\fBBIO_set_callback()\fR and \fBBIO_get_callback()\fR set and retrieve the old format \s-1BIO\s0 callback. New code should not use these functions, but they are retained for -backwards compatibility. Any callback set via \fIBIO_set_callback_ex()\fR will get -called in preference to any set by \fIBIO_set_callback()\fR. +backwards compatibility. Any callback set via \fBBIO_set_callback_ex()\fR will get +called in preference to any set by \fBBIO_set_callback()\fR. .PP -\&\fIBIO_set_callback_arg()\fR and \fIBIO_get_callback_arg()\fR are macros which can be +\&\fBBIO_set_callback_arg()\fR and \fBBIO_get_callback_arg()\fR are macros which can be used to set and retrieve an argument for use in the callback. .PP -\&\fIBIO_debug_callback()\fR is a standard debugging callback which prints +\&\fBBIO_debug_callback()\fR is a standard debugging callback which prints out information relating to each \s-1BIO\s0 operation. If the callback argument is set it is interpreted as a \s-1BIO\s0 to send the information to, otherwise stderr is used. .PP -\&\fIBIO_callback_fn_ex()\fR is the type of the callback function and \fIBIO_callback_fn()\fR +\&\fBBIO_callback_fn_ex()\fR is the type of the callback function and \fBBIO_callback_fn()\fR is the type of the old format callback function. The meaning of each argument is described below: .IP "\fBb\fR" 4 @@ -365,18 +369,18 @@ argument of type \fBBIO_info_cb\fR itself. In this case \fBparg\fR is a pointer the actual call parameter, see \fBBIO_callback_ctrl\fR. .SH "EXAMPLE" .IX Header "EXAMPLE" -The \fIBIO_debug_callback()\fR function is a good example, its source is +The \fBBIO_debug_callback()\fR function is a good example, its source is in crypto/bio/bio_cb.c .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fIBIO_get_callback_ex()\fR and \fIBIO_get_callback()\fR return the callback function -previously set by a call to \fIBIO_set_callback_ex()\fR and \fIBIO_set_callback()\fR +\&\fBBIO_get_callback_ex()\fR and \fBBIO_get_callback()\fR return the callback function +previously set by a call to \fBBIO_set_callback_ex()\fR and \fBBIO_set_callback()\fR respectively. .PP -\&\fIBIO_get_callback_arg()\fR returns a \fBchar\fR pointer to the value previously set -via a call to \fIBIO_set_callback_arg()\fR. +\&\fBBIO_get_callback_arg()\fR returns a \fBchar\fR pointer to the value previously set +via a call to \fBBIO_set_callback_arg()\fR. .PP -\&\fIBIO_debug_callback()\fR returns 1 or \fBret\fR if it's called after specific \s-1BIO\s0 +\&\fBBIO_debug_callback()\fR returns 1 or \fBret\fR if it's called after specific \s-1BIO\s0 operations. .SH "COPYRIGHT" .IX Header "COPYRIGHT" |