summaryrefslogtreecommitdiffstats
path: root/doc/man1/openssl-info.pod.in
diff options
context:
space:
mode:
authorPauli <paul.dale@oracle.com>2020-02-27 07:45:31 +1000
committerPauli <paul.dale@oracle.com>2020-03-07 11:46:47 +1000
commit5e98904c231f5a40c6ce291df85799cca7c8d125 (patch)
tree70e2069ad42554c250543a44a2d4607ed5b39390 /doc/man1/openssl-info.pod.in
parent55f02cb6849f0366dd8b787dbe8e74b56c15bfd1 (diff)
man1: make all openssl command line tool documentation generated.
With the introduction of provider command line options which are applicable to almost all of the command line tools, it seemed reasonable to make them all generated. This simplifes the .gitignore and avoids having to keep two lists in sync. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/11167)
Diffstat (limited to 'doc/man1/openssl-info.pod.in')
-rw-r--r--doc/man1/openssl-info.pod.in91
1 files changed, 91 insertions, 0 deletions
diff --git a/doc/man1/openssl-info.pod.in b/doc/man1/openssl-info.pod.in
new file mode 100644
index 0000000000..c8965b2ab6
--- /dev/null
+++ b/doc/man1/openssl-info.pod.in
@@ -0,0 +1,91 @@
+=pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
+
+=head1 NAME
+
+openssl-info - print OpenSSL built-in information
+
+=head1 SYNOPSIS
+
+B<openssl info>
+[B<-help>]
+[B<-configdir>]
+[B<-enginesdir>]
+[B<-modulesdir> ]
+[B<-dsoext>]
+[B<-dirnamesep>]
+[B<-listsep>]
+[B<-seeds>]
+[B<-cpusettings>]
+
+=head1 DESCRIPTION
+
+This command is used to print out information about OpenSSL.
+The information is written exactly as it is with no extra text, which
+makes useful for scripts.
+
+As a consequence, only one item may be chosen for each run of this
+command.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-help>
+
+Print out a usage message.
+
+=item B<-configdir>
+
+Outputs the default directory for OpenSSL configuration files.
+
+=item B<-enginesdir>
+
+Outputs the default directory for OpenSSL engine modules.
+
+=item B<-modulesdir>
+
+Outputs the default directory for OpenSSL dynamically loadable modules
+other than engine modules.
+
+=item B<-dsoext>
+
+Outputs the DSO extension OpenSSL uses.
+
+=item B<-dirnamesep>
+
+Outputs the separator character between a directory specification and
+a filename.
+Note that on some operating systems, this is not the same as the
+separator between directory elements.
+
+=item B<-listsep>
+
+Outputs the OpenSSL list separator character.
+This is typically used to construct C<$PATH> (C<%PATH%> on Windows)
+style lists.
+
+=item B<-seeds>
+
+Outputs the randomness seed sources.
+
+=item B<-cpusettings>
+
+Outputs the OpenSSL CPU settings info.
+
+=back
+
+=head1 HISTORY
+
+This command was added in OpenSSL 3.0.
+
+=head1 COPYRIGHT
+
+Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
+
+Licensed under the Apache License 2.0 (the "License"). You may not use
+this file except in compliance with the License. You can obtain a copy
+in the file LICENSE in the source distribution or at
+L<https://www.openssl.org/source/license.html>.
+
+=cut