upd: openssl to 1.1.0

[cassiopeia.git] / lib / openssl / doc / apps / openssl.pod

diff --git a/lib/openssl/doc/apps/openssl.pod b/lib/openssl/doc/apps/openssl.pod
index 64a160c20a406fc450e3bd0babb4763bab70e6ef..3014bb31c7bfc6efff82a388b59bffce92ac6955 100644 (file)
--- a/lib/openssl/doc/apps/openssl.pod
+++ b/lib/openssl/doc/apps/openssl.pod
@@ -1,4 +1,3 @@
-

 =pod
 
 =head1 NAME
 =pod
 
 =head1 NAME


@@ -12,7 +11,7 @@ I<command>
 [ I<command_opts> ]
 [ I<command_args> ]
 
 [ I<command_opts> ]
 [ I<command_args> ]
 

-B<openssl> [ B<list-standard-commands> | B<list-message-digest-commands> | B<list-cipher-commands> | B<list-cipher-algorithms> | B<list-message-digest-algorithms> | B<list-public-key-algorithms>]
+B<openssl> B<list> [ B<standard-commands> | B<digest-commands> | B<cipher-commands> | B<cipher-algorithms> | B<digest-algorithms> | B<public-key-algorithms>]

 
 B<openssl> B<no->I<XXX> [ I<arbitrary options> ]
 
 
 B<openssl> B<no->I<XXX> [ I<arbitrary options> ]
 


@@ -23,12 +22,12 @@ v2/v3) and Transport Layer Security (TLS v1) network protocols and related
 cryptography standards required by them.
 
 The B<openssl> program is a command line tool for using the various
 cryptography standards required by them.
 
 The B<openssl> program is a command line tool for using the various

-cryptography functions of OpenSSL's B<crypto> library from the shell. 
-It can be used for 
+cryptography functions of OpenSSL's B<crypto> library from the shell.
+It can be used for

 
  o  Creation and management of private keys, public keys and parameters
  o  Public key cryptographic operations
 
  o  Creation and management of private keys, public keys and parameters
  o  Public key cryptographic operations

- o  Creation of X.509 certificates, CSRs and CRLs 
+ o  Creation of X.509 certificates, CSRs and CRLs

  o  Calculation of Message Digests
  o  Encryption and Decryption with Ciphers
  o  SSL/TLS Client and Server Tests
  o  Calculation of Message Digests
  o  Encryption and Decryption with Ciphers
  o  SSL/TLS Client and Server Tests


@@ -41,20 +40,20 @@ The B<openssl> program provides a rich variety of commands (I<command> in the
 SYNOPSIS above), each of which often has a wealth of options and arguments
 (I<command_opts> and I<command_args> in the SYNOPSIS).
 
 SYNOPSIS above), each of which often has a wealth of options and arguments
 (I<command_opts> and I<command_args> in the SYNOPSIS).
 

-The pseudo-commands B<list-standard-commands>, B<list-message-digest-commands>,
-and B<list-cipher-commands> output a list (one entry per line) of the names
+The list parameters B<standard-commands>, B<digest-commands>,
+and B<cipher-commands> output a list (one entry per line) of the names

 of all standard commands, message digest commands, or cipher commands,
 respectively, that are available in the present B<openssl> utility.
 
 of all standard commands, message digest commands, or cipher commands,
 respectively, that are available in the present B<openssl> utility.
 

-The pseudo-commands B<list-cipher-algorithms> and
-B<list-message-digest-algorithms> list all cipher and message digest names, one entry per line. Aliases are listed as:
+The list parameters B<cipher-algorithms> and
+B<digest-algorithms> list all cipher and message digest names, one entry per line. Aliases are listed as:

 
  from => to
 
 
  from => to
 

-The pseudo-command B<list-public-key-algorithms> lists all supported public
+The list parameter B<public-key-algorithms> lists all supported public

 key algorithms.
 
 key algorithms.
 

-The pseudo-command B<no->I<XXX> tests whether a command of the
+The command B<no->I<XXX> tests whether a command of the

 specified name is available.  If no command named I<XXX> exists, it
 returns 0 (success) and prints B<no->I<XXX>; otherwise it returns 1
 and prints I<XXX>.  In both cases, the output goes to B<stdout> and
 specified name is available.  If no command named I<XXX> exists, it
 returns 0 (success) and prints B<no->I<XXX>; otherwise it returns 1
 and prints I<XXX>.  In both cases, the output goes to B<stdout> and


@@ -63,9 +62,9 @@ are always ignored.  Since for each cipher there is a command of the
 same name, this provides an easy way for shell scripts to test for the
 availability of ciphers in the B<openssl> program.  (B<no->I<XXX> is
 not able to detect pseudo-commands such as B<quit>,
 same name, this provides an easy way for shell scripts to test for the
 availability of ciphers in the B<openssl> program.  (B<no->I<XXX> is
 not able to detect pseudo-commands such as B<quit>,

-B<list->I<...>B<-commands>, or B<no->I<XXX> itself.)
+B<list>, or B<no->I<XXX> itself.)

 
 

-=head2 STANDARD COMMANDS
+=head2 Standard Commands

 
 =over 10
 
 
 =over 10
 


@@ -75,7 +74,7 @@ Parse an ASN.1 sequence.
 
 =item L<B<ca>|ca(1)>
 
 
 =item L<B<ca>|ca(1)>
 

-Certificate Authority (CA) Management.  
+Certificate Authority (CA) Management.

 
 =item L<B<ciphers>|ciphers(1)>
 
 
 =item L<B<ciphers>|ciphers(1)>
 


@@ -104,7 +103,7 @@ Obsoleted by L<B<dhparam>|dhparam(1)>.
 
 =item L<B<dhparam>|dhparam(1)>
 
 
 =item L<B<dhparam>|dhparam(1)>
 

-Generation and Management of Diffie-Hellman Parameters. Superseded by 
+Generation and Management of Diffie-Hellman Parameters. Superseded by

 L<B<genpkey>|genpkey(1)> and L<B<pkeyparam>|pkeyparam(1)>
 
 
 L<B<genpkey>|genpkey(1)> and L<B<pkeyparam>|pkeyparam(1)>
 
 


@@ -114,7 +113,7 @@ DSA Data Management.
 
 =item L<B<dsaparam>|dsaparam(1)>
 
 
 =item L<B<dsaparam>|dsaparam(1)>
 

-DSA Parameter Generation and Management. Superseded by 
+DSA Parameter Generation and Management. Superseded by

 L<B<genpkey>|genpkey(1)> and L<B<pkeyparam>|pkeyparam(1)>
 
 =item L<B<ec>|ec(1)>
 L<B<genpkey>|genpkey(1)> and L<B<pkeyparam>|pkeyparam(1)>
 
 =item L<B<ec>|ec(1)>


@@ -131,7 +130,7 @@ Encoding with Ciphers.
 
 =item L<B<engine>|engine(1)>
 
 
 =item L<B<engine>|engine(1)>
 

-Engine (loadble module) information and manipulation.
+Engine (loadable module) information and manipulation.

 
 =item L<B<errstr>|errstr(1)>
 
 
 =item L<B<errstr>|errstr(1)>
 


@@ -144,7 +143,7 @@ Obsoleted by L<B<dhparam>|dhparam(1)>.
 
 =item L<B<gendsa>|gendsa(1)>
 
 
 =item L<B<gendsa>|gendsa(1)>
 

-Generation of DSA Private Key from Parameters. Superseded by 
+Generation of DSA Private Key from Parameters. Superseded by

 L<B<genpkey>|genpkey(1)> and L<B<pkey>|pkey(1)>
 
 =item L<B<genpkey>|genpkey(1)>
 L<B<genpkey>|genpkey(1)> and L<B<pkey>|pkey(1)>
 
 =item L<B<genpkey>|genpkey(1)>


@@ -153,11 +152,11 @@ Generation of Private Key or Parameters.
 
 =item L<B<genrsa>|genrsa(1)>
 
 
 =item L<B<genrsa>|genrsa(1)>
 

-Generation of RSA Private Key. Superceded by L<B<genpkey>|genpkey(1)>.
+Generation of RSA Private Key. Superseded by L<B<genpkey>|genpkey(1)>.

 
 =item L<B<nseq>|nseq(1)>
 
 
 =item L<B<nseq>|nseq(1)>
 

-Create or examine a netscape certificate sequence
+Create or examine a Netscape certificate sequence

 
 =item L<B<ocsp>|ocsp(1)>
 
 
 =item L<B<ocsp>|ocsp(1)>
 


@@ -259,7 +258,7 @@ X.509 Certificate Data Management.
 
 =back
 
 
 =back
 

-=head2 MESSAGE DIGEST COMMANDS
+=head2 Message Digest Commands

 
 =over 10
 
 
 =over 10
 


@@ -279,11 +278,11 @@ MDC2 Digest
 
 RMD-160 Digest
 
 
 RMD-160 Digest
 

-=item B<sha>            
+=item B<sha>

 
 SHA Digest
 
 
 SHA Digest
 

-=item B<sha1>           
+=item B<sha1>

 
 SHA-1 Digest
 
 
 SHA-1 Digest
 


@@ -305,7 +304,7 @@ SHA-512 Digest
 
 =back
 
 
 =back
 

-=head2 ENCODING AND CIPHER COMMANDS
+=head2 Encoding and Cipher Commands

 
 =over 10
 
 
 =over 10
 


@@ -351,7 +350,22 @@ RC5 Cipher
 
 =back
 
 
 =back
 

-=head1 PASS PHRASE ARGUMENTS
+=head1 COMMAND OPTIONS
+
+Details of which options are available depend on the specific command.
+This section describes some common options with common behavior.
+
+=head2 Common Options
+
+=over 10
+
+=item B<-help>
+
+Provides a terse summary of all options.
+
+=back
+
+=head2 Pass Phrase Options

 
 Several commands accept password arguments, typically using B<-passin>
 and B<-passout> for input and output passwords respectively. These allow
 
 Several commands accept password arguments, typically using B<-passin>
 and B<-passout> for input and output passwords respectively. These allow


@@ -396,27 +410,33 @@ read the password from standard input.
 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 

-L<asn1parse(1)|asn1parse(1)>, L<ca(1)|ca(1)>, L<config(5)|config(5)>,
-L<crl(1)|crl(1)>, L<crl2pkcs7(1)|crl2pkcs7(1)>, L<dgst(1)|dgst(1)>,
-L<dhparam(1)|dhparam(1)>, L<dsa(1)|dsa(1)>, L<dsaparam(1)|dsaparam(1)>,
-L<enc(1)|enc(1)>, L<gendsa(1)|gendsa(1)>, L<genpkey(1)|genpkey(1)>,
-L<genrsa(1)|genrsa(1)>, L<nseq(1)|nseq(1)>, L<openssl(1)|openssl(1)>,
-L<passwd(1)|passwd(1)>,
-L<pkcs12(1)|pkcs12(1)>, L<pkcs7(1)|pkcs7(1)>, L<pkcs8(1)|pkcs8(1)>,
-L<rand(1)|rand(1)>, L<req(1)|req(1)>, L<rsa(1)|rsa(1)>,
-L<rsautl(1)|rsautl(1)>, L<s_client(1)|s_client(1)>,
-L<s_server(1)|s_server(1)>, L<s_time(1)|s_time(1)>,
-L<smime(1)|smime(1)>, L<spkac(1)|spkac(1)>,
-L<verify(1)|verify(1)>, L<version(1)|version(1)>, L<x509(1)|x509(1)>,
-L<crypto(3)|crypto(3)>, L<ssl(3)|ssl(3)>, L<x509v3_config(5)|x509v3_config(5)> 
+L<asn1parse(1)>, L<ca(1)>, L<config(5)>,
+L<crl(1)>, L<crl2pkcs7(1)>, L<dgst(1)>,
+L<dhparam(1)>, L<dsa(1)>, L<dsaparam(1)>,
+L<enc(1)>, L<engine(1)>, L<gendsa(1)>, L<genpkey(1)>,
+L<genrsa(1)>, L<nseq(1)>, L<openssl(1)>,
+L<passwd(1)>,
+L<pkcs12(1)>, L<pkcs7(1)>, L<pkcs8(1)>,
+L<rand(1)>, L<req(1)>, L<rsa(1)>,
+L<rsautl(1)>, L<s_client(1)>,
+L<s_server(1)>, L<s_time(1)>,
+L<smime(1)>, L<spkac(1)>,
+L<verify(1)>, L<version(1)>, L<x509(1)>,
+L<crypto(3)>, L<ssl(3)>, L<x509v3_config(5)>

 
 =head1 HISTORY
 
 
 =head1 HISTORY
 

-The openssl(1) document appeared in OpenSSL 0.9.2.
-The B<list->I<XXX>B<-commands> pseudo-commands were added in OpenSSL 0.9.3;

 The B<list->I<XXX>B<-algorithms> pseudo-commands were added in OpenSSL 1.0.0;
 The B<list->I<XXX>B<-algorithms> pseudo-commands were added in OpenSSL 1.0.0;

-the B<no->I<XXX> pseudo-commands were added in OpenSSL 0.9.5a.

 For notes on the availability of other commands, see their individual
 manual pages.
 
 For notes on the availability of other commands, see their individual
 manual pages.
 

+=head1 COPYRIGHT
+
+Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
+
+Licensed under the OpenSSL license (the "License").  You may not use
+this file except in compliance with the License.  You can obtain a copy
+in the file LICENSE in the source distribution or at
+L<https://www.openssl.org/source/license.html>.
+

 =cut
 =cut