From ccd9e70d4efeb2c7a258ba0a567b898174286b13 Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Fri, 1 Nov 2019 12:29:34 -0400 Subject: [PATCH] Strip much out of ssl.pod Reviewed-by: Matt Caswell Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/10208) --- doc/man7/ssl.pod | 108 +++++------------------------------------------ 1 file changed, 11 insertions(+), 97 deletions(-) diff --git a/doc/man7/ssl.pod b/doc/man7/ssl.pod index ae40dac084..7aff45c5cc 100644 --- a/doc/man7/ssl.pod +++ b/doc/man7/ssl.pod @@ -10,9 +10,11 @@ See the individual manual pages for details. =head1 DESCRIPTION -The OpenSSL B library implements the Secure Sockets Layer (SSL v2/v3) and -Transport Layer Security (TLS v1) protocols. It provides a rich API which is -documented here. +The OpenSSL B library implements several versions of the +Secure Sockets Layer, Transport Layer Security, and Datagram Transport Layer +Security protocols. +This page gives a brief overview of the extensive API and data types +provided by the library. An B object is created as a framework to establish TLS/SSL enabled connections (see L). @@ -35,8 +37,7 @@ TLS/SSL connection. =head1 DATA STRUCTURES -Currently the OpenSSL B library functions deals with the following data -structures: +Here are some of the main data structures in the library. =over 4 @@ -73,7 +74,6 @@ links to mostly all other structures. =back - =head1 HEADER FILES Currently the OpenSSL B library provides the following C header files @@ -81,115 +81,29 @@ containing the prototypes for the data structures and functions: =over 4 -=item B +=item F<< >> This is the common header file for the SSL/TLS API. Include it into your program to make the API of the B library available. It internally includes both more private SSL headers and headers from the B library. Whenever you need hard-core details on the internals of the SSL API, look inside this header file. +This file also includes the others listed below. -=item B +=item F<< >> Unused. Present for backwards compatibility only. -=item B +=item F<< >> This is the sub header file dealing with the SSLv3 protocol only. -I. -=item B +=item F<< >> This is the sub header file dealing with the TLSv1 protocol only. -I. =back -=head1 SEE ALSO - -L, L, -L, -L, L, -L, -L, -L, -L, -L, -L, -L, -L, -L -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L - =head1 COPYRIGHT Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.