minor docs changes (added links is the openssl(1) text)
[openssl.git] / doc / apps / openssl.pod
index f5ce14ca2f3bbcd8af7eadb865adcd9572f2edf5..9b1320606ba7389834bcab2016697b1ab30ed881 100644 (file)
@@ -27,6 +27,7 @@ It can be used for
  o  Calculation of Message Digests
  o  Encryption and Decryption with Ciphers
  o  SSL/TLS Client and Server Tests
+ o  Handling of S/MIME signed or encrypted mail
 
 =head1 COMMAND SUMMARY
 
@@ -38,82 +39,86 @@ SYNOPSIS above), each of which often has a wealth of options and arguments
 
 =over 10
 
-=item B<asn1parse> 
+=item L<B<asn1parse>|asn1parse(1)>
 
 Parse an ASN.1 sequence.
 
-=item B<ca>
+=item L<B<ca>|ca(1)>
 
 Certificate Authority (CA) Management.  
 
-=item B<ciphers>
+=item L<B<ciphers>|ciphers(1)>
 
 Cipher Suite Description Determination.
 
-=item B<crl>
+=item L<B<crl>|crl(1)>
 
 Certificate Revocation List (CRL) Management.
 
-=item B<crl2pkcs7>      
+=item L<B<crl2pkcs7>|crl2pkcs7(1)>
 
 CRL to PKCS#7 Conversion.
 
-=item B<dgst>
+=item L<B<dgst>|dgst(1)>
 
 Message Digest Calculation.
 
-=item B<dh>
+=item L<B<dh>|dh(1)>
 
 Diffie-Hellman Data Management.
 
-=item B<dsa>
+=item L<B<dsa>|dsa(1)>
 
 DSA Data Management.
 
-=item B<dsaparam>
+=item L<B<dsaparam>|dsaparam(1)>
 
 DSA Parameter Generation.
 
-=item B<enc>            
+=item L<B<enc>|enc(1)>
 
 Encoding with Ciphers.
 
-=item B<errstr>
+=item L<B<errstr>|errstr(1)>
 
 Error Number to Error String Conversion.
 
-=item B<gendh>
+=item L<B<gendh>|gendh(1)>
 
 Generation of Diffie-Hellman Parameters.
 
-=item B<gendsa>
+=item L<B<gendsa>|gendsa(1)>
 
 Generation of DSA Parameters.
 
-=item B<genrsa>
+=item L<B<genrsa>|genrsa(1)>
 
 Generation of RSA Parameters.
 
-=item B<pkcs7>
+=item L<B<passwd>|passwd(1)>
+
+Generation of hashed passwords.
+
+=item L<B<pkcs7>|pkcs7(1)>
 
 PKCS#7 Data Management.
 
-=item B<req>
+=item L<B<req>|req(1)>
 
 X.509 Certificate Signing Request (CSR) Management.
 
-=item B<rsa>
+=item L<B<rsa>|rsa(1)>
 
 RSA Data Management.
 
-=item B<s_client>
+=item L<B<s_client>|s_client(1)>
 
 This implements a generic SSL/TLS client which can establish a transparent
 connection to a remote server speaking SSL/TLS. It's intended for testing
 purposes only and provides only rudimentary interface functionality but
 internally uses mostly all functionality of the OpenSSL B<ssl> library.
 
-=item B<s_server>
+=item L<B<s_server>|s_server(1)>
 
 This implements a generic SSL/TLS server which accepts connections from remote
 clients speaking SSL/TLS. It's intended for testing purposes only and provides
@@ -122,27 +127,31 @@ 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>        
+=item L<B<s_time>|s_time(1)>
 
 SSL Connection Timer.
 
-=item B<sess_id>
+=item L<B<sess_id>|sess_id(1)>
 
 SSL Session Data Management.
 
-=item B<speed>
+=item L<B<smime>|smime(1)>
+
+S/MIME mail processing.
+
+=item L<B<speed>|speed(1)>
 
 Algorithm Speed Measurement.
 
-=item B<verify>
+=item L<B<verify>|verify(1)>
 
 X.509 Certificate Verification.
 
-=item B<version>
+=item L<B<version>|version(1)>
 
 OpenSSL Version Information.
 
-=item B<x509>           
+=item L<B<x509>|x509(1)>
 
 X.509 Certificate Data Management.
 
@@ -224,13 +233,62 @@ RC5 Cipher
 
 =back
 
+=head1 PASS PHRASE ARGUMENTS
+
+Several commands accept password arguments, typically using B<-passin>
+and B<-passout> for input and output passwords respectively. These allow
+the password to be obtained from a variety of sources. Both of these
+options take a single argument whose format is described below. If no
+password argument is given and a password is required then the user is
+prompted to enter one: this will typically be read from the current
+terminal with echoing turned off.
+
+=over 10
+
+=item B<pass:password>
+
+the actual password is B<password>. Since the password is visible
+to utilities (like 'ps' under Unix) this form should only be used
+where security is not important.
+
+=item B<env:var>
+
+obtain the password from the environment variable B<var>. Since
+the environment of other processes is visible on certain platforms
+(e.g. ps under certain Unix OSes) this option should be used with caution.
+
+=item B<file:pathname>
+
+the first line of B<pathname> is the password. If the same B<pathname>
+argument is supplied to B<-passin> and B<-passout> arguments then the first
+line will be used for the input password and the next line for the output
+password. B<pathname> need not refer to a regular file: it could for example
+refer to a device or named pipe.
+
+=item B<fd:number>
+
+read the password from the file descriptor B<number>. This can be used to
+send the data via a pipe for example.
+
+=item B<stdin>
+
+read the password from standard input.
+
+=back
+
 =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), s_client(1),
-s_server(1), smime(1), spkac(1), verify(1), version(1), x509(1),
-crypto(3), ssl(3)
+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<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<req(1)|req(1)>, L<rsa(1)|rsa(1)>, L<s_client(1)|s_client(1)>,
+L<s_server(1)|s_server(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)> 
 
 =head1 HISTORY