diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 b/secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 index 5f761e19d9af..553a909c94e8 100644 --- a/secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 +++ b/secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 @@ -1,5 +1,5 @@ .\" -*- mode: troff; coding: utf-8 -*- -.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -52,10 +52,13 @@ . \} .\} .rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l .\" ======================================================================== .\" .IX Title "OSSL_TRACE_SET_CHANNEL 3ossl" -.TH OSSL_TRACE_SET_CHANNEL 3ossl 2025-09-30 3.5.4 OpenSSL +.TH OSSL_TRACE_SET_CHANNEL 3ossl 2026-04-07 3.5.6 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -84,7 +87,7 @@ This output comes in form of free text for humans to read. .PP The trace output is divided into categories which can be enabled individually. -Every category can be enabled individually by attaching a so-called +Every category can be enabled individually by attaching a so\-called \&\fItrace channel\fR to it, which in the simplest case is just a BIO object to which the application can write the tracing output for this category. Alternatively, the application can provide a tracer callback in order to @@ -98,7 +101,7 @@ respectively. \&\fBOSSL_TRACE_ENABLED\fR\|(3) can be used to check whether tracing is currently enabled for the given category. Functions like \fBOSSL_TRACE1\fR\|(3) and macros like \fBOSSL_TRACE_BEGIN\fR\|(3) -can be used for producing free-text trace output. +can be used for producing free\-text trace output. .SS Functions .IX Subsection "Functions" \&\fBOSSL_trace_set_channel()\fR is used to enable the given trace \f(CW\*(C`category\*(C'\fR @@ -118,11 +121,11 @@ tracing prefixes, consider setting a callback with \&\fBOSSL_trace_set_callback()\fR is used to enable the given trace \&\fIcategory\fR by giving it the tracer callback \fIcb\fR with the associated data \fIdata\fR, which will simply be passed through to \fIcb\fR whenever -it's called. The callback function is internally wrapped by a -dedicated BIO object, the so-called \fIcallback trace channel\fR. -This should be used when it's desirable to do form the trace output to +it\*(Aqs called. The callback function is internally wrapped by a +dedicated BIO object, the so\-called \fIcallback trace channel\fR. +This should be used when it\*(Aqs desirable to do form the trace output to something suitable for application needs where a prefix and suffix -line aren't enough. +line aren\*(Aqt enough. .PP \&\fBOSSL_trace_set_channel()\fR and \fBOSSL_trace_set_callback()\fR are mutually exclusive, calling one of them will clear whatever was set by the @@ -175,7 +178,7 @@ This needs special care, as OpenSSL will do automatic cleanup after exit from \f(CWmain()\fR, and any tracing output done during this cleanup will be lost if the tracing channel or callback were cleaned away prematurely. -A suggestion is to make such cleanup part of a function that's +A suggestion is to make such cleanup part of a function that\*(Aqs registered very early with \fBatexit\fR\|(3). .IP \fBOSSL_TRACE_CATEGORY_TLS\fR 4 .IX Item "OSSL_TRACE_CATEGORY_TLS" @@ -241,7 +244,7 @@ There is also \fBOSSL_TRACE_CATEGORY_ALL\fR, which works as a fallback and can be used to get \fIall\fR trace output. .PP Note, however, that in this case all trace output will effectively be -associated with the 'ALL' category, which is undesirable if the +associated with the \*(AqALL\*(Aq category, which is undesirable if the application intends to include the category name in the trace output. In this case it is better to register separate channels for each trace category instead. @@ -347,7 +350,7 @@ The output is almost the same as for the simple example above. .IX Subsection "Configure Tracing" By default, the OpenSSL library is built with tracing disabled. To use the tracing functionality documented here, it is therefore -necessary to configure and build OpenSSL with the 'enable\-trace' option. +necessary to configure and build OpenSSL with the \*(Aqenable\-trace\*(Aq option. .PP When the library is built with tracing disabled, the macro \&\fBOPENSSL_NO_TRACE\fR is defined in \fI<openssl/opensslconf.h>\fR and all |