summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarc Brooks <IDisposable@gmail.com>2023-05-10 17:48:00 -0500
committerPauli <pauli@openssl.org>2023-05-18 17:18:10 +1000
commit831ef5347253a9381c2ab6bd3ca74cbe10995939 (patch)
tree6409af018ebb7314294c9bf1d940733bd8fcb2c6 /doc
parent219db5e43c4f030a1c9c4a2f28249fd89b05ea0d (diff)
Add support for --version and synonyms
Just like --help is explicitly supported, we should support --version. This will greatly ease people adopting openssl. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20936)
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/openssl.pod24
1 files changed, 23 insertions, 1 deletions
diff --git a/doc/man1/openssl.pod b/doc/man1/openssl.pod
index 9bfd2f88a8..3d185bdc27 100644
--- a/doc/man1/openssl.pod
+++ b/doc/man1/openssl.pod
@@ -13,6 +13,8 @@ I<command>
B<openssl> B<no->I<XXX> [ I<options> ]
+B<openssl> B<-help> | B<-version>
+
=head1 DESCRIPTION
OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (SSL)
@@ -499,13 +501,33 @@ SM4 Cipher
Details of which options are available depend on the specific command.
This section describes some common options with common behavior.
-=head2 Common Options
+=head2 Program Options
+
+These options can be specified without a command specified to get help
+or version information.
=over 4
=item B<-help>
Provides a terse summary of all options.
+For more detailed information, each command supports a B<-help> option.
+Accepts B<--help> as well.
+
+=item B<-version>
+
+Provides a terse summary of the B<openssl> program version.
+For more detailed information see L<openssl-version(1)>.
+Accepts B<--version> as well.
+
+=back
+
+=head2 Common Options
+
+=over 4
+
+=item B<-help>
+
If an option takes an argument, the "type" of argument is also given.
=item B<-->