diff options
Diffstat (limited to 'secure/lib/libcrypto/man/BUF_MEM_new.3')
| -rw-r--r-- | secure/lib/libcrypto/man/BUF_MEM_new.3 | 48 |
1 files changed, 26 insertions, 22 deletions
diff --git a/secure/lib/libcrypto/man/BUF_MEM_new.3 b/secure/lib/libcrypto/man/BUF_MEM_new.3 index b9016c9e35866..9c6b59ce0dac9 100644 --- a/secure/lib/libcrypto/man/BUF_MEM_new.3 +++ b/secure/lib/libcrypto/man/BUF_MEM_new.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} . \} .\} +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "BUF_MEM_NEW 3" -.TH BUF_MEM_NEW 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH BUF_MEM_NEW 3 "2019-02-26" "1.1.1b" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -157,39 +161,39 @@ BUF_MEM_new, BUF_MEM_new_ex, BUF_MEM_free, BUF_MEM_grow, BUF_MEM_grow_clean, BUF The buffer library handles simple character arrays. Buffers are used for various purposes in the library, most notably memory BIOs. .PP -\&\fIBUF_MEM_new()\fR allocates a new buffer of zero size. +\&\fBBUF_MEM_new()\fR allocates a new buffer of zero size. .PP -\&\fIBUF_MEM_new_ex()\fR allocates a buffer with the specified flags. +\&\fBBUF_MEM_new_ex()\fR allocates a buffer with the specified flags. The flag \fB\s-1BUF_MEM_FLAG_SECURE\s0\fR specifies that the \fBdata\fR pointer -should be allocated on the secure heap; see \fICRYPTO_secure_malloc\fR\|(3). +should be allocated on the secure heap; see \fBCRYPTO_secure_malloc\fR\|(3). .PP -\&\fIBUF_MEM_free()\fR frees up an already existing buffer. The data is zeroed +\&\fBBUF_MEM_free()\fR frees up an already existing buffer. The data is zeroed before freeing up in case the buffer contains sensitive data. .PP -\&\fIBUF_MEM_grow()\fR changes the size of an already existing buffer to +\&\fBBUF_MEM_grow()\fR changes the size of an already existing buffer to \&\fBlen\fR. Any data already in the buffer is preserved if it increases in size. .PP -\&\fIBUF_MEM_grow_clean()\fR is similar to \fIBUF_MEM_grow()\fR but it sets any free'd +\&\fBBUF_MEM_grow_clean()\fR is similar to \fBBUF_MEM_grow()\fR but it sets any free'd or additionally-allocated memory to zero. .PP -\&\fIBUF_reverse()\fR reverses \fBsize\fR bytes at \fBin\fR into \fBout\fR. If \fBin\fR +\&\fBBUF_reverse()\fR reverses \fBsize\fR bytes at \fBin\fR into \fBout\fR. If \fBin\fR is \s-1NULL,\s0 the array is reversed in-place. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fIBUF_MEM_new()\fR returns the buffer or \s-1NULL\s0 on error. +\&\fBBUF_MEM_new()\fR returns the buffer or \s-1NULL\s0 on error. .PP -\&\fIBUF_MEM_free()\fR has no return value. +\&\fBBUF_MEM_free()\fR has no return value. .PP -\&\fIBUF_MEM_grow()\fR and \fIBUF_MEM_grow_clean()\fR return +\&\fBBUF_MEM_grow()\fR and \fBBUF_MEM_grow_clean()\fR return zero on error or the new size (i.e., \fBlen\fR). .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fIbio\fR\|(7), -\&\fICRYPTO_secure_malloc\fR\|(3). +\&\fBbio\fR\|(7), +\&\fBCRYPTO_secure_malloc\fR\|(3). .SH "HISTORY" .IX Header "HISTORY" -\&\fIBUF_MEM_new_ex()\fR was added in OpenSSL 1.1.0. +The \fBBUF_MEM_new_ex()\fR function was added in OpenSSL 1.1.0. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved. |