Add minimum POP3 STLS hack to s_client.c (as was provided for STARTTLS before)

[openssl.git] / doc / apps / s_client.pod

diff --git a/doc/apps/s_client.pod b/doc/apps/s_client.pod
index cd9093eaba25cf9045e7db6d6ea5ff37bea44a32..d061326c1fcaf9784844f9e5f117b9522a091ee5 100644 (file)
--- a/doc/apps/s_client.pod
+++ b/doc/apps/s_client.pod
@@ -18,10 +18,12 @@ B<openssl> B<s_client>
 [B<-pause>]
 [B<-showcerts>]
 [B<-debug>]
 [B<-pause>]
 [B<-showcerts>]
 [B<-debug>]

+[B<-msg>]

 [B<-nbio_test>]
 [B<-state>]
 [B<-nbio>]
 [B<-crlf>]
 [B<-nbio_test>]
 [B<-state>]
 [B<-nbio>]
 [B<-crlf>]

+[B<-ign_eof>]

 [B<-quiet>]
 [B<-ssl2>]
 [B<-ssl3>]
 [B<-quiet>]
 [B<-ssl2>]
 [B<-ssl3>]


@@ -31,6 +33,9 @@ B<openssl> B<s_client>
 [B<-no_tls1>]
 [B<-bugs>]
 [B<-cipher cipherlist>]
 [B<-no_tls1>]
 [B<-bugs>]
 [B<-cipher cipherlist>]

+[B<-starttls protocol>]
+[B<-engine id>]
+[B<-rand file(s)>]

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 


@@ -109,22 +114,32 @@ prints out the SSL session states.
 
 print extensive debugging information including a hex dump of all traffic.
 
 
 print extensive debugging information including a hex dump of all traffic.
 

+=item B<-msg>
+
+show all protocol messages with hex dump.
+

 =item B<-nbio_test>
 
 =item B<-nbio_test>
 

-tests non blocking I/O
+tests non-blocking I/O

 
 =item B<-nbio>
 
 
 =item B<-nbio>
 

-turns on non blocking I/O
+turns on non-blocking I/O

 
 =item B<-crlf>
 
 this option translated a line feed from the terminal into CR+LF as required
 by some servers.
 
 
 =item B<-crlf>
 
 this option translated a line feed from the terminal into CR+LF as required
 by some servers.
 

+=item B<-ign_eof>
+
+inhibit shutting down the connection when end of file is reached in the
+input.
+

 =item B<-quiet>
 
 =item B<-quiet>
 

-inhibit printing of session and certificate information.
+inhibit printing of session and certificate information.  This implicitly
+turns on B<-ign_eof> as well.

 
 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
 
 
 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
 


@@ -144,8 +159,31 @@ option enables various workarounds.
 
 =item B<-cipher cipherlist>
 
 
 =item B<-cipher cipherlist>
 

-this allows the cipher list sent by the client to be modified. See the
-B<ciphers> command for more information.
+this allows the cipher list sent by the client to be modified. Although
+the server determines which cipher suite is used it should take the first
+supported cipher in the list sent by the client. See the B<ciphers>
+command for more information.
+
+=item B<-starttls protocol>
+
+send the protocol-specific message(s) to switch to TLS for communication.
+B<protocol> is a keyword for the intended protocol.  Currently, the only
+supported keywords are "smtp" and "pop3".
+
+=item B<-engine id>
+
+specifying an engine (by it's unique B<id> string) will cause B<s_client>
+to attempt to obtain a functional reference to the specified engine,
+thus initialising it if needed. The engine will then be set as the default
+for all available algorithms.
+
+=item B<-rand file(s)>
+
+a file or files containing random data used to seed the random number
+generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
+Multiple files can be specified separated by a OS-dependent character.
+The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
+all others.

 
 =back
 
 
 =back
 


@@ -153,9 +191,10 @@ B<ciphers> command for more information.
 
 If a connection is established with an SSL server then any data received
 from the server is displayed and any key presses will be sent to the
 
 If a connection is established with an SSL server then any data received
 from the server is displayed and any key presses will be sent to the

-server. If the line begins with an B<R> then the session will be
-renegotiated. If the line begins with a B<Q> the connection will be closed
-down.
+server. When used interactively (which means neither B<-quiet> nor B<-ign_eof>
+have been given), the session will be renegotiated if the line begins with an
+B<R>, and if the line begins with a B<Q> or if end of file is reached, the
+connection will be closed down.

 
 =head1 NOTES
 
 
 =head1 NOTES
 


@@ -206,6 +245,6 @@ information whenever a session is renegotiated.
 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 

-sess_id(1), s_server(1), ciphers(1)
+L<sess_id(1)|sess_id(1)>, L<s_server(1)|s_server(1)>, L<ciphers(1)|ciphers(1)>

 
 =cut
 
 =cut