diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/ERR_put_error.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/ERR_put_error.3 | 138 |
1 files changed, 31 insertions, 107 deletions
diff --git a/secure/lib/libcrypto/man/man3/ERR_put_error.3 b/secure/lib/libcrypto/man/man3/ERR_put_error.3 index 8c01af8c592b..81aaf9d8b7dc 100644 --- a/secure/lib/libcrypto/man/man3/ERR_put_error.3 +++ b/secure/lib/libcrypto/man/man3/ERR_put_error.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .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. \*(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' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,80 +52,20 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ERR_PUT_ERROR 3ossl" -.TH ERR_PUT_ERROR 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH ERR_PUT_ERROR 3ossl 2025-07-01 3.5.1 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" +.SH NAME ERR_raise, ERR_raise_data, ERR_put_error, ERR_add_error_data, ERR_add_error_vdata, ERR_add_error_txt, ERR_add_error_mem_bio \&\- record an error -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/err.h> @@ -156,13 +80,13 @@ ERR_add_error_txt, ERR_add_error_mem_bio .Ve .PP The following function has been deprecated since OpenSSL 3.0, and can be -hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, +hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value, see \fBopenssl_user_macros\fR\|(7): .PP .Vb 1 \& void ERR_put_error(int lib, int func, int reason, const char *file, int line); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBERR_raise()\fR adds a new error to the thread's error queue. The error occurred in the library \fBlib\fR for the reason given by the @@ -187,16 +111,16 @@ The total length of the string data per error is limited to 4096 characters. .PP \&\fBERR_add_error_txt()\fR appends the given text string as additional data to the last error queue entry, after inserting the optional separator string if it is -not \s-1NULL\s0 and the top error entry does not yet have additional data. +not NULL and the top error entry does not yet have additional data. In case the separator is at the end of the text it is not appended to the data. -The \fBsep\fR argument may be for instance \*(L"\en\*(R" to insert a line break when needed. +The \fBsep\fR argument may be for instance "\en" to insert a line break when needed. If the associated data would become more than 4096 characters long (which is the limit given above) it is split over sufficiently many new copies of the last error queue entry. .PP \&\fBERR_add_error_mem_bio()\fR is the same as \fBERR_add_error_txt()\fR except that -the text string is taken from the given memory \s-1BIO.\s0 -It appends '\e0' to the \s-1BIO\s0 contents if not already NUL-terminated. +the text string is taken from the given memory BIO. +It appends '\e0' to the BIO contents if not already NUL-terminated. .PP \&\fBERR_load_strings\fR\|(3) can be used to register error strings so that the application can a generate human-readable @@ -206,31 +130,31 @@ error messages for the error code. \fIOpenSSL library reports\fR .IX Subsection "OpenSSL library reports" .PP -Each OpenSSL sub-library has library code \fB\s-1ERR_LIB_XXX\s0\fR and has its own set -of reason codes \fB\s-1XXX_R_...\s0\fR. These are both passed in combination to +Each OpenSSL sub-library has library code \fBERR_LIB_XXX\fR and has its own set +of reason codes \fBXXX_R_...\fR. These are both passed in combination to \&\fBERR_raise()\fR and \fBERR_raise_data()\fR, and the combination ultimately produces the correct error text for the reported error. .PP All these macros and the numbers they have as values are specific to OpenSSL's libraries. OpenSSL reason codes normally consist of textual error descriptions. For example, the function \fBssl3_read_bytes()\fR reports a -\&\*(L"handshake failure\*(R" as follows: +"handshake failure" as follows: .PP .Vb 1 \& ERR_raise(ERR_LIB_SSL, SSL_R_SSL_HANDSHAKE_FAILURE); .Ve .PP There are two exceptions: -.IP "\fB\s-1ERR_LIB_SYS\s0\fR" 4 +.IP \fBERR_LIB_SYS\fR 4 .IX Item "ERR_LIB_SYS" -This \*(L"library code\*(R" indicates that a system error is being reported. In +This "library code" indicates that a system error is being reported. In this case, the reason code given to \fBERR_raise()\fR and \fBERR_raise_data()\fR \fImust\fR be \fBerrno\fR\|(3). .Sp .Vb 1 \& ERR_raise(ERR_LIB_SYS, errno); .Ve -.IP "\fB\s-1ERR_R_XXX\s0\fR" 4 +.IP \fBERR_R_XXX\fR 4 .IX Item "ERR_R_XXX" This set of error codes is considered global, and may be used in combination with any sub-library code. @@ -245,23 +169,23 @@ with any sub-library code. Other pieces of software that may want to use OpenSSL's error reporting system, such as engines or applications, must normally get their own numbers. -.IP "\(bu" 4 -To get a \*(L"library\*(R" code, call \fBERR_get_next_error_library\fR\|(3); this gives +.IP \(bu 4 +To get a "library" code, call \fBERR_get_next_error_library\fR\|(3); this gives the calling code a dynamic number, usable for the duration of the process. -.IP "\(bu" 4 -Reason codes for each such \*(L"library\*(R" are determined or generated by the +.IP \(bu 4 +Reason codes for each such "library" are determined or generated by the authors of that code. They must be numbers in the range 1 to 524287 (in other words, they must be nonzero unsigned 18 bit integers). .PP -The exceptions mentioned in \*(L"OpenSSL library reports\*(R" above are valid for -other pieces of software, i.e. they may use \fB\s-1ERR_LIB_SYS\s0\fR to report system +The exceptions mentioned in "OpenSSL library reports" above are valid for +other pieces of software, i.e. they may use \fBERR_LIB_SYS\fR to report system errors: .PP .Vb 1 \& ERR_raise(ERR_LIB_SYS, errno); .Ve .PP -\&... and they may use \fB\s-1ERR_R_XXX\s0\fR macros together with their own \*(L"library\*(R" +\&... and they may use \fBERR_R_XXX\fR macros together with their own "library" code. .PP .Vb 1 @@ -277,21 +201,21 @@ code. \&\fBERR_add_error_data()\fR, \fBERR_add_error_vdata()\fR \&\fBERR_add_error_txt()\fR, and \fBERR_add_error_mem_bio()\fR return no values. -.SH "NOTES" +.SH NOTES .IX Header "NOTES" \&\fBERR_raise()\fR, \fBERR_raise()\fR and \fBERR_put_error()\fR are implemented as macros. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBERR_load_strings\fR\|(3), \fBERR_get_next_error_library\fR\|(3) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" ERR_raise, ERR_raise_data, \fBERR_add_error_txt()\fR and \fBERR_add_error_mem_bio()\fR were added in OpenSSL 3.0. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |