the openssl man pages should mention the headers that need to be included in
order to use the function in question. the function prototypes should also be
indented slightly for the perl code to process things correctly (and match the
rest of the .pod file styles).
patch is against OpenSSL_0_9_8-stable
-mike
Index: doc/crypto/ASN1_OBJECT_new.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/ASN1_OBJECT_new.pod,v
retrieving revision 1.1
diff -u -p -r1.1 ASN1_OBJECT_new.pod
--- doc/crypto/ASN1_OBJECT_new.pod 9 Oct 2002 12:06:11 -0000 1.1
+++ doc/crypto/ASN1_OBJECT_new.pod 26 Oct 2009 10:42:42 -0000
@@ -6,6 +6,8 @@ ASN1_OBJECT_new, ASN1_OBJECT_free, - obj
=head1 SYNOPSIS
+ #include <openssl/asn1.h>
+
ASN1_OBJECT *ASN1_OBJECT_new(void);
void ASN1_OBJECT_free(ASN1_OBJECT *a);
Index: doc/crypto/ASN1_STRING_length.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/ASN1_STRING_length.pod,v
retrieving revision 1.1
diff -u -p -r1.1 ASN1_STRING_length.pod
--- doc/crypto/ASN1_STRING_length.pod 20 Oct 2002 13:20:56 -0000 1.1
+++ doc/crypto/ASN1_STRING_length.pod 26 Oct 2009 10:42:42 -0000
@@ -8,6 +8,8 @@ ASN1_STRING utility functions
=head1 SYNOPSIS
+ #include <openssl/asn1.h>
+
int ASN1_STRING_length(ASN1_STRING *x);
unsigned char * ASN1_STRING_data(ASN1_STRING *x);
Index: doc/crypto/ASN1_STRING_new.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/ASN1_STRING_new.pod,v
retrieving revision 1.1
diff -u -p -r1.1 ASN1_STRING_new.pod
--- doc/crypto/ASN1_STRING_new.pod 20 Oct 2002 13:20:56 -0000 1.1
+++ doc/crypto/ASN1_STRING_new.pod 26 Oct 2009 10:42:42 -0000
@@ -7,6 +7,8 @@ ASN1_STRING allocation functions
=head1 SYNOPSIS
+ #include <openssl/asn1.h>
+
ASN1_STRING * ASN1_STRING_new(void);
ASN1_STRING * ASN1_STRING_type_new(int type);
void ASN1_STRING_free(ASN1_STRING *a);
Index: doc/crypto/ASN1_generate_nconf.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/ASN1_generate_nconf.pod,v
retrieving revision 1.6.2.2
diff -u -p -r1.6.2.2 ASN1_generate_nconf.pod
--- doc/crypto/ASN1_generate_nconf.pod 23 Jan 2008 19:25:41 -0000 1.6.2.2
+++ doc/crypto/ASN1_generate_nconf.pod 26 Oct 2009 10:42:42 -0000
@@ -6,6 +6,8 @@ ASN1_generate_nconf, ASN1_generate_v3 -
=head1 SYNOPSIS
+ #include <openssl/asn1.h>
+
ASN1_TYPE *ASN1_generate_nconf(char *str, CONF *nconf);
ASN1_TYPE *ASN1_generate_v3(char *str, X509V3_CTX *cnf);
Index: doc/crypto/CRYPTO_set_ex_data.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/CRYPTO_set_ex_data.pod,v
retrieving revision 1.1
diff -u -p -r1.1 CRYPTO_set_ex_data.pod
--- doc/crypto/CRYPTO_set_ex_data.pod 30 Jan 2000 01:39:40 -0000 1.1
+++ doc/crypto/CRYPTO_set_ex_data.pod 26 Oct 2009 10:42:42 -0000
@@ -6,6 +6,8 @@ CRYPTO_set_ex_data, CRYPTO_get_ex_data -
=head1 SYNOPSIS
+ #include <openssl/crypto.h>
+
int CRYPTO_set_ex_data(CRYPTO_EX_DATA *r, int idx, void *arg);
void *CRYPTO_get_ex_data(CRYPTO_EX_DATA *r, int idx);
Index: doc/crypto/OBJ_nid2obj.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/OBJ_nid2obj.pod,v
retrieving revision 1.2
diff -u -p -r1.2 OBJ_nid2obj.pod
--- doc/crypto/OBJ_nid2obj.pod 20 Oct 2002 13:20:57 -0000 1.2
+++ doc/crypto/OBJ_nid2obj.pod 26 Oct 2009 10:42:42 -0000
@@ -8,6 +8,8 @@ functions
=head1 SYNOPSIS
+ #include <openssl/objects.h>
+
ASN1_OBJECT * OBJ_nid2obj(int n);
const char * OBJ_nid2ln(int n);
const char * OBJ_nid2sn(int n);
Index: doc/crypto/PKCS7_decrypt.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/PKCS7_decrypt.pod,v
retrieving revision 1.1
diff -u -p -r1.1 PKCS7_decrypt.pod
--- doc/crypto/PKCS7_decrypt.pod 9 Oct 2002 12:06:11 -0000 1.1
+++ doc/crypto/PKCS7_decrypt.pod 26 Oct 2009 10:42:42 -0000
@@ -6,7 +6,9 @@ PKCS7_decrypt - decrypt content from a P
=head1 SYNOPSIS
-int PKCS7_decrypt(PKCS7 *p7, EVP_PKEY *pkey, X509 *cert, BIO *data, int flags);
+ #include <openssl/pkcs7.h>
+
+ int PKCS7_decrypt(PKCS7 *p7, EVP_PKEY *pkey, X509 *cert, BIO *data, int flags);
=head1 DESCRIPTION
Index: doc/crypto/PKCS7_encrypt.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/PKCS7_encrypt.pod,v
retrieving revision 1.2
diff -u -p -r1.2 PKCS7_encrypt.pod
--- doc/crypto/PKCS7_encrypt.pod 9 Oct 2002 13:10:23 -0000 1.2
+++ doc/crypto/PKCS7_encrypt.pod 26 Oct 2009 10:42:42 -0000
@@ -6,7 +6,9 @@ PKCS7_encrypt - create a PKCS#7 envelope
=head1 SYNOPSIS
-PKCS7 *PKCS7_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher, int flags);
+ #include <openssl/pkcs7.h>
+
+ PKCS7 *PKCS7_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher, int flags);
=head1 DESCRIPTION
Index: doc/crypto/PKCS7_sign.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/PKCS7_sign.pod,v
retrieving revision 1.3
diff -u -p -r1.3 PKCS7_sign.pod
--- doc/crypto/PKCS7_sign.pod 15 Feb 2003 01:09:55 -0000 1.3
+++ doc/crypto/PKCS7_sign.pod 26 Oct 2009 10:42:42 -0000
@@ -6,7 +6,9 @@ PKCS7_sign - create a PKCS#7 signedData
=head1 SYNOPSIS
-PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, BIO *data, int flags);
+ #include <openssl/pkcs7.h>
+
+ PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, BIO *data, int flags);
=head1 DESCRIPTION
Index: doc/crypto/PKCS7_verify.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/PKCS7_verify.pod,v
retrieving revision 1.2.8.1
diff -u -p -r1.2.8.1 PKCS7_verify.pod
--- doc/crypto/PKCS7_verify.pod 15 Jan 2006 13:56:06 -0000 1.2.8.1
+++ doc/crypto/PKCS7_verify.pod 26 Oct 2009 10:42:42 -0000
@@ -6,9 +6,11 @@ PKCS7_verify - verify a PKCS#7 signedDat
=head1 SYNOPSIS
-int PKCS7_verify(PKCS7 *p7, STACK_OF(X509) *certs, X509_STORE *store, BIO *indata, BIO *out, int flags);
+ #include <openssl/pkcs7.h>
-STACK_OF(X509) *PKCS7_get0_signers(PKCS7 *p7, STACK_OF(X509) *certs, int flags);
+ int PKCS7_verify(PKCS7 *p7, STACK_OF(X509) *certs, X509_STORE *store, BIO *indata, BIO *out, int flags);
+
+ STACK_OF(X509) *PKCS7_get0_signers(PKCS7 *p7, STACK_OF(X509) *certs, int flags);
=head1 DESCRIPTION
Index: doc/crypto/SMIME_read_PKCS7.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/SMIME_read_PKCS7.pod,v
retrieving revision 1.1
diff -u -p -r1.1 SMIME_read_PKCS7.pod
--- doc/crypto/SMIME_read_PKCS7.pod 9 Oct 2002 12:06:11 -0000 1.1
+++ doc/crypto/SMIME_read_PKCS7.pod 26 Oct 2009 10:42:42 -0000
@@ -6,7 +6,9 @@ SMIME_read_PKCS7 - parse S/MIME message.
=head1 SYNOPSIS
-PKCS7 *SMIME_read_PKCS7(BIO *in, BIO **bcont);
+ #include <openssl/pkcs7.h>
+
+ PKCS7 *SMIME_read_PKCS7(BIO *in, BIO **bcont);
=head1 DESCRIPTION
Index: doc/crypto/SMIME_write_PKCS7.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/SMIME_write_PKCS7.pod,v
retrieving revision 1.3
diff -u -p -r1.3 SMIME_write_PKCS7.pod
--- doc/crypto/SMIME_write_PKCS7.pod 15 Feb 2003 01:09:55 -0000 1.3
+++ doc/crypto/SMIME_write_PKCS7.pod 26 Oct 2009 10:42:42 -0000
@@ -6,7 +6,9 @@ SMIME_write_PKCS7 - convert PKCS#7 struc
=head1 SYNOPSIS
-int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags);
+ #include <openssl/pkcs7.h>
+
+ int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags);
=head1 DESCRIPTION
Index: doc/crypto/X509_NAME_ENTRY_get_object.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/X509_NAME_ENTRY_get_object.pod,v
retrieving revision 1.3
diff -u -p -r1.3 X509_NAME_ENTRY_get_object.pod
--- doc/crypto/X509_NAME_ENTRY_get_object.pod 30 Mar 2005 11:50:14 -0000 1.3
+++ doc/crypto/X509_NAME_ENTRY_get_object.pod 26 Oct 2009 10:42:42 -0000
@@ -9,15 +9,17 @@ X509_NAME_ENTRY_create_by_OBJ - X509_NAM
=head1 SYNOPSIS
-ASN1_OBJECT * X509_NAME_ENTRY_get_object(X509_NAME_ENTRY *ne);
-ASN1_STRING * X509_NAME_ENTRY_get_data(X509_NAME_ENTRY *ne);
+ #include <openssl/x509.h>
-int X509_NAME_ENTRY_set_object(X509_NAME_ENTRY *ne, ASN1_OBJECT *obj);
-int X509_NAME_ENTRY_set_data(X509_NAME_ENTRY *ne, int type, const unsigned char *bytes, int len);
+ ASN1_OBJECT * X509_NAME_ENTRY_get_object(X509_NAME_ENTRY *ne);
+ ASN1_STRING * X509_NAME_ENTRY_get_data(X509_NAME_ENTRY *ne);
-X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_txt(X509_NAME_ENTRY **ne, const char *field, int type, const unsigned char *bytes, int len);
-X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_NID(X509_NAME_ENTRY **ne, int nid, int type,unsigned char *bytes, int len);
-X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_OBJ(X509_NAME_ENTRY **ne, ASN1_OBJECT *obj, int type, const unsigned char *bytes, int len);
+ int X509_NAME_ENTRY_set_object(X509_NAME_ENTRY *ne, ASN1_OBJECT *obj);
+ int X509_NAME_ENTRY_set_data(X509_NAME_ENTRY *ne, int type, const unsigned char *bytes, int len);
+
+ X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_txt(X509_NAME_ENTRY **ne, const char *field, int type, const unsigned char *bytes, int len);
+ X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_NID(X509_NAME_ENTRY **ne, int nid, int type,unsigned char *bytes, int len);
+ X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_OBJ(X509_NAME_ENTRY **ne, ASN1_OBJECT *obj, int type, const unsigned char *bytes, int len);
=head1 DESCRIPTION
Index: doc/crypto/X509_NAME_add_entry_by_txt.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/X509_NAME_add_entry_by_txt.pod,v
retrieving revision 1.3
diff -u -p -r1.3 X509_NAME_add_entry_by_txt.pod
--- doc/crypto/X509_NAME_add_entry_by_txt.pod 30 Mar 2005 11:50:14 -0000 1.3
+++ doc/crypto/X509_NAME_add_entry_by_txt.pod 26 Oct 2009 10:42:42 -0000
@@ -7,15 +7,17 @@ X509_NAME_add_entry, X509_NAME_delete_en
=head1 SYNOPSIS
-int X509_NAME_add_entry_by_txt(X509_NAME *name, const char *field, int type, const unsigned char *bytes, int len, int loc, int set);
+ #include <openssl/x509.h>
-int X509_NAME_add_entry_by_OBJ(X509_NAME *name, ASN1_OBJECT *obj, int type, unsigned char *bytes, int len, int loc, int set);
+ int X509_NAME_add_entry_by_txt(X509_NAME *name, const char *field, int type, const unsigned char *bytes, int len, int loc, int set);
-int X509_NAME_add_entry_by_NID(X509_NAME *name, int nid, int type, unsigned char *bytes, int len, int loc, int set);
+ int X509_NAME_add_entry_by_OBJ(X509_NAME *name, ASN1_OBJECT *obj, int type, unsigned char *bytes, int len, int loc, int set);
-int X509_NAME_add_entry(X509_NAME *name,X509_NAME_ENTRY *ne, int loc, int set);
+ int X509_NAME_add_entry_by_NID(X509_NAME *name, int nid, int type, unsigned char *bytes, int len, int loc, int set);
-X509_NAME_ENTRY *X509_NAME_delete_entry(X509_NAME *name, int loc);
+ int X509_NAME_add_entry(X509_NAME *name,X509_NAME_ENTRY *ne, int loc, int set);
+
+ X509_NAME_ENTRY *X509_NAME_delete_entry(X509_NAME *name, int loc);
=head1 DESCRIPTION
Index: doc/crypto/X509_NAME_get_index_by_NID.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/X509_NAME_get_index_by_NID.pod,v
retrieving revision 1.2
diff -u -p -r1.2 X509_NAME_get_index_by_NID.pod
--- doc/crypto/X509_NAME_get_index_by_NID.pod 13 Nov 2002 01:20:43 -0000 1.2
+++ doc/crypto/X509_NAME_get_index_by_NID.pod 26 Oct 2009 10:42:42 -0000
@@ -8,14 +8,16 @@ X509_NAME lookup and enumeration functio
=head1 SYNOPSIS
-int X509_NAME_get_index_by_NID(X509_NAME *name,int nid,int lastpos);
-int X509_NAME_get_index_by_OBJ(X509_NAME *name,ASN1_OBJECT *obj, int lastpos);
+ #include <openssl/x509.h>
-int X509_NAME_entry_count(X509_NAME *name);
-X509_NAME_ENTRY *X509_NAME_get_entry(X509_NAME *name, int loc);
+ int X509_NAME_get_index_by_NID(X509_NAME *name,int nid,int lastpos);
+ int X509_NAME_get_index_by_OBJ(X509_NAME *name,ASN1_OBJECT *obj, int lastpos);
-int X509_NAME_get_text_by_NID(X509_NAME *name, int nid, char *buf,int len);
-int X509_NAME_get_text_by_OBJ(X509_NAME *name, ASN1_OBJECT *obj, char *buf,int len);
+ int X509_NAME_entry_count(X509_NAME *name);
+ X509_NAME_ENTRY *X509_NAME_get_entry(X509_NAME *name, int loc);
+
+ int X509_NAME_get_text_by_NID(X509_NAME *name, int nid, char *buf,int len);
+ int X509_NAME_get_text_by_OBJ(X509_NAME *name, ASN1_OBJECT *obj, char *buf,int len);
=head1 DESCRIPTION
Index: doc/crypto/X509_new.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/X509_new.pod,v
retrieving revision 1.2
diff -u -p -r1.2 X509_new.pod
--- doc/crypto/X509_new.pod 13 Nov 2002 01:20:43 -0000 1.2
+++ doc/crypto/X509_new.pod 26 Oct 2009 10:42:42 -0000
@@ -6,6 +6,8 @@ X509_new, X509_free - X509 certificate A
=head1 SYNOPSIS
+ #include <openssl/x509.h>
+
X509 *X509_new(void);
void X509_free(X509 *a);
Index: doc/crypto/bn_internal.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/bn_internal.pod,v
retrieving revision 1.9
diff -u -p -r1.9 bn_internal.pod
--- doc/crypto/bn_internal.pod 7 Nov 2003 01:33:00 -0000 1.9
+++ doc/crypto/bn_internal.pod 26 Oct 2009 10:42:42 -0000
@@ -13,6 +13,8 @@ library internal functions
=head1 SYNOPSIS
+ #include <openssl/bn.h>
+
BN_ULONG bn_mul_words(BN_ULONG *rp, BN_ULONG *ap, int num, BN_ULONG w);
BN_ULONG bn_mul_add_words(BN_ULONG *rp, BN_ULONG *ap, int num,
BN_ULONG w);
Index: doc/crypto/ui_compat.pod
===================================================================
RCS file: /usr/local/src/openssl/CVSROOT/openssl/doc/crypto/ui_compat.pod,v
retrieving revision 1.2
diff -u -p -r1.2 ui_compat.pod
--- doc/crypto/ui_compat.pod 25 Oct 2001 16:56:06 -0000 1.2
+++ doc/crypto/ui_compat.pod 26 Oct 2009 10:42:42 -0000
@@ -7,6 +7,8 @@ Compatibility user interface functions
=head1 SYNOPSIS
+ #include <openssl/des_old.h>
+
int des_read_password(DES_cblock *key,const char *prompt,int verify);
int des_read_2passwords(DES_cblock *key1,DES_cblock *key2,
const char *prompt,int verify);
