From: Richard Levitte <levitte@openssl.org>
Date: Mon, 20 Jun 2016 06:11:50 +0000 (+0200)
Subject: Change the RAND_file_name documentation accordingly
X-Git-Tag: OpenSSL_1_1_0-pre6~400
X-Git-Url: https://git.openssl.org/?p=openssl.git;a=commitdiff_plain;h=2be7014cc74bee7d1673b890978781136329b66c;hp=b8f304f70df820edb7740abcac31ed90073f3ecd;ds=sidebyside

Change the RAND_file_name documentation accordingly

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Andy Polyakov <appro@openssl.org>
---

diff --git a/doc/crypto/RAND_load_file.pod b/doc/crypto/RAND_load_file.pod
index dd79af28ae..39084b2c5d 100644
--- a/doc/crypto/RAND_load_file.pod
+++ b/doc/crypto/RAND_load_file.pod
@@ -20,15 +20,29 @@ RAND_file_name() generates a default path for the random seed
 file. B<buf> points to a buffer of size B<num> in which to store the
 filename.
 
-On Windows the seed file is %RANDFILE% if that environment variable is set.
-Otherwise the file is called ".rnd" in one of the following locations (in order
-of preference): %TMP%, %TEMP%, %USERPROFILE%, %SYSTEMROOT%, %HOME%, "C:".
+On all systems, if the environment variable B<RANDFILE> is set, its
+value will be used as the seed file name.
 
-On all other systems the seed file is $RANDFILE if that environment variable is
-set, $HOME/.rnd otherwise.
+Otherwise, the file is called ".rnd", found in platform dependent locations:
 
-If $HOME (on non Windows systems) is not set either, or B<num> is
-too small for the path name, an error occurs.
+=over 4
+
+=item On Windows (in order of preference)
+
+%HOME%, %USERPROFILE%, %SYSTEMROOT%, C:\
+
+=item On VMS
+
+SYS$LOGIN:
+
+=item On all other systems
+
+$HOME
+
+=back
+
+If C<$HOME> (on non-Windows and non-VMS system) is not set either, or
+B<num> is too small for the path name, an error occurs.
 
 RAND_load_file() reads a number of bytes from file B<filename> and
 adds them to the PRNG. If B<max_bytes> is non-negative,