Various RT doc fixes
[openssl.git] / doc / crypto / crypto.pod
index 101058f..6e23c1a 100644 (file)
@@ -21,42 +21,29 @@ individual algorithms.
 
 The functionality includes symmetric encryption, public key
 cryptography and key agreement, certificate handling, cryptographic
-hash functions and a cryptographic pseudo-random number generator.
+hash functions, cryptographic pseudo-random number generator, and
+various utilities.
 
-=over 4
+See the individual manual pages for details.
 
-=item SYMMETRIC CIPHERS
+=head1 NOTES
 
-blowfish(3), cast(3), des(3), idea(3), rc2(3), rc4(3), rc5(3)
+Some of the newer functions follow a naming convention using the numbers
+B<0> and B<1>. For example the functions:
 
-=item PUBLIC KEY CRYPTOGRAPHY AND KEY AGREEMENT
+ int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev);
+ int X509_add1_trust_object(X509 *x, ASN1_OBJECT *obj);
 
-dsa(3), dh(3), rsa(3)
+The B<0> version uses the supplied structure pointer directly
+in the parent and it will be freed up when the parent is freed.
+In the above example B<crl> would be freed but B<rev> would not.
 
-=item CERTIFICATES
-
-x509(3), x509v3(3)
-
-=item AUTHENTICATION CODES, HASH FUNCTIONS
-
-hmac(3), md2(3), md5(3), mdc2(3), ripemd(3), sha(3)
-
-=item AUXILIARY FUNCTIONS
-
-err(3), rand(3)
-
-=item INPUT/OUTPUT, DATA ENCODING
-
-asn1(3), bio(3), evp(3), pem(3), pkcs7(3), pkcs12(3)
-
-=item INTERNAL FUNCTIONS
-
-bn(3), buffer(3), lhash(3), objects(3), stack(3), threads(3), txt_db(3)
-
-=back
+The B<1> function uses a copy of the supplied structure pointer
+(or in some cases increases its link count) in the parent and
+so both (B<x> and B<obj> above) should be freed up.
 
 =head1 SEE ALSO
 
-openssl(1), ssl(3)
+L<openssl(1)>, L<ssl(3)>
 
 =cut