diff options
Diffstat (limited to 'secure/lib/libcrypto/man/err.3')
| -rw-r--r-- | secure/lib/libcrypto/man/err.3 | 89 |
1 files changed, 48 insertions, 41 deletions
diff --git a/secure/lib/libcrypto/man/err.3 b/secure/lib/libcrypto/man/err.3 index 57fadb6..67d408d 100644 --- a/secure/lib/libcrypto/man/err.3 +++ b/secure/lib/libcrypto/man/err.3 @@ -1,8 +1,7 @@ -.\" Automatically generated by Pod::Man version 1.15 -.\" Wed Mar 17 09:38:43 2004 +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 .\" .\" Standard preamble: -.\" ====================================================================== +.\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp @@ -15,12 +14,6 @@ .if t .sp .5v .if n .sp .. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. .de Vb \" Begin verbatim text .ft CW .nf @@ -28,15 +21,14 @@ .. .de Ve \" End verbatim text .ft R - .fi .. .\" 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<> +.\" 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 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ @@ -56,10 +48,10 @@ . ds R" '' 'br\} .\" -.\" 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 entries marked with X<> in POD. Of course, you'll have to process -.\" the output yourself in some meaningful fashion. +.\" 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 +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" @@ -68,14 +60,13 @@ . rr F .\} .\" -.\" For nroff, turn off justification. Always turn off hyphenation; it -.\" makes way too many mistakes in technical documents. +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. -.bd B 3 . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 @@ -135,11 +126,10 @@ . ds Ae AE .\} .rm #[ #] #H #V #F C -.\" ====================================================================== +.\" ======================================================================== .\" .IX Title "err 3" -.TH err 3 "0.9.7d" "2004-03-17" "OpenSSL" -.UC +.TH err 3 "2005-02-24" "0.9.7d" "OpenSSL" .SH "NAME" err \- error codes .SH "SYNOPSIS" @@ -147,6 +137,7 @@ err \- error codes .Vb 1 \& #include <openssl/err.h> .Ve +.PP .Vb 8 \& unsigned long ERR_get_error(void); \& unsigned long ERR_peek_error(void); @@ -157,36 +148,44 @@ err \- error codes \& 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); .Ve +.PP .Vb 1 \& 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); .Ve +.PP .Vb 2 \& 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); .Ve +.PP .Vb 1 \& 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, ...); .Ve +.PP .Vb 3 \& void ERR_load_strings(int lib,ERR_STRING_DATA str[]); \& unsigned long ERR_PACK(int lib, int func, int reason); @@ -199,18 +198,18 @@ by the return value, and an error code is stored in an error queue associated with the current thread. The \fBerr\fR library provides functions to obtain these error codes and textual error messages. .PP -The ERR_get_error(3) manpage describes how to +The \fIERR_get_error\fR\|(3) manpage describes how to access error codes. .PP Error codes contain information about where the error occurred, and -what went wrong. ERR_GET_LIB(3) describes how to +what went wrong. \s-1\fIERR_GET_LIB\s0\fR\|(3) describes how to extract this information. A method to obtain human-readable error -messages is described in ERR_error_string(3). +messages is described in \fIERR_error_string\fR\|(3). .PP -ERR_clear_error(3) can be used to clear the +\&\fIERR_clear_error\fR\|(3) can be used to clear the error queue. .PP -Note that ERR_remove_state(3) should be used to +Note that \fIERR_remove_state\fR\|(3) should be used to avoid memory leaks when threads are terminated. .SH "ADDING NEW ERROR CODES TO OPENSSL" .IX Header "ADDING NEW ERROR CODES TO OPENSSL" @@ -231,6 +230,7 @@ descriptions. For example, the function \fIssl23_read()\fR reports a .Vb 1 \& SSLerr(SSL_F_SSL23_READ, SSL_R_SSL_HANDSHAKE_FAILURE); .Ve +.PP Function and reason codes should consist of upper case characters, numbers and underscores only. The error file generation script translates function codes into function names by looking in the header files @@ -242,7 +242,7 @@ 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 -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 @@ -259,6 +259,7 @@ name to \fBERR_str_libraries[]\fR (in \fBcrypto/err/err.c\fR), and add .Vb 1 \& L XXX xxx.h xxx_err.c .Ve +.PP to \fBcrypto/err/openssl.ec\fR, and add \fBxxx_err.c\fR to the Makefile. Running \fBmake errors\fR will then generate a file \fBxxx_err.c\fR, and add all error codes used in the library to \fBxxx.h\fR. @@ -270,24 +271,30 @@ Typically it will initially look like this: \& #ifndef HEADER_XXX_H \& #define HEADER_XXX_H .Ve +.PP .Vb 3 \& #ifdef __cplusplus \& extern "C" { \& #endif .Ve +.PP .Vb 1 \& /* Include files */ .Ve +.PP .Vb 2 \& #include <openssl/bio.h> \& #include <openssl/x509.h> .Ve +.PP .Vb 1 \& /* Macros, structures and function prototypes */ .Ve +.PP .Vb 1 \& /* BEGIN ERROR CODES */ .Ve +.PP The \fB\s-1BEGIN\s0 \s-1ERROR\s0 \s-1CODES\s0\fR sequence is used by the error code generation script as the point to place new error codes, any text after this point will be overwritten when \fBmake errors\fR is run. @@ -320,15 +327,15 @@ be obtained by calling ERR_get_err_state_table(void) and ERR_get_string_table(void) respectively. .SH "SEE ALSO" .IX Header "SEE ALSO" -CRYPTO_set_id_callback(3), -CRYPTO_set_locking_callback(3), -ERR_get_error(3), -ERR_GET_LIB(3), -ERR_clear_error(3), -ERR_error_string(3), -ERR_print_errors(3), -ERR_load_crypto_strings(3), -ERR_remove_state(3), -ERR_put_error(3), -ERR_load_strings(3), -SSL_get_error(3) +\&\fICRYPTO_set_id_callback\fR\|(3), +\&\fICRYPTO_set_locking_callback\fR\|(3), +\&\fIERR_get_error\fR\|(3), +\&\s-1\fIERR_GET_LIB\s0\fR\|(3), +\&\fIERR_clear_error\fR\|(3), +\&\fIERR_error_string\fR\|(3), +\&\fIERR_print_errors\fR\|(3), +\&\fIERR_load_crypto_strings\fR\|(3), +\&\fIERR_remove_state\fR\|(3), +\&\fIERR_put_error\fR\|(3), +\&\fIERR_load_strings\fR\|(3), +\&\fISSL_get_error\fR\|(3) |
