Fix misspelling errors and typos reported by codespell
[openssl.git] / doc / man1 / openssl-sess_id.pod
index 7b5a8f956af03941cc04c5c7f46f6640d7c0ac25..bb49dbd56b760c4c66415121a97cc49f31db6546 100644 (file)
@@ -8,21 +8,25 @@ openssl-sess_id - SSL/TLS session handling utility
 
 B<openssl> B<sess_id>
 [B<-help>]
-[B<-inform PEM|DER>]
-[B<-outform PEM|DER|NSS>]
-[B<-in filename>]
-[B<-out filename>]
+[B<-inform> B<DER>|B<PEM>]
+[B<-outform> B<DER>|B<PEM>|B<NSS>]
+[B<-in> I<filename>]
+[B<-out> I<filename>]
 [B<-text>]
+[B<-cert>]
 [B<-noout>]
-[B<-context ID>]
+[B<-context> I<ID>]
 
 =head1 DESCRIPTION
 
-The B<sess_id> process the encoded version of the SSL session structure
-and optionally prints out SSL session details (for example the SSL session
-master key) in human readable format. Since this is a diagnostic tool that
-needs some knowledge of the SSL protocol to use properly, most users will
-not need to use it.
+This command processes the encoded version of the SSL session
+structure and optionally prints out SSL session details (for example
+the SSL session master key) in human readable format. Since this is a
+diagnostic tool that needs some knowledge of the SSL protocol to use
+properly, most users will not need to use it.
+
+The precise format of the data can vary across OpenSSL versions and
+is not documented.
 
 =head1 OPTIONS
 
@@ -32,25 +36,20 @@ not need to use it.
 
 Print out a usage message.
 
-=item B<-inform DER|PEM>
-
-This specifies the input format. The B<DER> option uses an ASN1 DER encoded
-format containing session details. The precise format can vary from one version
-to the next.  The B<PEM> form is the default format: it consists of the B<DER>
-format base64 encoded with additional header and footer lines.
+=item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>|B<NSS>
 
-=item B<-outform DER|PEM|NSS>
+The input and output formats; the default is PEM.
+See L<openssl(1)/Format Options> for details.
 
-This specifies the output format. The B<PEM> and B<DER> options have the same meaning
-and default as the B<-inform> option. The B<NSS> option outputs the session id and
-the master key in NSS keylog format.
+For B<NSS> output, the session ID and master key are reported in NSS "keylog"
+format.
 
-=item B<-in filename>
+=item B<-in> I<filename>
 
 This specifies the input filename to read session information from or standard
 input by default.
 
-=item B<-out filename>
+=item B<-out> I<filename>
 
 This specifies the output filename to write session information to or standard
 output if this option is not specified.
@@ -69,7 +68,7 @@ if the B<-text> option is also present then it will be printed out in text form.
 
 This option prevents output of the encoded version of the session.
 
-=item B<-context ID>
+=item B<-context> I<ID>
 
 This option can set the session id so the output session information uses the
 supplied ID. The ID can be any string of characters. This option won't normally
@@ -92,7 +91,7 @@ Typical output:
      Timeout   : 300 (sec)
      Verify return code 0 (ok)
 
-Theses are described below in more detail.
+These are described below in more detail.
 
 =over 4
 
@@ -134,11 +133,6 @@ This is the return code when an SSL client certificate is verified.
 
 =head1 NOTES
 
-The PEM encoded session format uses the header and footer lines:
-
- -----BEGIN SSL SESSION PARAMETERS-----
- -----END SSL SESSION PARAMETERS-----
-
 Since the SSL session output contains the master key it is
 possible to read the contents of an encrypted session using this
 information. Therefore appropriate security precautions should be taken if