Update build for OpenSSL-1.0.0a.
[dragonfly.git] / secure / lib / libcrypto / man / err.3
index f615834..75183ff 100644 (file)
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 .\"
 .\" Standard preamble:
 .\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  | will give a
-.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
-.tr \(*W-|\(bv\*(Tr
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
 .    ds R" ''
 'br\}
 .\"
 .    ds R" ''
 'br\}
 .\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
 .\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+.    de IX
+..
+.\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\" ========================================================================
 .\"
 .IX Title "err 3"
 .\" ========================================================================
 .\"
 .IX Title "err 3"
-.TH err 3 "2008-09-27" "0.9.8i" "OpenSSL"
+.TH err 3 "2010-06-01" "1.0.0a" "OpenSSL"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
 .SH "NAME"
 err \- error codes
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 1
 \& #include <openssl/err.h>
 .SH "NAME"
 err \- error codes
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 1
 \& #include <openssl/err.h>
-.Ve
-.PP
-.Vb 8
+\&
 \& unsigned long ERR_get_error(void);
 \& unsigned long ERR_peek_error(void);
 \& unsigned long ERR_get_error_line(const char **file, int *line);
 \& unsigned long ERR_get_error(void);
 \& unsigned long ERR_peek_error(void);
 \& unsigned long ERR_get_error_line(const char **file, int *line);
@@ -147,46 +144,30 @@ err \- error codes
 \&         const char **data, int *flags);
 \& unsigned long ERR_peek_error_line_data(const char **file, int *line,
 \&         const char **data, int *flags);
 \&         const char **data, int *flags);
 \& unsigned long ERR_peek_error_line_data(const char **file, int *line,
 \&         const char **data, int *flags);
-.Ve
-.PP
-.Vb 3
+\&
 \& int ERR_GET_LIB(unsigned long e);
 \& int ERR_GET_FUNC(unsigned long e);
 \& int ERR_GET_REASON(unsigned long e);
 \& int ERR_GET_LIB(unsigned long e);
 \& int ERR_GET_FUNC(unsigned long e);
 \& int ERR_GET_REASON(unsigned long e);
-.Ve
-.PP
-.Vb 1
+\&
 \& void ERR_clear_error(void);
 \& void ERR_clear_error(void);
-.Ve
-.PP
-.Vb 4
+\&
 \& char *ERR_error_string(unsigned long e, char *buf);
 \& const char *ERR_lib_error_string(unsigned long e);
 \& const char *ERR_func_error_string(unsigned long e);
 \& const char *ERR_reason_error_string(unsigned long e);
 \& char *ERR_error_string(unsigned long e, char *buf);
 \& const char *ERR_lib_error_string(unsigned long e);
 \& const char *ERR_func_error_string(unsigned long e);
 \& const char *ERR_reason_error_string(unsigned long e);
-.Ve
-.PP
-.Vb 2
+\&
 \& void ERR_print_errors(BIO *bp);
 \& void ERR_print_errors_fp(FILE *fp);
 \& void ERR_print_errors(BIO *bp);
 \& void ERR_print_errors_fp(FILE *fp);
-.Ve
-.PP
-.Vb 2
+\&
 \& void ERR_load_crypto_strings(void);
 \& void ERR_free_strings(void);
 \& void ERR_load_crypto_strings(void);
 \& void ERR_free_strings(void);
-.Ve
-.PP
-.Vb 1
+\&
 \& void ERR_remove_state(unsigned long pid);
 \& void ERR_remove_state(unsigned long pid);
-.Ve
-.PP
-.Vb 3
+\&
 \& void ERR_put_error(int lib, int func, int reason, const char *file,
 \&         int line);
 \& void ERR_add_error_data(int num, ...);
 \& void ERR_put_error(int lib, int func, int reason, const char *file,
 \&         int line);
 \& void ERR_add_error_data(int num, ...);
-.Ve
-.PP
-.Vb 3
+\&
 \& void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
 \& unsigned long ERR_PACK(int lib, int func, int reason);
 \& int ERR_get_next_error_library(void);
 \& void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
 \& unsigned long ERR_PACK(int lib, int func, int reason);
 \& int ERR_get_next_error_library(void);
@@ -218,7 +199,7 @@ OpenSSL error system from within your application.
 .PP
 The remainder of this section is of interest only if you want to add
 new error codes to OpenSSL or add error codes from external libraries.
 .PP
 The remainder of this section is of interest only if you want to add
 new error codes to OpenSSL or add error codes from external libraries.
-.Sh "Reporting errors"
+.SS "Reporting errors"
 .IX Subsection "Reporting errors"
 Each sub-library has a specific macro \fIXXXerr()\fR that is used to report
 errors. Its first argument is a function code \fB\s-1XXX_F_\s0...\fR, the second
 .IX Subsection "Reporting errors"
 Each sub-library has a specific macro \fIXXXerr()\fR that is used to report
 errors. Its first argument is a function code \fB\s-1XXX_F_\s0...\fR, the second
@@ -242,13 +223,13 @@ into lower case and underscores changed to spaces.
 .PP
 When you are using new function or reason codes, run \fBmake errors\fR.
 The necessary \fB#define\fRs will then automatically be added to the
 .PP
 When you are using new function or reason codes, run \fBmake errors\fR.
 The necessary \fB#define\fRs will then automatically be added to the
-sub\-library's header file.
+sub-library's header file.
 .PP
 Although a library will normally report errors using its own specific
 XXXerr macro, another library's macro can be used. This is normally
 only done when a library wants to include \s-1ASN1\s0 code which must use
 the \fIASN1err()\fR macro.
 .PP
 Although a library will normally report errors using its own specific
 XXXerr macro, another library's macro can be used. This is normally
 only done when a library wants to include \s-1ASN1\s0 code which must use
 the \fIASN1err()\fR macro.
-.Sh "Adding new libraries"
+.SS "Adding new libraries"
 .IX Subsection "Adding new libraries"
 When adding a new sub-library to OpenSSL, assign it a library number
 \&\fB\s-1ERR_LIB_XXX\s0\fR, define a macro \fIXXXerr()\fR (both in \fBerr.h\fR), add its
 .IX Subsection "Adding new libraries"
 When adding a new sub-library to OpenSSL, assign it a library number
 \&\fB\s-1ERR_LIB_XXX\s0\fR, define a macro \fIXXXerr()\fR (both in \fBerr.h\fR), add its
@@ -270,28 +251,19 @@ Typically it will initially look like this:
 .Vb 2
 \& #ifndef HEADER_XXX_H
 \& #define HEADER_XXX_H
 .Vb 2
 \& #ifndef HEADER_XXX_H
 \& #define HEADER_XXX_H
-.Ve
-.PP
-.Vb 3
-\& #ifdef __cplusplus
+\&
+\& #ifdef _\|_cplusplus
 \& extern "C" {
 \& #endif
 \& extern "C" {
 \& #endif
-.Ve
-.PP
-.Vb 1
+\&
 \& /* Include files */
 \& /* Include files */
-.Ve
-.PP
-.Vb 2
+\&
 \& #include <openssl/bio.h>
 \& #include <openssl/x509.h>
 \& #include <openssl/bio.h>
 \& #include <openssl/x509.h>
-.Ve
-.PP
-.Vb 1
+\&
 \& /* Macros, structures and function prototypes */
 \& /* Macros, structures and function prototypes */
-.Ve
-.PP
-.Vb 1
+\&
+\&
 \& /* BEGIN ERROR CODES */
 .Ve
 .PP
 \& /* BEGIN ERROR CODES */
 .Ve
 .PP