Documentation updates
[openssl.git] / doc / man1 / smime.pod
index 7980e35e774505e01cea72951feed43af72db293..7cae26fa8484296171ade8dc3c579b45b722f0d9 100644 (file)
@@ -87,7 +87,7 @@ Print out a usage message.
 
 =item B<-encrypt>
 
-encrypt mail for the given recipient certificates. Input file is the message
+Encrypt mail for the given recipient certificates. Input file is the message
 to be encrypted. The output file is the encrypted mail in MIME format.
 
 Note that no revocation check is done for the recipient cert, so if that
@@ -95,37 +95,37 @@ key has been compromised, others may be able to decrypt the text.
 
 =item B<-decrypt>
 
-decrypt mail using the supplied certificate and private key. Expects an
+Decrypt mail using the supplied certificate and private key. Expects an
 encrypted mail message in MIME format for the input file. The decrypted mail
 is written to the output file.
 
 =item B<-sign>
 
-sign mail using the supplied certificate and private key. Input file is
+Sign mail using the supplied certificate and private key. Input file is
 the message to be signed. The signed message in MIME format is written
 to the output file.
 
 =item B<-verify>
 
-verify signed mail. Expects a signed mail message on input and outputs
+Verify signed mail. Expects a signed mail message on input and outputs
 the signed data. Both clear text and opaque signing is supported.
 
 =item B<-pk7out>
 
-takes an input message and writes out a PEM encoded PKCS#7 structure.
+Takes an input message and writes out a PEM encoded PKCS#7 structure.
 
 =item B<-resign>
 
-resign a message: take an existing message and one or more new signers.
+Resign a message: take an existing message and one or more new signers.
 
 =item B<-in filename>
 
-the input message to be encrypted or signed or the MIME message to
+The input message to be encrypted or signed or the MIME message to
 be decrypted or verified.
 
 =item B<-inform SMIME|PEM|DER>
 
-this specifies the input format for the PKCS#7 structure. The default
+This specifies the input format for the PKCS#7 structure. The default
 is B<SMIME> which reads an S/MIME format message. B<PEM> and B<DER>
 format change this to expect PEM and DER format PKCS#7 structures
 instead. This currently only affects the input format of the PKCS#7
@@ -134,12 +134,12 @@ B<-encrypt> or B<-sign>) this option has no effect.
 
 =item B<-out filename>
 
-the message text that has been decrypted or verified or the output MIME
+The message text that has been decrypted or verified or the output MIME
 format message that has been signed or verified.
 
 =item B<-outform SMIME|PEM|DER>
 
-this specifies the output format for the PKCS#7 structure. The default
+This specifies the output format for the PKCS#7 structure. The default
 is B<SMIME> which write an S/MIME format message. B<PEM> and B<DER>
 format change this to write PEM and DER format PKCS#7 structures
 instead. This currently only affects the output format of the PKCS#7
@@ -148,7 +148,7 @@ B<-verify> or B<-decrypt>) this option has no effect.
 
 =item B<-stream -indef -noindef>
 
-the B<-stream> and B<-indef> options are equivalent and enable streaming I/O
+The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
 for encoding operations. This permits single pass processing of data without
 the need to hold the entire contents in memory, potentially supporting very
 large files. Streaming is automatically set for S/MIME signing with detached
@@ -157,7 +157,7 @@ other operations.
 
 =item B<-noindef>
 
-disable streaming I/O where it would produce and indefinite length constructed
+Disable streaming I/O where it would produce and indefinite length constructed
 encoding. This option currently has no effect. In future streaming will be
 enabled by default on all relevant operations and this option will disable it.
 
@@ -171,38 +171,38 @@ is S/MIME and it uses the multipart/signed MIME content type.
 
 =item B<-text>
 
-this option adds plain text (text/plain) MIME headers to the supplied
+This option adds plain text (text/plain) MIME headers to the supplied
 message if encrypting or signing. If decrypting or verifying it strips
 off text headers: if the decrypted or verified message is not of MIME
 type text/plain then an error occurs.
 
 =item B<-CAfile file>
 
-a file containing trusted CA certificates, only used with B<-verify>.
+A file containing trusted CA certificates, only used with B<-verify>.
 
 =item B<-CApath dir>
 
-a directory containing trusted CA certificates, only used with
+A directory containing trusted CA certificates, only used with
 B<-verify>. This directory must be a standard certificate directory: that
 is a hash of each subject name (using B<x509 -hash>) should be linked
 to each certificate.
 
 =item B<-no-CAfile>
 
-Do not load the trusted CA certificates from the default file location
+Do not load the trusted CA certificates from the default file location.
 
 =item B<-no-CApath>
 
-Do not load the trusted CA certificates from the default directory location
+Do not load the trusted CA certificates from the default directory location.
 
 =item B<-md digest>
 
-digest algorithm to use when signing or resigning. If not present then the
+Digest algorithm to use when signing or resigning. If not present then the
 default digest algorithm for the signing key will be used (usually SHA1).
 
 =item B<-[cipher]>
 
-the encryption algorithm to use. For example DES  (56 bits) - B<-des>,
+The encryption algorithm to use. For example DES  (56 bits) - B<-des>,
 triple DES (168 bits) - B<-des3>,
 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
 example B<-aes-128-cbc>. See L<B<enc>|enc(1)> for list of ciphers
@@ -212,77 +212,77 @@ If not specified triple DES is used. Only used with B<-encrypt>.
 
 =item B<-nointern>
 
-when verifying a message normally certificates (if any) included in
+When verifying a message normally certificates (if any) included in
 the message are searched for the signing certificate. With this option
 only the certificates specified in the B<-certfile> option are used.
 The supplied certificates can still be used as untrusted CAs however.
 
 =item B<-noverify>
 
-do not verify the signers certificate of a signed message.
+Do not verify the signers certificate of a signed message.
 
 =item B<-nochain>
 
-do not do chain verification of signers certificates: that is don't
+Do not do chain verification of signers certificates: that is don't
 use the certificates in the signed message as untrusted CAs.
 
 =item B<-nosigs>
 
-don't try to verify the signatures on the message.
+Don't try to verify the signatures on the message.
 
 =item B<-nocerts>
 
-when signing a message the signer's certificate is normally included
+When signing a message the signer's certificate is normally included
 with this option it is excluded. This will reduce the size of the
 signed message but the verifier must have a copy of the signers certificate
 available locally (passed using the B<-certfile> option for example).
 
 =item B<-noattr>
 
-normally when a message is signed a set of attributes are included which
+Normally when a message is signed a set of attributes are included which
 include the signing time and supported symmetric algorithms. With this
 option they are not included.
 
 =item B<-binary>
 
-normally the input message is converted to "canonical" format which is
+Normally the input message is converted to "canonical" format which is
 effectively using CR and LF as end of line: as required by the S/MIME
 specification. When this option is present no translation occurs. This
 is useful when handling binary data which may not be in MIME format.
 
 =item B<-crlfeol>
 
-normally the output file uses a single B<LF> as end of line. When this
+Normally the output file uses a single B<LF> as end of line. When this
 option is present B<CRLF> is used instead.
 
 =item B<-nodetach>
 
-when signing a message use opaque signing: this form is more resistant
+When signing a message use opaque signing: this form is more resistant
 to translation by mail relays but it cannot be read by mail agents that
 do not support S/MIME.  Without this option cleartext signing with
 the MIME type multipart/signed is used.
 
 =item B<-certfile file>
 
-allows additional certificates to be specified. When signing these will
+Allows additional certificates to be specified. When signing these will
 be included with the message. When verifying these will be searched for
 the signers certificates. The certificates should be in PEM format.
 
 =item B<-signer file>
 
-a signing certificate when signing or resigning a message, this option can be
+A signing certificate when signing or resigning a message, this option can be
 used multiple times if more than one signer is required. If a message is being
 verified then the signers certificates will be written to this file if the
 verification was successful.
 
 =item B<-recip file>
 
-the recipients certificate when decrypting a message. This certificate
+The recipients certificate when decrypting a message. This certificate
 must match one of the recipients of the message or an error occurs.
 
 =item B<-inkey file>
 
-the private key to use when signing or decrypting. This must match the
+The private key to use when signing or decrypting. This must match the
 corresponding certificate. If this option is not specified then the
 private key must be included in the certificate file specified with
 the B<-recip> or B<-signer> file. When signing this option can be used
@@ -290,12 +290,12 @@ multiple times to specify successive keys.
 
 =item B<-passin arg>
 
-the private key password source. For more information about the format of B<arg>
+The private key password source. For more information about the format of B<arg>
 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
 
 =item B<-rand file(s)>
 
-a file or files containing random data used to seed the random number
+A file or files containing random data used to seed the random number
 generator, or an EGD socket (see L<RAND_egd(3)>).
 Multiple files can be specified separated by an OS-dependent character.
 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
@@ -303,12 +303,12 @@ all others.
 
 =item B<cert.pem...>
 
-one or more certificates of message recipients: used when encrypting
+One or more certificates of message recipients: used when encrypting
 a message.
 
 =item B<-to, -from, -subject>
 
-the relevant mail headers. These are included outside the signed
+The relevant mail headers. These are included outside the signed
 portion of a message so they may be included manually. If signing
 then many S/MIME mail clients check the signers certificate's email
 address matches that specified in the From: address.
@@ -370,28 +370,28 @@ remains DER.
 
 =item Z<>0
 
-the operation was completely successfully.
+The operation was completely successfully.
 
 =item Z<>1
 
-an error occurred parsing the command options.
+An error occurred parsing the command options.
 
 =item Z<>2
 
-one of the input files could not be read.
+One of the input files could not be read.
 
 =item Z<>3
 
-an error occurred creating the PKCS#7 file or when reading the MIME
+An error occurred creating the PKCS#7 file or when reading the MIME
 message.
 
 =item Z<>4
 
-an error occurred decrypting or verifying the message.
+An error occurred decrypting or verifying the message.
 
 =item Z<>5
 
-the message was verified correctly but an error occurred writing out
+The message was verified correctly but an error occurred writing out
 the signers certificates.
 
 =back
@@ -505,7 +505,7 @@ The -no_alt_chains options was first added to OpenSSL 1.1.0.
 
 =head1 COPYRIGHT
 
-Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2000-2017 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