RSA_print etc
[openssl.git] / doc / crypto / RSA_print.pod
index 2361daa10e3bfacf5515cf5b4096af64d0235248..67203a8ada22359dd90f42cbc68b1ab9713f9206 100644 (file)
@@ -2,30 +2,44 @@
 
 =head1 NAME
 
-RSA_print, RSA_print_fp - Print RSA key
+RSA_print, RSA_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 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 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
 
-...
+dh(3), dsa(3), rsa(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.
 
 =cut