nicer manpages
[openssl.git] / doc / crypto / DH_generate_parameters.pod
index 7523bb2fe03d9974057957ab476b0e5987a996f7..a7d0c75f0cb3f7e3f9919ad6738e72e8786f8496 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DH_generate_parameters, DH_check - Generate and check Diffie-Hellman parameters
+DH_generate_parameters, DH_check - generate and check Diffie-Hellman parameters
 
 =head1 SYNOPSIS
 
@@ -25,7 +25,7 @@ B<generator> is a small number E<gt> 1, typically 2 or 5.
 
 A callback function may be used to provide feedback about the progress
 of the key generation. If B<callback> is not B<NULL>, it will be
-called as described in L<BN_generate_prime(3)> while a random prime
+called as described in L<BN_generate_prime(3)|BN_generate_prime(3)> while a random prime
 number is generated, and when a prime has been found, B<callback(3,
 0, cb_arg)> is called.
 
@@ -40,7 +40,7 @@ checked, i.e. it does not equal 2 or 5.
 
 DH_generate_parameters() returns a pointer to the DH structure, or
 NULL if the parameter generation fails. The error codes can be
-obtained by ERR_get_error(3).
+obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
 
 DH_check() returns 1 if the check could be performed, 0 otherwise.
 
@@ -52,9 +52,14 @@ suitable prime.
 The parameters generated by DH_generate_parameters() are not to be
 used in signature schemes.
 
+=head1 BUGS
+
+If B<generator> is not 2 or 5, B<dh-E<gt>g>=B<generator> is not
+a usable generator.
+
 =head1 SEE ALSO
 
-dh(3), err(3), rand(3), DH_free(3)
+L<dh(3)|dh(3)>, L<err(3)|err(3)>, L<rand(3)|rand(3)>, L<DH_free(3)|DH_free(3)>
 
 =head1 HISTORY