Command docs: replacables are in italics, options always start with a dash

[openssl.git] / doc / man1 / openssl-s_time.pod

diff --git a/doc/man1/openssl-s_time.pod b/doc/man1/openssl-s_time.pod
index 8a4f89fbc9b6ae4f9d44deabe5bb7f5fed7581dc..bc019039868f41ecad03948751f4c409953cdbcf 100644 (file)
--- a/doc/man1/openssl-s_time.pod
+++ b/doc/man1/openssl-s_time.pod
@@ -8,23 +8,29 @@ openssl-s_time - SSL/TLS performance timing program
 
 B<openssl> B<s_time>
 [B<-help>]
 
 B<openssl> B<s_time>
 [B<-help>]

-[B<-connect host:port>]
-[B<-www page>]
-[B<-cert filename>]
-[B<-key filename>]
-[B<-CApath directory>]
-[B<-cafile filename>]
+[B<-connect> I<host>:I<port>]
+[B<-www> I<page>]
+[B<-cert> I<filename>]
+[B<-key> I<filename>]
+[B<-CApath> I<directory>]
+[B<-cafile> I<filename>]

 [B<-no-CAfile>]
 [B<-no-CApath>]
 [B<-reuse>]
 [B<-new>]
 [B<-no-CAfile>]
 [B<-no-CApath>]
 [B<-reuse>]
 [B<-new>]

-[B<-verify depth>]
-[B<-nameopt option>]
-[B<-time seconds>]
+[B<-verify> I<depth>]
+[B<-nameopt> I<option>]
+[B<-time> I<seconds>]

 [B<-ssl3>]
 [B<-ssl3>]

+[B<-tls1>]
+[B<-tls1_1>]
+[B<-tls1_2>]
+[B<-tls1_3>]

 [B<-bugs>]
 [B<-bugs>]

-[B<-cipher cipherlist>]
-[B<-ciphersuites val>]
+[B<-cipher> I<cipherlist>]
+[B<-ciphersuites> I<val>]
+
+=for comment ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 


@@ -42,28 +48,28 @@ transferred (if any), and calculates the average time spent for one connection.
 
 Print out a usage message.
 
 
 Print out a usage message.
 

-=item B<-connect host:port>
+=item B<-connect> I<host>:I<port>

 
 This specifies the host and optional port to connect to.
 
 
 This specifies the host and optional port to connect to.
 

-=item B<-www page>
+=item B<-www> I<page>

 
 This specifies the page to GET from the server. A value of '/' gets the
 index.htm[l] page. If this parameter is not specified, then B<s_time> will only
 perform the handshake to establish SSL connections but not transfer any
 payload data.
 
 
 This specifies the page to GET from the server. A value of '/' gets the
 index.htm[l] page. If this parameter is not specified, then B<s_time> will only
 perform the handshake to establish SSL connections but not transfer any
 payload data.
 

-=item B<-cert certname>
+=item B<-cert> I<certname>

 
 The certificate to use, if one is requested by the server. The default is
 not to use a certificate. The file is in PEM format.
 
 
 The certificate to use, if one is requested by the server. The default is
 not to use a certificate. The file is in PEM format.
 

-=item B<-key keyfile>
+=item B<-key> I<keyfile>

 
 The private key to use. If not specified then the certificate file will
 be used. The file is in PEM format.
 
 
 The private key to use. If not specified then the certificate file will
 be used. The file is in PEM format.
 

-=item B<-verify depth>
+=item B<-verify> I<depth>

 
 The verify depth to use. This specifies the maximum length of the
 server certificate chain and turns on server certificate verification.
 
 The verify depth to use. This specifies the maximum length of the
 server certificate chain and turns on server certificate verification.


@@ -71,20 +77,20 @@ Currently the verify operation continues after errors so all the problems
 with a certificate chain can be seen. As a side effect the connection
 will never fail due to a server certificate verify failure.
 
 with a certificate chain can be seen. As a side effect the connection
 will never fail due to a server certificate verify failure.
 

-=item B<-nameopt option>
+=item B<-nameopt> I<option>

 
 Option which determines how the subject or issuer names are displayed. The
 
 Option which determines how the subject or issuer names are displayed. The

-B<option> argument can be a single option or multiple options separated by
+I<option> argument can be a single option or multiple options separated by

 commas.  Alternatively the B<-nameopt> switch may be used more than once to
 set multiple options. See the L<x509(1)> manual page for details.
 
 commas.  Alternatively the B<-nameopt> switch may be used more than once to
 set multiple options. See the L<x509(1)> manual page for details.
 

-=item B<-CApath directory>
+=item B<-CApath> I<directory>

 
 The directory to use for server certificate verification. This directory
 must be in "hash format", see B<verify> for more information. These are
 also used when building the client certificate chain.
 
 
 The directory to use for server certificate verification. This directory
 must be in "hash format", see B<verify> for more information. These are
 also used when building the client certificate chain.
 

-=item B<-CAfile file>
+=item B<-CAfile> I<file>

 
 A file containing trusted certificates to use during server authentication
 and to use when attempting to build the client certificate chain.
 
 A file containing trusted certificates to use during server authentication
 and to use when attempting to build the client certificate chain.


@@ -109,19 +115,13 @@ Performs the timing test using the same session ID; this can be used as a test
 that session caching is working. If neither B<-new> nor B<-reuse> are
 specified, they are both on by default and executed in sequence.
 
 that session caching is working. If neither B<-new> nor B<-reuse> are
 specified, they are both on by default and executed in sequence.
 

-=item B<-ssl3>
-
-This option disables the use of SSL version 3. By default
-the initial handshake uses a method which should be compatible with all
-servers and permit them to use SSL v3 or TLS as appropriate.
-
-The timing program is not as rich in options to turn protocols on and off as
-the L<s_client(1)> program and may not connect to all servers.
-Unfortunately there are a lot of ancient and broken servers in use which
-cannot handle this technique and will fail to connect. Some servers only
-work if TLS is turned off with the B<-ssl3> option.
+=item B<-ssl3>, B<-tls1>, B<-tls1_1>, B<-tls1_2>, B<-tls1_3>

 
 

-Note that this option may not be available, depending on how
+These options enable specific SSL or TLS protocol versions for the handshake
+initiated by B<s_time>.
+By default B<s_time> negotiates the highest mutually supported protocol
+version.
+Note that not all protocols and flags may be available, depending on how

 OpenSSL was built.
 
 =item B<-bugs>
 OpenSSL was built.
 
 =item B<-bugs>


@@ -129,7 +129,7 @@ OpenSSL was built.
 There are several known bugs in SSL and TLS implementations. Adding this
 option enables various workarounds.
 
 There are several known bugs in SSL and TLS implementations. Adding this
 option enables various workarounds.
 

-=item B<-cipher cipherlist>
+=item B<-cipher> I<cipherlist>

 
 This allows the TLSv1.2 and below cipher list sent by the client to be modified.
 This list will be combined with any TLSv1.3 ciphersuites that have been
 
 This allows the TLSv1.2 and below cipher list sent by the client to be modified.
 This list will be combined with any TLSv1.3 ciphersuites that have been


@@ -137,7 +137,7 @@ configured. Although the server determines which cipher suite is used it should
 take the first supported cipher in the list sent by the client. See
 L<ciphers(1)> for more information.
 
 take the first supported cipher in the list sent by the client. See
 L<ciphers(1)> for more information.
 

-=item B<-ciphersuites val>
+=item B<-ciphersuites> I<val>

 
 This allows the TLSv1.3 ciphersuites sent by the client to be modified. This
 list will be combined with any TLSv1.2 and below ciphersuites that have been
 
 This allows the TLSv1.3 ciphersuites sent by the client to be modified. This
 list will be combined with any TLSv1.2 and below ciphersuites that have been


@@ -146,7 +146,7 @@ take the first supported cipher in the list sent by the client. See
 L<ciphers(1)> for more information. The format for this list is a simple
 colon (":") separated list of TLSv1.3 ciphersuite names.
 
 L<ciphers(1)> for more information. The format for this list is a simple
 colon (":") separated list of TLSv1.3 ciphersuite names.
 

-=item B<-time length>
+=item B<-time> I<length>

 
 Specifies how long (in seconds) B<s_time> should establish connections and
 optionally transfer payload data from a server. Server and client performance
 
 Specifies how long (in seconds) B<s_time> should establish connections and
 optionally transfer payload data from a server. Server and client performance


@@ -161,7 +161,7 @@ To connect to an SSL HTTP server and get the default page the command
 
  openssl s_time -connect servername:443 -www / -CApath yourdir -CAfile yourfile.pem -cipher commoncipher [-ssl3]
 
 
  openssl s_time -connect servername:443 -www / -CApath yourdir -CAfile yourfile.pem -cipher commoncipher [-ssl3]
 

-would typically be used (https uses port 443). 'commoncipher' is a cipher to
+would typically be used (https uses port 443). I<commoncipher> is a cipher to

 which both client and server can agree, see the L<ciphers(1)> command
 for details.
 
 which both client and server can agree, see the L<ciphers(1)> command
 for details.