Unify doc/openssl.pod and doc/man/openssl.pod, which were almost the

[openssl.git] / doc / openssl.pod

diff --git a/doc/openssl.pod b/doc/openssl.pod
index f7b841533457929d6c7d2133e146018c8da0050f..89f81c7c9058f7b9d13e42dc88958ef7f5f75325 100644 (file)
--- a/doc/openssl.pod
+++ b/doc/openssl.pod
@@ -23,7 +23,7 @@ cryptography functions of OpenSSL's B<crypto> library from the shell.
 It can be used for 
 
  o  Creation of RSA, DH and DSA key parameters
- o  Creattion 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
@@ -34,8 +34,78 @@ 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).
 
+=head2 STANDARD COMMANDS
+
 =over 10
 
+=item B<asn1parse> 
+
+Parse an ASN.1 sequence.
+
+=item B<ca>
+
+Certificate Authority (CA) Management.  
+
+=item B<ciphers>
+
+Cipher Suite Description Determination.
+
+=item B<crl>
+
+Certificate Revocation List (CRL) Management.
+
+=item B<crl2pkcs7>      
+
+CRL to PKCS#7 Conversion.
+
+=item B<dgst>
+
+Message Digest Calculation.
+
+=item B<dh>
+
+Diffie-Hellman Data Management.
+
+=item B<dsa>
+
+DSA Data Management.
+
+=item B<dsaparam>
+
+DSA Parameter Generation.
+
+=item B<enc>            
+
+Encoding with Ciphers.
+
+=item B<errstr>
+
+Error Number to Error String Conversion.
+
+=item B<gendh>
+
+Generation of Diffie-Hellman Parameters.
+
+=item B<gendsa>
+
+Generation of DSA Parameters.
+
+=item B<genrsa>
+
+Generation of RSA Parameters.
+
+=item B<pkcs7>
+
+PKCS#7 Data Management.
+
+=item B<req>
+
+X.509 Certificate Signing Request (CSR) Management.
+
+=item B<rsa>
+
+RSA Data Management.
+
 =item B<s_client>
 
 This implements a generic SSL/TLS client which can establish a transparent
@@ -52,11 +122,113 @@ functionality of the OpenSSL B<ssl> library.  It provides both an own command
 line oriented protocol for testing SSL functions and a simple HTTP response
 facility to emulate an SSL/TLS-aware webserver.
 
+=item B<s_time>        
+
+SSL Connection Timer.
+
+=item B<sess_id>
+
+SSL Session Data Management.
+
+=item B<speed>
+
+Algorithm Speed Measurement.
+
+=item B<verify>
+
+X.509 Certificate Verification.
+
+=item B<version>
+
+OpenSSL Version Information.
+
+=item B<x509>           
+
+X.509 Certificate Data Management.
+
+=back
+
+=head2 MESSAGE DIGEST COMMANDS
+
+=over 10
+
+=item B<md2>
+
+MD2 Digest
+
+=item B<md5>
+
+MD5 Digest
+
+=item B<mdc2>
+
+MDC2 Digest
+
+=item B<rmd160>
+
+RMD-160 Digest
+
+=item B<sha>            
+
+SHA Digest
+
+=item B<sha1>           
+
+SHA-1 Digest
+
+=back
+
+=head2 ENCODING AND CIPHER COMMANDS
+
+=over 10
+
+=item B<base64>
+
+Base64 Encoding
+
+=item B<bf bf-cbc bf-cfb bf-ecb bf-ofb>
+
+Blowfish Cipher
+
+=item B<cast cast-cbc>
+
+CAST Cipher
+
+=item B<cast5-cbc cast5-cfb cast5-ecb cast5-ofb>
+
+CAST5 Cipher
+
+=item B<des des-cbc des-cfb des-ecb des-ede des-ede-cbc des-ede-cfb des-ede-ofb des-ofb>
+
+DES Cipher
+
+=item B<des3 desx des-ede3 des-ede3-cbc des-ede3-cfb des-ede3-ofb>
+
+Triple-DES Cipher
+
+=item B<idea idea-cbc idea-cfb idea-ecb idea-ofb>
+
+IDEA Cipher
+
+=item B<rc2 rc2-cbc rc2-cfb rc2-ecb rc2-ofb>
+
+RC2 Cipher
+
+=item B<rc4>
+
+RC4 Cipher
+
+=item B<rc5 rc5-cbc rc5-cfb rc5-ecb rc5-ofb>
+
+RC5 Cipher
+
 =back
 
 =head1 DETAILED COMMAND DESCRIPTION
 
 The following is a detailed description of every B<openssl> I<command>.
+(No, it isn't; this is here temporarily and should be in separate
+files for s_client and for s_server.)
 
 =over 4
 
@@ -93,6 +265,8 @@ SSL/TLS.
 [B<-Verify> I<arg>]
 [B<-cert> I<arg>]
 [B<-key> I<arg>]
+[B<-dcert> I<arg>]
+[B<-dkey> I<arg>]
 [B<-nbio>]
 [B<-nbio_test>]
 [B<-debug>]
@@ -122,11 +296,15 @@ connections from remote clients on I<port> speaking SSL/TLS.
 
 =head1 SEE ALSO
 
+asn1parse(1), ca(1), config(1), crl(1), crl2pkcs7(1), dgst(1), dh(1),
+dsa(1), dsaparam(1), enc(1), gendh(1), gendsa(1), genrsa(1), nseq(1),
+openssl(1), pkcs12(1), pkcs7(1), pkcs8(1), req(1), rsa(1), smime(1),
+spkac(1), verify(1), version(1), x509(1),
 crypto(3), ssl(3)
 
-=head1 AUTHORS
+=head1 HISTORY
 
-Ralf S. Engelschall
+The openssl(1) document appeared in OpenSSL 0.9.2
 
 =cut