From 2f0ea9365806895c313b6d8e2ce33428260e856c Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Tue, 1 Oct 2019 18:16:29 +0200 Subject: [PATCH] Command docs: replacables are in italics, options always start with a dash Quite a lot of replacables were still bold, and some options were mentioned without a beginning dash. Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/10065) --- doc/man1/CA.pl.pod | 2 +- doc/man1/openssl-asn1parse.pod | 12 +++--- doc/man1/openssl-ca.pod | 14 +++---- doc/man1/openssl-ciphers.pod | 8 ++-- doc/man1/openssl-cmds.pod | 12 +++--- doc/man1/openssl-cms.pod | 10 ++--- doc/man1/openssl-crl.pod | 4 +- doc/man1/openssl-dgst.pod | 14 +++---- doc/man1/openssl-dhparam.pod | 4 +- doc/man1/openssl-dsa.pod | 6 +-- doc/man1/openssl-dsaparam.pod | 8 ++-- doc/man1/openssl-ec.pod | 8 ++-- doc/man1/openssl-ecparam.pod | 4 +- doc/man1/openssl-enc.pod | 8 ++-- doc/man1/openssl-engine.pod | 11 +++-- doc/man1/openssl-errstr.pod | 2 +- doc/man1/openssl-fipsinstall.pod | 6 +-- doc/man1/openssl-gendsa.pod | 12 +++--- doc/man1/openssl-genpkey.pod | 59 +++++++++++++-------------- doc/man1/openssl-genrsa.pod | 9 ++--- doc/man1/openssl-mac.pod | 20 ++++----- doc/man1/openssl-ocsp.pod | 69 ++++++++++++++++---------------- doc/man1/openssl-passwd.pod | 5 ++- doc/man1/openssl-pkcs12.pod | 10 ++--- doc/man1/openssl-pkcs8.pod | 10 ++--- doc/man1/openssl-pkey.pod | 8 ++-- doc/man1/openssl-pkeyparam.pod | 2 +- doc/man1/openssl-pkeyutl.pod | 61 ++++++++++++++-------------- doc/man1/openssl-prime.pod | 6 +-- doc/man1/openssl-rehash.pod | 10 ++--- doc/man1/openssl-req.pod | 56 +++++++++++++------------- doc/man1/openssl-rsa.pod | 8 ++-- doc/man1/openssl-s_client.pod | 24 +++++------ doc/man1/openssl-s_server.pod | 18 ++++----- doc/man1/openssl-s_time.pod | 8 ++-- doc/man1/openssl-sess_id.pod | 8 ++-- doc/man1/openssl-smime.pod | 2 +- doc/man1/openssl-speed.pod | 14 +++---- doc/man1/openssl-spkac.pod | 8 ++-- doc/man1/openssl-srp.pod | 4 +- doc/man1/openssl-storeutl.pod | 6 +-- doc/man1/openssl-ts.pod | 2 +- doc/man1/openssl-verify.pod | 56 +++++++++++++------------- doc/man1/openssl-x509.pod | 16 ++++---- doc/man1/openssl.pod | 36 ++++++++--------- 45 files changed, 343 insertions(+), 337 deletions(-) diff --git a/doc/man1/CA.pl.pod b/doc/man1/CA.pl.pod index 17745d6769..1e4d223ddb 100644 --- a/doc/man1/CA.pl.pod +++ b/doc/man1/CA.pl.pod @@ -120,7 +120,7 @@ Verifies certificates against the CA certificate for "demoCA". If no certificates are specified on the command line it tries to verify the file "newcert.pem". Invokes B command. -=item B<-extra-req> | B<-extra-ca> | B<-extra-pkcs12> | B<-extra-x509> | B<-extra-verify> +=item B<-extra-req> | B<-extra-ca> | B<-extra-pkcs12> | B<-extra-x509> | B<-extra-verify> I The purpose of these parameters is to allow optional parameters to be supplied to B that this command executes. The B<-extra-cmd> are specific to the diff --git a/doc/man1/openssl-asn1parse.pod b/doc/man1/openssl-asn1parse.pod index 73824bfe14..7b81c51f49 100644 --- a/doc/man1/openssl-asn1parse.pod +++ b/doc/man1/openssl-asn1parse.pod @@ -39,7 +39,7 @@ Print out a usage message. =item B<-inform> B|B -The input format. I is binary format and I (the default) is base64 +The input format. B is binary format and B (the default) is base64 encoded. =item B<-in> I @@ -88,12 +88,12 @@ option can be used multiple times to "drill down" into a nested structure. =item B<-genstr> I, B<-genconf> I -Generate encoded data based on B, B or both using -L format. If B only is +Generate encoded data based on I, I or both using +L format. If I only is present then the string is obtained from the default section using the name B. The encoded data is passed through the ASN1 parser and printed out as though it came from a file, the contents can thus be examined and written to a -file using the B option. +file using the B<-out> option. =item B<-strictpem> @@ -105,8 +105,8 @@ END marker in a PEM file. =item B<-item> I -Attempt to decode and print the data as B. This can be used to -print out the fields of any supported ASN.1 structure if the type is known. +Attempt to decode and print the data as B I. This can be used +to print out the fields of any supported ASN.1 structure if the type is known. =back diff --git a/doc/man1/openssl-ca.pod b/doc/man1/openssl-ca.pod index 4ba230f46b..4780f2aa97 100644 --- a/doc/man1/openssl-ca.pod +++ b/doc/man1/openssl-ca.pod @@ -251,7 +251,7 @@ used). =item B<-engine> I -Specifying an engine (by its unique B string) will cause B +Specifying an engine (by its unique I string) will cause B to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. @@ -259,7 +259,7 @@ for all available algorithms. =item B<-subj> I Supersedes subject name given in the request. -The arg must be formatted as I. +The arg must be formatted as C. Keyword characters may be escaped by \ (backslash), and whitespace is retained. Empty values are permitted, but the corresponding type will not be included in the resulting certificate. @@ -291,7 +291,7 @@ support for multivalued RDNs. Example: I -If -multi-rdn is not used then the UID value is I<123456+CN=John Doe>. +If B<-multi-rdn> is not used then the UID value is I<123456+CN=John Doe>. =item B<-rand> I @@ -353,9 +353,9 @@ Updates the database index to purge expired certificates. =item B<-crl_reason> I -Revocation reason, where B is one of: B, B, +Revocation reason, where I is one of: B, B, B, B, B, B, -B or B. The matching of B is case +B or B. The matching of I is case insensitive. Setting any revocation reason will make the CRL v2. In practice B is not particularly useful because it is only used @@ -364,14 +364,14 @@ in delta CRLs which are not currently implemented. =item B<-crl_hold> I This sets the CRL revocation reason code to B and the hold -instruction to B which must be an OID. Although any OID can be +instruction to I which must be an OID. Although any OID can be used only B (the use of which is discouraged by RFC2459) B or B will normally be used. =item B<-crl_compromise> I