Command docs: more reference fixes
[openssl.git] / doc / man1 / openssl-ocsp.pod
index df6b9af..7f6c31f 100644 (file)
@@ -8,33 +8,33 @@ openssl-ocsp - Online Certificate Status Protocol utility
 
 B<openssl> B<ocsp>
 [B<-help>]
 
 B<openssl> B<ocsp>
 [B<-help>]
-[B<-out file>]
-[B<-issuer file>]
-[B<-cert file>]
-[B<-serial n>]
-[B<-signer file>]
-[B<-signkey file>]
-[B<-sign_other file>]
+[B<-out> I<file>]
+[B<-issuer> I<file>]
+[B<-cert> I<file>]
+[B<-serial> I<n>]
+[B<-signer> I<file>]
+[B<-signkey> I<file>]
+[B<-sign_other> I<file>]
 [B<-no_certs>]
 [B<-req_text>]
 [B<-resp_text>]
 [B<-text>]
 [B<-no_certs>]
 [B<-req_text>]
 [B<-resp_text>]
 [B<-text>]
-[B<-reqout file>]
-[B<-respout file>]
-[B<-reqin file>]
-[B<-respin file>]
+[B<-reqout> I<file>]
+[B<-respout> I<file>]
+[B<-reqin> I<file>]
+[B<-respin> I<file>]
 [B<-nonce>]
 [B<-no_nonce>]
 [B<-nonce>]
 [B<-no_nonce>]
-[B<-url URL>]
-[B<-host host:port>]
-[B<-multi process-count>]
+[B<-url> I<URL>]
+[B<-host> I<host>:I<port>]
+[B<-multi> I<process-count>]
 [B<-header>]
 [B<-path>]
 [B<-header>]
 [B<-path>]
-[B<-CApath dir>]
-[B<-CAfile file>]
+[B<-CApath> I<dir>]
+[B<-CAfile> I<file>]
 [B<-no-CAfile>]
 [B<-no-CApath>]
 [B<-no-CAfile>]
 [B<-no-CApath>]
-[B<-attime timestamp>]
+[B<-attime> I<timestamp>]
 [B<-check_ss_sig>]
 [B<-crl_check>]
 [B<-crl_check_all>]
 [B<-check_ss_sig>]
 [B<-crl_check>]
 [B<-crl_check_all>]
@@ -45,28 +45,28 @@ B<openssl> B<ocsp>
 [B<-inhibit_map>]
 [B<-no_check_time>]
 [B<-partial_chain>]
 [B<-inhibit_map>]
 [B<-no_check_time>]
 [B<-partial_chain>]
-[B<-policy arg>]
+[B<-policy> I<arg>]
 [B<-policy_check>]
 [B<-policy_print>]
 [B<-policy_check>]
 [B<-policy_print>]
-[B<-purpose purpose>]
+[B<-purpose> I<purpose>]
 [B<-suiteB_128>]
 [B<-suiteB_128_only>]
 [B<-suiteB_192>]
 [B<-trusted_first>]
 [B<-no_alt_chains>]
 [B<-use_deltas>]
 [B<-suiteB_128>]
 [B<-suiteB_128_only>]
 [B<-suiteB_192>]
 [B<-trusted_first>]
 [B<-no_alt_chains>]
 [B<-use_deltas>]
-[B<-auth_level num>]
-[B<-verify_depth num>]
-[B<-verify_email email>]
-[B<-verify_hostname hostname>]
-[B<-verify_ip ip>]
-[B<-verify_name name>]
+[B<-auth_level> I<num>]
+[B<-verify_depth> I<num>]
+[B<-verify_email> I<email>]
+[B<-verify_hostname> I<hostname>]
+[B<-verify_ip> I<ip>]
+[B<-verify_name> I<name>]
 [B<-x509_strict>]
 [B<-x509_strict>]
-[B<-VAfile file>]
-[B<-validity_period n>]
-[B<-status_age n>]
+[B<-VAfile> I<file>]
+[B<-validity_period> I<n>]
+[B<-status_age> I<n>]
 [B<-noverify>]
 [B<-noverify>]
-[B<-verify_other file>]
+[B<-verify_other> I<file>]
 [B<-trust_other>]
 [B<-no_intern>]
 [B<-no_signature_verify>]
 [B<-trust_other>]
 [B<-no_intern>]
 [B<-no_signature_verify>]
@@ -74,28 +74,30 @@ B<openssl> B<ocsp>
 [B<-no_chain>]
 [B<-no_cert_checks>]
 [B<-no_explicit>]
 [B<-no_chain>]
 [B<-no_cert_checks>]
 [B<-no_explicit>]
-[B<-port num>]
+[B<-port> I<num>]
 [B<-ignore_err>]
 [B<-ignore_err>]
-[B<-index file>]
-[B<-CA file>]
-[B<-rsigner file>]
-[B<-rkey file>]
-[B<-rother file>]
-[B<-rsigopt nm:v>]
+[B<-index> I<file>]
+[B<-CA> I<file>]
+[B<-rsigner> I<file>]
+[B<-rkey> I<file>]
+[B<-rother> I<file>]
+[B<-rsigopt> I<nm>:I<v>]
 [B<-resp_no_certs>]
 [B<-resp_no_certs>]
-[B<-nmin n>]
-[B<-ndays n>]
+[B<-nmin> I<n>]
+[B<-ndays> I<n>]
 [B<-resp_key_id>]
 [B<-resp_key_id>]
-[B<-nrequest n>]
-[B<-rcid I<digest>>]
+[B<-nrequest> I<n>]
+[B<-rcid> I<digest>]
 [B<-I<digest>>]
 
 [B<-I<digest>>]
 
+=for comment ifdef multi
+
 =head1 DESCRIPTION
 
 The Online Certificate Status Protocol (OCSP) enables applications to
 determine the (revocation) state of an identified certificate (RFC 2560).
 
 =head1 DESCRIPTION
 
 The Online Certificate Status Protocol (OCSP) enables applications to
 determine the (revocation) state of an identified certificate (RFC 2560).
 
-The B<ocsp> command performs many common OCSP tasks. It can be used
+This command performs many common OCSP tasks. It can be used
 to print out requests and responses, create requests and send queries
 to an OCSP responder and behave like a mini OCSP server itself.
 
 to print out requests and responses, create requests and send queries
 to an OCSP responder and behave like a mini OCSP server itself.
 
@@ -112,81 +114,81 @@ The options are described below, divided into those two modes.
 
 Print out a usage message.
 
 
 Print out a usage message.
 
-=item B<-out filename>
+=item B<-out> I<filename>
 
 specify output filename, default is standard output.
 
 
 specify output filename, default is standard output.
 
-=item B<-issuer filename>
+=item B<-issuer> I<filename>
 
 This specifies the current issuer certificate. This option can be used
 
 This specifies the current issuer certificate. This option can be used
-multiple times. The certificate specified in B<filename> must be in
+multiple times. The certificate specified in I<filename> must be in
 PEM format. This option B<MUST> come before any B<-cert> options.
 
 PEM format. This option B<MUST> come before any B<-cert> options.
 
-=item B<-cert filename>
+=item B<-cert> I<filename>
 
 
-Add the certificate B<filename> to the request. The issuer certificate
-is taken from the previous B<issuer> option, or an error occurs if no
+Add the certificate I<filename> to the request. The issuer certificate
+is taken from the previous B<-issuer> option, or an error occurs if no
 issuer certificate is specified.
 
 issuer certificate is specified.
 
-=item B<-serial num>
+=item B<-serial> I<num>
 
 
-Same as the B<cert> option except the certificate with serial number
+Same as the B<-cert> option except the certificate with serial number
 B<num> is added to the request. The serial number is interpreted as a
 B<num> is added to the request. The serial number is interpreted as a
-decimal integer unless preceded by B<0x>. Negative integers can also
-be specified by preceding the value by a B<-> sign.
+decimal integer unless preceded by C<0x>. Negative integers can also
+be specified by preceding the value by a C<-> sign.
 
 
-=item B<-signer filename>, B<-signkey filename>
+=item B<-signer> I<filename>, B<-signkey> I<filename>
 
 
-Sign the OCSP request using the certificate specified in the B<signer>
-option and the private key specified by the B<signkey> option. If
-the B<signkey> option is not present then the private key is read
+Sign the OCSP request using the certificate specified in the B<-signer>
+option and the private key specified by the B<-signkey> option. If
+the B<-signkey> option is not present then the private key is read
 from the same file as the certificate. If neither option is specified then
 the OCSP request is not signed.
 
 from the same file as the certificate. If neither option is specified then
 the OCSP request is not signed.
 
-=item B<-sign_other filename>
+=item B<-sign_other> I<filename>
 
 Additional certificates to include in the signed request.
 
 =item B<-nonce>, B<-no_nonce>
 
 Add an OCSP nonce extension to a request or disable OCSP nonce addition.
 
 Additional certificates to include in the signed request.
 
 =item B<-nonce>, B<-no_nonce>
 
 Add an OCSP nonce extension to a request or disable OCSP nonce addition.
-Normally if an OCSP request is input using the B<reqin> option no
-nonce is added: using the B<nonce> option will force addition of a nonce.
-If an OCSP request is being created (using B<cert> and B<serial> options)
-a nonce is automatically added specifying B<no_nonce> overrides this.
+Normally if an OCSP request is input using the B<-reqin> option no
+nonce is added: using the B<-nonce> option will force addition of a nonce.
+If an OCSP request is being created (using B<-cert> and B<-serial> options)
+a nonce is automatically added specifying B<-no_nonce> overrides this.
 
 =item B<-req_text>, B<-resp_text>, B<-text>
 
 Print out the text form of the OCSP request, response or both respectively.
 
 
 =item B<-req_text>, B<-resp_text>, B<-text>
 
 Print out the text form of the OCSP request, response or both respectively.
 
-=item B<-reqout file>, B<-respout file>
+=item B<-reqout> I<file>, B<-respout> I<file>
 
 
-Write out the DER encoded certificate request or response to B<file>.
+Write out the DER encoded certificate request or response to I<file>.
 
 
-=item B<-reqin file>, B<-respin file>
+=item B<-reqin> I<file>, B<-respin> I<file>
 
 
-Read OCSP request or response file from B<file>. These option are ignored
+Read OCSP request or response file from I<file>. These option are ignored
 if OCSP request or response creation is implied by other options (for example
 if OCSP request or response creation is implied by other options (for example
-with B<serial>, B<cert> and B<host> options).
+with B<-serial>, B<-cert> and B<-host> options).
 
 
-=item B<-url responder_url>
+=item B<-url> I<responder_url>
 
 Specify the responder URL. Both HTTP and HTTPS (SSL/TLS) URLs can be specified.
 
 
 Specify the responder URL. Both HTTP and HTTPS (SSL/TLS) URLs can be specified.
 
-=item B<-host hostname:port>, B<-path pathname>
+=item B<-host> I<hostname>:I<port>, B<-path> I<pathname>
 
 
-If the B<host> option is present then the OCSP request is sent to the host
-B<hostname> on port B<port>. B<path> specifies the HTTP path name to use
-or "/" by default.  This is equivalent to specifying B<-url> with scheme
+If the B<-host> option is present then the OCSP request is sent to the host
+I<hostname> on port I<port>. The B<-path> option specifies the HTTP pathname
+to use or "/" by default.  This is equivalent to specifying B<-url> with scheme
 http:// and the given hostname, port, and pathname.
 
 http:// and the given hostname, port, and pathname.
 
-=item B<-header name=value>
+=item B<-header> I<name>=I<value>
 
 
-Adds the header B<name> with the specified B<value> to the OCSP request
+Adds the header I<name> with the specified I<value> to the OCSP request
 that is sent to the responder.
 This may be repeated.
 
 that is sent to the responder.
 This may be repeated.
 
-=item B<-timeout seconds>
+=item B<-timeout> I<seconds>
 
 Connection timeout to the OCSP responder in seconds.
 On POSIX systems, when running as an OCSP responder, this option also limits
 
 Connection timeout to the OCSP responder in seconds.
 On POSIX systems, when running as an OCSP responder, this option also limits
@@ -194,7 +196,7 @@ the time that the responder is willing to wait for the client request.
 This time is measured from the time the responder accepts the connection until
 the complete request is received.
 
 This time is measured from the time the responder accepts the connection until
 the complete request is received.
 
-=item B<-multi process-count>
+=item B<-multi> I<process-count>
 
 Run the specified number of OCSP responder child processes, with the parent
 process respawning child processes as needed.
 
 Run the specified number of OCSP responder child processes, with the parent
 process respawning child processes as needed.
@@ -205,7 +207,7 @@ each child is willing to wait for the client's OCSP response.
 This option is available on POSIX systems (that support the fork() and other
 required unix system-calls).
 
 This option is available on POSIX systems (that support the fork() and other
 required unix system-calls).
 
-=item B<-CAfile file>, B<-CApath pathname>
+=item B<-CAfile> I<file>, B<-CApath> I<pathname>
 
 File or pathname containing trusted CA certificates. These are used to verify
 the signature on the OCSP response.
 
 File or pathname containing trusted CA certificates. These are used to verify
 the signature on the OCSP response.
@@ -227,9 +229,9 @@ B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
 
 Set different certificate verification options.
 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
 
 Set different certificate verification options.
-See L<verify(1)> manual page for details.
+See L<openssl-verify(1)> manual page for details.
 
 
-=item B<-verify_other file>
+=item B<-verify_other> I<file>
 
 File containing additional certificates to search when attempting to locate
 the OCSP response signing certificate. Some responders omit the actual signer's
 
 File containing additional certificates to search when attempting to locate
 the OCSP response signing certificate. Some responders omit the actual signer's
@@ -243,7 +245,7 @@ trusted and no additional checks will be performed on them. This is useful
 when the complete responder certificate chain is not available or trusting a
 root CA is not appropriate.
 
 when the complete responder certificate chain is not available or trusting a
 root CA is not appropriate.
 
-=item B<-VAfile file>
+=item B<-VAfile> I<file>
 
 File containing explicitly trusted responder certificates. Equivalent to the
 B<-verify_other> and B<-trust_other> options.
 
 File containing explicitly trusted responder certificates. Equivalent to the
 B<-verify_other> and B<-trust_other> options.
@@ -288,7 +290,7 @@ That is do not make any checks to see if the signers certificate is authorised
 to provide the necessary status information: as a result this option should
 only be used for testing purposes.
 
 to provide the necessary status information: as a result this option should
 only be used for testing purposes.
 
-=item B<-validity_period nsec>, B<-status_age age>
+=item B<-validity_period> I<nsec>, B<-status_age> I<age>
 
 These options specify the range of times, in seconds, which will be tolerated
 in an OCSP response. Each certificate status response includes a B<notBefore>
 
 These options specify the range of times, in seconds, which will be tolerated
 in an OCSP response. Each certificate status response includes a B<notBefore>
@@ -301,13 +303,13 @@ seconds, the default value is 5 minutes.
 
 If the B<notAfter> time is omitted from a response then this means that new
 status information is immediately available. In this case the age of the
 
 If the B<notAfter> time is omitted from a response then this means that new
 status information is immediately available. In this case the age of the
-B<notBefore> field is checked to see it is not older than B<age> seconds old.
+B<notBefore> field is checked to see it is not older than I<age> seconds old.
 By default this additional check is not performed.
 
 By default this additional check is not performed.
 
-=item B<-rcid I<digest>>
+=item B<-rcid> I<digest>
 
 This option sets the digest algorithm to use for certificate identification
 
 This option sets the digest algorithm to use for certificate identification
-in the OCSP response. Any digest supported by the OpenSSL B<dgst> command can
+in the OCSP response. Any digest supported by the L<openssl-dgst(1)> command can
 be used. The default is the same digest algorithm used in the request.
 
 =item B<-I<digest>>
 be used. The default is the same digest algorithm used in the request.
 
 =item B<-I<digest>>
@@ -323,29 +325,30 @@ digest used by subsequent certificate identifiers.
 
 =over 4
 
 
 =over 4
 
-=item B<-index indexfile>
+=item B<-index> I<indexfile>
 
 
-The B<indexfile> parameter is the name of a text index file in B<ca>
+The I<indexfile> parameter is the name of a text index file in B<ca>
 format containing certificate revocation information.
 
 format containing certificate revocation information.
 
-If the B<index> option is specified the B<ocsp> utility is in responder
-mode, otherwise it is in client mode. The request(s) the responder
-processes can be either specified on the command line (using B<issuer>
-and B<serial> options), supplied in a file (using the B<reqin> option)
-or via external OCSP clients (if B<port> or B<url> is specified).
+If the B<-index> option is specified then this command switches to
+responder mode, otherwise it is in client mode. The request(s) the responder
+processes can be either specified on the command line (using B<-issuer>
+and B<-serial> options), supplied in a file (using the B<-reqin> option)
+or via external OCSP clients (if B<-port> or B<-url> is specified).
 
 
-If the B<index> option is present then the B<CA> and B<rsigner> options
+If the B<-index> option is present then the B<-CA> and B<-rsigner> options
 must also be present.
 
 must also be present.
 
-=item B<-CA file>
+=item B<-CA> I<file>
 
 
-CA certificate corresponding to the revocation information in B<indexfile>.
+CA certificate corresponding to the revocation information in the index
+file given with B<-index>.
 
 
-=item B<-rsigner file>
+=item B<-rsigner> I<file>
 
 The certificate to sign OCSP responses with.
 
 
 The certificate to sign OCSP responses with.
 
-=item B<-rother file>
+=item B<-rother> I<file>
 
 Additional certificates to include in the OCSP response.
 
 
 Additional certificates to include in the OCSP response.
 
@@ -358,17 +361,17 @@ Don't include any certificates in the OCSP response.
 Identify the signer certificate using the key ID, default is to use the
 subject name.
 
 Identify the signer certificate using the key ID, default is to use the
 subject name.
 
-=item B<-rkey file>
+=item B<-rkey> I<file>
 
 The private key to sign OCSP responses with: if not present the file
 
 The private key to sign OCSP responses with: if not present the file
-specified in the B<rsigner> option is used.
+specified in the B<-rsigner> option is used.
 
 
-=item B<-rsigopt nm:v>
+=item B<-rsigopt> I<nm>:I<v>
 
 Pass options to the signature algorithm when signing OCSP responses.
 Names and values of these options are algorithm-specific.
 
 
 Pass options to the signature algorithm when signing OCSP responses.
 Names and values of these options are algorithm-specific.
 
-=item B<-port portnum>
+=item B<-port> I<portnum>
 
 Port to listen for OCSP requests on. The port may also be specified
 using the B<url> option.
 
 Port to listen for OCSP requests on. The port may also be specified
 using the B<url> option.
@@ -379,11 +382,11 @@ Ignore malformed requests or responses: When acting as an OCSP client, retry if
 a malformed response is received. When acting as an OCSP responder, continue
 running instead of terminating upon receiving a malformed request.
 
 a malformed response is received. When acting as an OCSP responder, continue
 running instead of terminating upon receiving a malformed request.
 
-=item B<-nrequest number>
+=item B<-nrequest> I<number>
 
 
-The OCSP server will exit after receiving B<number> requests, default unlimited.
+The OCSP server will exit after receiving I<number> requests, default unlimited.
 
 
-=item B<-nmin minutes>, B<-ndays days>
+=item B<-nmin> I<minutes>, B<-ndays> I<days>
 
 Number of minutes or days when fresh revocation information is available:
 used in the B<nextUpdate> field. If neither option is present then the
 
 Number of minutes or days when fresh revocation information is available:
 used in the B<nextUpdate> field. If neither option is present then the
@@ -392,7 +395,7 @@ immediately available.
 
 =back
 
 
 =back
 
-=head1 OCSP Response verification.
+=head1 OCSP RESPONSE VERIFICATION
 
 OCSP Response follows the rules specified in RFC2560.
 
 
 OCSP Response follows the rules specified in RFC2560.
 
@@ -401,8 +404,8 @@ the OCSP request checked using the responder certificate's public key.
 
 Then a normal certificate verify is performed on the OCSP responder certificate
 building up a certificate chain in the process. The locations of the trusted
 
 Then a normal certificate verify is performed on the OCSP responder certificate
 building up a certificate chain in the process. The locations of the trusted
-certificates used to build the chain can be specified by the B<CAfile>
-and B<CApath> options or they will be looked for in the standard OpenSSL
+certificates used to build the chain can be specified by the B<-CAfile>
+and B<-CApath> options or they will be looked for in the standard OpenSSL
 certificates directory.
 
 If the initial verify fails then the OCSP verify process halts with an
 certificates directory.
 
 If the initial verify fails then the OCSP verify process halts with an
@@ -449,8 +452,8 @@ new requests until it has processed the current one. The text index file
 format of revocation is also inefficient for large quantities of revocation
 data.
 
 format of revocation is also inefficient for large quantities of revocation
 data.
 
-It is possible to run the B<ocsp> application in responder mode via a CGI
-script using the B<reqin> and B<respout> options.
+It is possible to run this command in responder mode via a CGI
+script using the B<-reqin> and B<-respout> options.
 
 =head1 EXAMPLES
 
 
 =head1 EXAMPLES