add RAND_status() to title
[openssl.git] / doc / crypto / RAND_add.pod
index 927c59d..16a8698 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RAND_add, RAND_seed, RAND_screen - Add entropy to the PRNG
+RAND_add, RAND_seed, RAND_status, RAND_screen - add entropy to the PRNG
 
 =head1 SYNOPSIS
 
@@ -12,6 +12,8 @@ RAND_add, RAND_seed, RAND_screen - Add entropy to the PRNG
 
  void RAND_add(const void *buf, int num, double entropy);
 
+ int  RAND_status(void);
+
  void RAND_screen(void);
 
 =head1 DESCRIPTION
@@ -32,7 +34,8 @@ passwords. The seed values cannot be recovered from the PRNG output.
 OpenSSL makes sure that the PRNG state is unique for each thread. On
 systems that provide C</dev/urandom>, the randomness device is used
 to seed the PRNG transparently. However, on all other systems, the
-application is responsible for seeding the PRNG by calling RAND_add()
+application is responsible for seeding the PRNG by calling RAND_add(),
+L<RAND_egd(3)|RAND_egd(3)>
 or L<RAND_load_file(3)|RAND_load_file(3)>.
 
 RAND_seed() is equivalent to RAND_add() when B<num == entropy>.
@@ -46,15 +49,20 @@ used on servers that run without user interaction.
 
 =head1 RETURN VALUES
 
-These functions do not return values.
+RAND_status() returns 1 if the PRNG has been seeded with enough data,
+0 otherwise.
+
+The other functions do not return values.
 
 =head1 SEE ALSO
 
-L<rand(3)|rand(3)>, L<RAND_load_file(3)|RAND_load_file(3)>, L<RAND_cleanup(3)|RAND_cleanup(3)>
+L<rand(3)|rand(3)>, L<RAND_egd(3)|RAND_egd(3)>,
+L<RAND_load_file(3)|RAND_load_file(3)>, L<RAND_cleanup(3)|RAND_cleanup(3)>
 
 =head1 HISTORY
 
 RAND_seed() and RAND_screen() are available in all versions of SSLeay
-and OpenSSL. RAND_add() was added in OpenSSL 0.9.5.
+and OpenSSL. RAND_add() and RAND_status() have been added in OpenSSL
+0.9.5.
 
 =cut