fix documentation

[openssl.git] / doc / crypto / RSA_print.pod

diff --git a/doc/crypto/RSA_print.pod b/doc/crypto/RSA_print.pod
index 2361daa10e3bfacf5515cf5b4096af64d0235248..c971e91f4db6857ae99e2d5ad1bdc1861cc29969 100644 (file)
--- a/doc/crypto/RSA_print.pod
+++ b/doc/crypto/RSA_print.pod
@@ -2,30 +2,48 @@
 
 =head1 NAME
 
-RSA_print, RSA_print_fp - Print RSA key
+RSA_print, RSA_print_fp,
+DSAparams_print, DSAparams_print_fp, DSA_print, DSA_print_fp,
+DHparams_print, DHparams_print_fp - print cryptographic parameters
 
 =head1 SYNOPSIS
 
  #include <openssl/rsa.h>
 
  int RSA_print(BIO *bp, RSA *x, int offset);
-
  int RSA_print_fp(FILE *fp, RSA *x, int offset);
 
+ #include <openssl/dsa.h>
+
+ int DSAparams_print(BIO *bp, DSA *x);
+ int DSAparams_print_fp(FILE *fp, DSA *x);
+ int DSA_print(BIO *bp, DSA *x, int offset);
+ int DSA_print_fp(FILE *fp, DSA *x, int offset);
+
+ #include <openssl/dh.h>
+
+ int DHparams_print(BIO *bp, DH *x);
+ int DHparams_print_fp(FILE *fp, DH *x);
+
 =head1 DESCRIPTION
 
-...
+A human-readable hexadecimal output of the components of the RSA
+key, DSA parameters or key or DH parameters is printed to B<bp> or B<fp>.
+
+The output lines are indented by B<offset> spaces.
 
 =head1 RETURN VALUES
 
-...
+These functions return 1 on success, 0 on error.
 
 =head1 SEE ALSO
 
-...
+L<dh(3)|dh(3)>, L<dsa(3)|dsa(3)>, L<rsa(3)|rsa(3)>, L<BN_bn2bin(3)|BN_bn2bin(3)>
 
 =head1 HISTORY
 
-...
+RSA_print(), RSA_print_fp(), DSA_print(), DSA_print_fp(), DH_print(),
+DH_print_fp() are available in all versions of SSLeay and OpenSSL.
+DSAparams_print() and DSAparams_print_fp() were added in SSLeay 0.8.
 
 =cut