Command docs: diverse small fixes

Better synopsis for 'openssl dgst' and 'openssl enc', correct names
for 'openssl rehash' ('c_rehash' is mentioned there too), correct
option end marker for 'openssl verify', and finally, refer to
sub-commands as sub-commands.

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10065)

diff --git a/doc/man1/CA.pl.pod b/doc/man1/CA.pl.pod
index 129bf3540795ae4989728e0ae8d49f079ed73315..c0ecabc53823280f8f0fb4ffea86a9b299678b44 100644 (file)
--- a/doc/man1/CA.pl.pod
+++ b/doc/man1/CA.pl.pod
@@ -122,12 +122,10 @@ F<newcert.pem>.  Invokes L<openssl-verify(1)> command.
 
 =item B<-extra-req> | B<-extra-ca> | B<-extra-pkcs12> | B<-extra-x509> | B<-extra-verify> I<extra-params>
 
-The purpose of these parameters is to allow optional parameters to be supplied
-to L<openssl(1)> that this command executes. The B<-extra-cmd> are specific to
-the option being used and the L<openssl(1)> command getting invoked. For example
-when this command invokes L<openssl-req(1)> extra parameters can be passed on
-with the B<-extra-req> parameter. The
-L<openssl(1)> commands being invoked per option are documented below.
+For each option B<extra-I<cmd>>, pass I<extra-params> to the L<openssl(1)>
+sub-command with the same name as I<cmd>, if that sub-command is invoked.
+For example, if L<openssl-req(1)> is invoked, the I<extra-params> given with
+B<-extra-req> will be passed to it.
 Users should consult L<openssl(1)> command documentation for more information.
 
 =back
@@ -164,7 +162,8 @@ Create the CA directories and files:
 
  CA.pl -newca
 
-enter a filename (for example F<cacert.pem>) when prompted for the CA filename.
+enter a filename (for example, F<cacert.pem>) when prompted for the CA file
+name.
 
 Create a DSA certificate request and private key (a different set of parameters
 can optionally be created first):

diff --git a/doc/man1/openssl-asn1parse.pod b/doc/man1/openssl-asn1parse.pod
index 183f5134acfe77c2300d311046cb3fddda868bda..5e755596c2148c1f04d8f258b0c14576dfe81090 100644 (file)
--- a/doc/man1/openssl-asn1parse.pod
+++ b/doc/man1/openssl-asn1parse.pod
@@ -105,8 +105,9 @@ END marker in a PEM file.
 
 =item B<-item> I<name>
 
-Attempt to decode and print the data as B<ASN1_ITEM> I<name>. 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 an B<ASN1_ITEM> I<name>. This can be
+used to print out the fields of any supported ASN.1 structure if the type is
+known.
 
 =back
 
@@ -161,6 +162,9 @@ by white space. The final column is the rest of the line and is the
 
 C<1.2.3.4       shortName       A long name>
 
+For any OID with an associated short and long name, this command will display
+the long name.
+
 =head1 EXAMPLES
 
 Parse a file:

diff --git a/doc/man1/openssl-dgst.pod b/doc/man1/openssl-dgst.pod
index f83c2ac516c0992d9e6ee5e2944bf486d4eff2c8..5f836f9cb51fcf44e82e404954662eddf3c08463 100644 (file)
--- a/doc/man1/openssl-dgst.pod
+++ b/doc/man1/openssl-dgst.pod
@@ -6,7 +6,7 @@ openssl-dgst - perform digest operations
 
 =head1 SYNOPSIS
 
-B<openssl dgst>
+B<openssl> B<dgst>|I<digest>
 [B<-I<digest>>]
 [B<-help>]
 [B<-c>]
@@ -29,8 +29,6 @@ B<openssl dgst>
 [B<-engine_impl>]
 [I<file> ...]
 
-B<openssl> I<digest> [B<...>]
-
 =head1 DESCRIPTION
 
 This command output the message digest of a supplied file or files

diff --git a/doc/man1/openssl-enc.pod b/doc/man1/openssl-enc.pod
index 5a992046f8d0e339e46d8fe2c662f656b0356eb0..f2608a59f70f59379a9de1f8568eb80687c4a2a5 100644 (file)
--- a/doc/man1/openssl-enc.pod
+++ b/doc/man1/openssl-enc.pod
@@ -6,7 +6,7 @@ openssl-enc - symmetric cipher routines
 
 =head1 SYNOPSIS
 
-B<openssl>
+B<openssl> B<enc>|I<cipher>
 [B<-I<cipher>>]
 [B<-help>]
 [B<-ciphers>]

diff --git a/doc/man1/openssl-engine.pod b/doc/man1/openssl-engine.pod
index ea5cf4d2f21a7fad38fd9b7e7554d8f67f7d00f5..30e391fd4e13c325b4cc592f4be6d808700f691f 100644 (file)
--- a/doc/man1/openssl-engine.pod
+++ b/doc/man1/openssl-engine.pod
@@ -10,8 +10,7 @@ B<openssl engine>
 [B<-v>]
 [B<-vv>]
 [B<-vvv>]
-[B<-vvv>]
-[B<-vvv>]
+[B<-vvvv>]
 [B<-c>]
 [B<-t>]
 [B<-tt>]

diff --git a/doc/man1/openssl-rehash.pod b/doc/man1/openssl-rehash.pod
index d813faacb98943a9c99cca30f82395731366d5ff..eed28644469f30c861ec4c8e5429287b43dd60a7 100644 (file)
--- a/doc/man1/openssl-rehash.pod
+++ b/doc/man1/openssl-rehash.pod
@@ -5,7 +5,8 @@ Original text by James Westby, contributed under the OpenSSL license.
 
 =head1 NAME
 
-openssl-c_rehash - Create symbolic links to files named by the hash values
+openssl-rehash, c_rehash - Create symbolic links to files named by the hash
+values
 
 =head1 SYNOPSIS
 
@@ -19,7 +20,12 @@ B<rehash>
 [I<directory>] ...
 
 B<c_rehash>
-I<flags...>
+[B<-h>]
+[B<-help>]
+[B<-old>]
+[B<-n>]
+[B<-v>]
+[I<directory>] ...
 
 =head1 DESCRIPTION
 

diff --git a/doc/man1/openssl-req.pod b/doc/man1/openssl-req.pod
index 2449a580bc838b717d0804479fab1adbb10ff76d..877e9362ea0bf37540927ede1962411009c42ebf 100644 (file)
--- a/doc/man1/openssl-req.pod
+++ b/doc/man1/openssl-req.pod
@@ -665,7 +665,7 @@ The following messages are frequently asked about:
         Using configuration from /some/path/openssl.cnf
         Unable to load config info
 
-This is followed some time later by...
+This is followed some time later by:
 
         unable to find 'distinguished_name' in config
         problems making Certificate Request

diff --git a/doc/man1/openssl-verify.pod b/doc/man1/openssl-verify.pod
index 81493a0fb41e2d5008576ef92bce86eb9c4d7fc2..f89461e3bde7cc9bd352632088c5352de840cc92 100644 (file)
--- a/doc/man1/openssl-verify.pod
+++ b/doc/man1/openssl-verify.pod
@@ -333,7 +333,7 @@ certificate. The argument for this option is string of hexadecimal digits.
 
 Indicates the last option. All arguments following this are assumed to be
 certificate files. This is useful if the first certificate filename begins
-with a B<->.
+with a B<-->.
 
 =item I<certificate> ...
 

diff --git a/doc/man1/openssl.pod b/doc/man1/openssl.pod
index 8a31f09ceb71fe8a212fc581496e5f252d98c9e0..10d38c9343333e2ec24b2d0f6dea94459a40eacb 100644 (file)
--- a/doc/man1/openssl.pod
+++ b/doc/man1/openssl.pod
@@ -11,7 +11,15 @@ I<command>
 [ I<command_opts> ... ]
 [ I<command_args> ... ]
 
-B<openssl> B<list> [ B<-standard-commands> | B<-digest-commands> | B<-cipher-commands> | B<-cipher-algorithms> | B<-digest-algorithms> | B<-mac-algorithms> | B<-public-key-algorithms>]
+B<openssl>
+B<list>
+B<-standard-commands> |
+B<-digest-commands> |
+B<-cipher-commands> |
+B<-cipher-algorithms> |
+B<-digest-algorithms> |
+B<-mac-algorithms> |
+B<-public-key-algorithms>
 
 B<openssl> B<no->I<XXX> [ I<arbitrary options> ]
 
@@ -36,8 +44,8 @@ It can be used for
 
 =head1 COMMAND SUMMARY
 
-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
+The B<openssl> program provides a rich variety of sub-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).
 
 Detailed documentation and use cases for most standard subcommands are available
@@ -77,7 +85,7 @@ availability of ciphers in the B<openssl> program.  (B<no->I<XXX> is
 not able to detect pseudo-commands such as B<quit>,
 B<list>, or B<no->I<XXX> itself.)
 
-=head2 Standard Commands
+=head2 Standard Sub-commands
 
 =over 4