Update docs: corrections, turn buffer docs into manpage, fold SHA1
[openssl.git] / doc / crypto / RSA_print.pod
1 =pod
2
3 =head1 NAME
4
5 RSA_print, RSA_print_fp, DHparams_print, DHparams_print_fp - Print
6 cryptographic parameters
7
8 =head1 SYNOPSIS
9
10  #include <openssl/rsa.h>
11
12  int RSA_print(BIO *bp, RSA *x, int offset);
13  int RSA_print_fp(FILE *fp, RSA *x, int offset);
14
15  #include <openssl/dsa.h>
16
17  int DSAparams_print(BIO *bp, DSA *x);
18  int DSAparams_print_fp(FILE *fp, DSA *x);
19  int DSA_print(BIO *bp, DSA *x, int offset);
20  int DSA_print_fp(FILE *fp, DSA *x, int offset);
21
22  #include <openssl/dh.h>
23
24  int DHparams_print(BIO *bp, DH *x);
25  int DHparams_print_fp(FILE *fp, DH *x);
26
27 =head1 DESCRIPTION
28
29 A human-readable hexadecimal output of the components of the RSA
30 key, DSA parameters or key or DH parameters is printed to B<bp> or B<fp>.
31
32 The output lines are indented by B<offset> spaces.
33
34 =head1 RETURN VALUES
35
36 These functions return 1 on success, 0 on error.
37
38 =head1 SEE ALSO
39
40 L<dh(3)|dh(3)>, L<dsa(3)|dsa(3)>, L<rsa(3)|rsa(3)>, L<BN_bn2bin(3)|BN_bn2bin(3)>
41
42 =head1 HISTORY
43
44 RSA_print(), RSA_print_fp(), DSA_print(), DSA_print_fp(), DH_print(),
45 DH_print_fp() are available in all versions of SSLeay and OpenSSL.
46 DSAparams_print() and DSAparams_print_pf() were added in SSLeay 0.8.
47
48 =cut