diff options
Diffstat (limited to 'secure/lib/libcrypto/man/BIO_ADDR.3')
-rw-r--r-- | secure/lib/libcrypto/man/BIO_ADDR.3 | 62 |
1 files changed, 33 insertions, 29 deletions
diff --git a/secure/lib/libcrypto/man/BIO_ADDR.3 b/secure/lib/libcrypto/man/BIO_ADDR.3 index cc36a3cc8506e..f6571c41d30ea 100644 --- a/secure/lib/libcrypto/man/BIO_ADDR.3 +++ b/secure/lib/libcrypto/man/BIO_ADDR.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 "BIO_ADDR 3" -.TH BIO_ADDR 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH BIO_ADDR 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 @@ -163,31 +167,31 @@ addresses that OpenSSL deals with, currently transparently supporting \s-1AF_INET, AF_INET6\s0 and \s-1AF_UNIX\s0 according to what's available on the platform at hand. .PP -\&\fIBIO_ADDR_new()\fR creates a new unfilled \fB\s-1BIO_ADDR\s0\fR, to be used +\&\fBBIO_ADDR_new()\fR creates a new unfilled \fB\s-1BIO_ADDR\s0\fR, to be used with routines that will fill it with information, such as -\&\fIBIO_accept_ex()\fR. +\&\fBBIO_accept_ex()\fR. .PP -\&\fIBIO_ADDR_free()\fR frees a \fB\s-1BIO_ADDR\s0\fR created with \fIBIO_ADDR_new()\fR. +\&\fBBIO_ADDR_free()\fR frees a \fB\s-1BIO_ADDR\s0\fR created with \fBBIO_ADDR_new()\fR. .PP -\&\fIBIO_ADDR_clear()\fR clears any data held within the provided \fB\s-1BIO_ADDR\s0\fR and sets +\&\fBBIO_ADDR_clear()\fR clears any data held within the provided \fB\s-1BIO_ADDR\s0\fR and sets it back to an uninitialised state. .PP -\&\fIBIO_ADDR_rawmake()\fR takes a protocol \fBfamily\fR, an byte array of +\&\fBBIO_ADDR_rawmake()\fR takes a protocol \fBfamily\fR, an byte array of size \fBwherelen\fR with an address in network byte order pointed at by \fBwhere\fR and a port number in network byte order in \fBport\fR (except for the \fB\s-1AF_UNIX\s0\fR protocol family, where \fBport\fR is meaningless and therefore ignored) and populates the given \fB\s-1BIO_ADDR\s0\fR with them. In case this creates a \fB\s-1AF_UNIX\s0\fR \fB\s-1BIO_ADDR\s0\fR, \fBwherelen\fR is expected to be the length of the path string (not including the terminating -\&\s-1NUL,\s0 such as the result of a call to \fIstrlen()\fR). +\&\s-1NUL,\s0 such as the result of a call to \fBstrlen()\fR). \&\fIRead on about the addresses in \*(L"\s-1RAW ADDRESSES\*(R"\s0 below\fR. .PP -\&\fIBIO_ADDR_family()\fR returns the protocol family of the given +\&\fBBIO_ADDR_family()\fR returns the protocol family of the given \&\fB\s-1BIO_ADDR\s0\fR. The possible non-error results are one of the constants \s-1AF_INET, AF_INET6\s0 and \s-1AF_UNIX.\s0 It will also return \s-1AF_UNSPEC\s0 if the \&\s-1BIO_ADDR\s0 has not been initialised. .PP -\&\fIBIO_ADDR_rawaddress()\fR will write the raw address of the given +\&\fBBIO_ADDR_rawaddress()\fR will write the raw address of the given \&\fB\s-1BIO_ADDR\s0\fR in the area pointed at by \fBp\fR if \fBp\fR is non-NULL, and will set \fB*l\fR to be the amount of bytes the raw address takes up if \fBl\fR is non-NULL. @@ -196,41 +200,41 @@ with \fBp\fR set to \fB\s-1NULL\s0\fR. The raw address will be in network byte order, most significant byte first. In case this is a \fB\s-1AF_UNIX\s0\fR \fB\s-1BIO_ADDR\s0\fR, \fBl\fR gets the length of the path string (not including the terminating \s-1NUL,\s0 such as the result of -a call to \fIstrlen()\fR). +a call to \fBstrlen()\fR). \&\fIRead on about the addresses in \*(L"\s-1RAW ADDRESSES\*(R"\s0 below\fR. .PP -\&\fIBIO_ADDR_rawport()\fR returns the raw port of the given \fB\s-1BIO_ADDR\s0\fR. +\&\fBBIO_ADDR_rawport()\fR returns the raw port of the given \fB\s-1BIO_ADDR\s0\fR. The raw port will be in network byte order. .PP -\&\fIBIO_ADDR_hostname_string()\fR returns a character string with the +\&\fBBIO_ADDR_hostname_string()\fR returns a character string with the hostname of the given \fB\s-1BIO_ADDR\s0\fR. If \fBnumeric\fR is 1, the string will contain the numerical form of the address. This only works for \&\fB\s-1BIO_ADDR\s0\fR of the protocol families \s-1AF_INET\s0 and \s-1AF_INET6.\s0 The returned string has been allocated on the heap and must be freed -with \fIOPENSSL_free()\fR. +with \fBOPENSSL_free()\fR. .PP -\&\fIBIO_ADDR_service_string()\fR returns a character string with the +\&\fBBIO_ADDR_service_string()\fR returns a character string with the service name of the port of the given \fB\s-1BIO_ADDR\s0\fR. If \fBnumeric\fR is 1, the string will contain the port number. This only works for \fB\s-1BIO_ADDR\s0\fR of the protocol families \s-1AF_INET\s0 and \s-1AF_INET6.\s0 The returned string has been allocated on the heap and must be freed -with \fIOPENSSL_free()\fR. +with \fBOPENSSL_free()\fR. .PP -\&\fIBIO_ADDR_path_string()\fR returns a character string with the path +\&\fBBIO_ADDR_path_string()\fR returns a character string with the path of the given \fB\s-1BIO_ADDR\s0\fR. This only works for \fB\s-1BIO_ADDR\s0\fR of the protocol family \s-1AF_UNIX.\s0 The returned string has been allocated -on the heap and must be freed with \fIOPENSSL_free()\fR. +on the heap and must be freed with \fBOPENSSL_free()\fR. .SH "RAW ADDRESSES" .IX Header "RAW ADDRESSES" -Both \fIBIO_ADDR_rawmake()\fR and \fIBIO_ADDR_rawaddress()\fR take a pointer to a +Both \fBBIO_ADDR_rawmake()\fR and \fBBIO_ADDR_rawaddress()\fR take a pointer to a network byte order address of a specific site. Internally, those are treated as a pointer to \fBstruct in_addr\fR (for \fB\s-1AF_INET\s0\fR), \fBstruct in6_addr\fR (for \fB\s-1AF_INET6\s0\fR) or \fBchar *\fR (for \fB\s-1AF_UNIX\s0\fR), all depending on the protocol family the address is for. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -The string producing functions \fIBIO_ADDR_hostname_string()\fR, -\&\fIBIO_ADDR_service_string()\fR and \fIBIO_ADDR_path_string()\fR will +The string producing functions \fBBIO_ADDR_hostname_string()\fR, +\&\fBBIO_ADDR_service_string()\fR and \fBBIO_ADDR_path_string()\fR will return \fB\s-1NULL\s0\fR on error and leave an error indication on the OpenSSL error stack. .PP @@ -238,7 +242,7 @@ All other functions described here return 0 or \fB\s-1NULL\s0\fR when the information they should return isn't available. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fIBIO_connect\fR\|(3), \fIBIO_s_connect\fR\|(3) +\&\fBBIO_connect\fR\|(3), \fBBIO_s_connect\fR\|(3) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. |