Add some missing env var documentation
authorRich Salz <rsalz@akamai.com>
Wed, 26 Feb 2020 20:25:43 +0000 (15:25 -0500)
committerTomas Mraz <tmraz@fedoraproject.org>
Wed, 4 Mar 2020 10:41:50 +0000 (11:41 +0100)
Reviewed-by: Paul Dale <paul.dale@oracle.com>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/11189)

doc/man1/CA.pl.pod
doc/man7/openssl-env.pod

index db444d5683794ca82c26144a257954221ad4db8c..4c53970890e82d635b90cfb472fbcbd87f65f38b 100644 (file)
@@ -174,11 +174,18 @@ Sign the request:
 
  CA.pl -signreq
 
+=head1 ENVIRONMENT
+
+The environment variable B<OPENSSL_CONFIG> may be used to specify a
+configuration option and value to the B<req> and B<ca> commands invoked by
+this script. It's value should be the option and pathname, as in
+C<-config /path/to/conf-file>.
+
 =head1 NOTES
 
 Most of the filenames mentioned can be modified by editing the B<CA.pl> script.
 
-If the demoCA directory already exists then the B<-newca> command will not
+If the F<demoCA> directory already exists then the B<-newca> command will not
 overwrite it and will do nothing. This can happen if a previous call using
 the B<-newca> option terminated abnormally. To get the correct behaviour
 delete the demoCA directory if it already exists.
index be89f85172de94cd537172a761483aded9c1b790..f59cd59610fb574559b2191a39dc877b4c23502b 100644 (file)
@@ -20,15 +20,22 @@ See L<CTLOG_STORE_new(3)>.
 
 =item B<OPENSSL>
 
-Specifies the path to the B<openssl> executable. Only used by
-the B<rehash> script.
-See L<openssl-rehash(1)/Script Configuration>.
+Specifies the path to the B<openssl> executable. Used by
+the B<rehash> script (see L<openssl-rehash(1)/Script Configuration>)
+and by the B<CA.pl> script (see L<CA.pl(1)/NOTES>
 
-=item B<OPENSSL_CONF>
+=item B<OPENSSL_CONF>, B<OPENSSL_CONF_INCLUDE>
 
-Specifies the path to a configuration file.
+Specifies the path to a configuration file and the directory for
+included files.
 See L<openssl(1)> and L<config(5)>.
 
+=item B<OPENSSL_CONFIG>
+
+Specifies a configuration option and filename for the B<req> and B<ca>
+commands invoked by the B<CA.pl> script.
+See L<CA.pl(1)>.
+
 =item B<OPENSSL_ENGINES>
 
 Specifies the directory from which dynamic engines are loaded.