From: Dmitry Belyavskiy <beldmit@gmail.com>
Date: Tue, 8 Apr 2025 09:15:28 +0000 (+0200)
Subject: configutl documentation
X-Git-Tag: openssl-3.6.0-alpha1~778
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=08616b09e02f896dc67f1602e1fa17f2eb5f1a66;p=thirdparty%2Fopenssl.git

configutl documentation

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/27290)
---

diff --git a/doc/build.info b/doc/build.info
index bff57d5d50f..95f3a7cfef9 100644
--- a/doc/build.info
+++ b/doc/build.info
@@ -40,6 +40,12 @@ DEPEND[man/man1/openssl-cms.1]=man1/openssl-cms.pod
 GENERATE[man/man1/openssl-cms.1]=man1/openssl-cms.pod
 DEPEND[man1/openssl-cms.pod]{pod}=man1/openssl-cms.pod.in
 GENERATE[man1/openssl-cms.pod]=man1/openssl-cms.pod.in
+DEPEND[html/man1/openssl-configutl.html]=man1/openssl-configutl.pod
+GENERATE[html/man1/openssl-configutl.html]=man1/openssl-configutl.pod
+DEPEND[man/man1/openssl-configutl.1]=man1/openssl-configutl.pod
+GENERATE[man/man1/openssl-configutl.1]=man1/openssl-configutl.pod
+DEPEND[man1/openssl-configutl.pod]{pod}=man1/openssl-configutl.pod.in
+GENERATE[man1/openssl-configutl.pod]=man1/openssl-configutl.pod.in
 DEPEND[html/man1/openssl-crl.html]=man1/openssl-crl.pod
 GENERATE[html/man1/openssl-crl.html]=man1/openssl-crl.pod
 DEPEND[man/man1/openssl-crl.1]=man1/openssl-crl.pod
@@ -360,6 +366,7 @@ html/man1/openssl-ciphers.html \
 html/man1/openssl-cmds.html \
 html/man1/openssl-cmp.html \
 html/man1/openssl-cms.html \
+html/man1/openssl-configutl.html \
 html/man1/openssl-crl.html \
 html/man1/openssl-crl2pkcs7.html \
 html/man1/openssl-dgst.html \
@@ -421,6 +428,7 @@ man/man1/openssl-ciphers.1 \
 man/man1/openssl-cmds.1 \
 man/man1/openssl-cmp.1 \
 man/man1/openssl-cms.1 \
+man/man1/openssl-configutl.1 \
 man/man1/openssl-crl.1 \
 man/man1/openssl-crl2pkcs7.1 \
 man/man1/openssl-dgst.1 \
diff --git a/doc/man1/build.info b/doc/man1/build.info
index ee6f243e20b..5c41a1687dd 100644
--- a/doc/man1/build.info
+++ b/doc/man1/build.info
@@ -8,6 +8,7 @@ DEPEND[openssl-ciphers.pod]=../perlvars.pm
 DEPEND[openssl-cmds.pod]=../perlvars.pm
 DEPEND[openssl-cmp.pod]=../perlvars.pm
 DEPEND[openssl-cms.pod]=../perlvars.pm
+DEPEND[openssl-configutl.pod]=../perlvars.pm
 DEPEND[openssl-crl2pkcs7.pod]=../perlvars.pm
 DEPEND[openssl-crl.pod]=../perlvars.pm
 DEPEND[openssl-dgst.pod]=../perlvars.pm
diff --git a/doc/man1/openssl-configutl.pod.in b/doc/man1/openssl-configutl.pod.in
new file mode 100644
index 00000000000..98f05bd8004
--- /dev/null
+++ b/doc/man1/openssl-configutl.pod.in
@@ -0,0 +1,72 @@
+=pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
+
+=head1 NAME
+
+openssl-configutl - openssl configuration file helper command
+
+=head1 SYNOPSIS
+
+B<openssl> B<configutl>
+[B<-help>]
+[B<-config> I<filename>]
+[B<-out> I<filename>]
+[B<-noheader>]
+
+=head1 DESCRIPTION
+
+Real world openssl configuration files with use of the B<.include> directive
+are quite complex, and there is a need to see the resulting system-wide configuration.
+
+This tool is designed for managing OpenSSL configuration files. Currently it
+processes a configuration file with possibly complex structure and dumps an effective
+resulting configuration file, to stdout by default.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-help>
+
+Print out a usage message.
+
+=item B<-config> I<filename>
+
+The configuration file to deal with. If omitted, the compiled one or the one defined
+via the B<OPENSSL_CONF> environment variable is used.
+
+=item B<-out> I<filename>
+
+The output file to be used instead of stdout.
+
+=item B<-noheader>
+
+Don't print information about the original config file to be processed.
+
+=back
+
+=head1 EXAMPLES
+
+Dump the configuration file I<my.conf> processing all B<.include> directives to the
+file B<result.conf>
+
+ openssl configutl -config my.conf -out result.conf
+
+=head1 SEE ALSO
+
+L<config(5)>
+
+=head1 HISTORY
+
+The B<configutl> command was added in OpenSSL 3.6.
+
+=head1 COPYRIGHT
+
+Copyright 2025 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