Additional updates to SSL_CTX_sess_set_get_cb.pod
[openssl.git] / doc / man3 / OSSL_trace_set_channel.pod
index 773a6b106417f41024a7e375ddd2d233ddac0f70..a4b1d094d1bd3b5e4629eefb29c0daa215b4e403 100644 (file)
@@ -1,5 +1,7 @@
 =pod
 
+=for openssl foreign manual atexit(3)
+
 =head1 NAME
 
 OSSL_trace_set_channel, OSSL_trace_set_prefix, OSSL_trace_set_suffix,
@@ -128,11 +130,11 @@ registered very early with L<atexit(3)>.
 
 =item C<OSSL_TRACE_CATEGORY_TLS>
 
-Traces the TLS/SSL protocoll.
+Traces the TLS/SSL protocol.
 
 =item C<OSSL_TRACE_CATEGORY_TLS_CIPHER>
 
-Traces the ciphers used by the TLS/SSL protocoll.
+Traces the ciphers used by the TLS/SSL protocol.
 
 =item C<OSSL_TRACE_CATEGORY_ENGINE_CONF>
 
@@ -176,11 +178,21 @@ point during evaluation.
 
 Traces BIGNUM context operations.
 
+=item C<OSSL_TRACE_CATEGORY_PROVIDER_CONF>
+
+Traces the OSSL_PROVIDER configuration.
+
 =back
 
-There is also C<OSSL_TRACE_CATEGORY_ANY>, which works as a fallback
+There is also C<OSSL_TRACE_CATEGORY_ALL>, which works as a fallback
 and can be used to get I<all> trace output.
 
+Note, however, that in this case all trace output will effectively be
+associated with the 'ALL' 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.
+
 =head1 RETURN VALUES
 
 OSSL_trace_set_channel(), OSSL_trace_set_prefix(),
@@ -202,7 +214,7 @@ the following:
      BIO_dump(trc_out, bar, sizeof(bar));
  } OSSL_TRACE_END(TLS);
 
-=head1 Simple example
+=head2 Simple example
 
 An example with just a channel and constant prefix / suffix.
 
@@ -287,7 +299,7 @@ functions described here are inoperational, i.e. will do nothing.
 
 OSSL_trace_set_channel(), OSSL_trace_set_prefix(),
 OSSL_trace_set_suffix(), and OSSL_trace_set_callback() were all added
-in OpenSSL 3.0.0.
+in OpenSSL 3.0.
 
 =head1 COPYRIGHT