diff options
author | Peter Tribble <peter.tribble@gmail.com> | 2022-05-15 18:56:02 +0100 |
---|---|---|
committer | Peter Tribble <peter.tribble@gmail.com> | 2022-05-17 07:51:40 +0100 |
commit | c55633c3b85a97a093b3f79f341aee08eb6bd15b (patch) | |
tree | db687a7cc6cf41e24f4f33fd3551cd8efeb05845 /usr/src/man/man3socket | |
parent | 3bb2c1567625e7b11f8c2a5335125224717af64a (diff) | |
download | illumos-gate-c55633c3b85a97a093b3f79f341aee08eb6bd15b.tar.gz |
14605 More incorrect cross-references in the manual
Reviewed by: Andy Fiddaman <andy@omnios.org>
Reviewed by: Richard Lowe <richlowe@richlowe.net>
Reviewed by: Yuri Pankov <ypankov@tintri.com>
Approved by: Dan McDonald <danmcd@mnx.io>
Diffstat (limited to 'usr/src/man/man3socket')
-rw-r--r-- | usr/src/man/man3socket/getaddrinfo.3socket | 14 | ||||
-rw-r--r-- | usr/src/man/man3socket/getipnodebyname.3socket | 11 | ||||
-rw-r--r-- | usr/src/man/man3socket/getnetbyname.3socket | 28 |
3 files changed, 10 insertions, 43 deletions
diff --git a/usr/src/man/man3socket/getaddrinfo.3socket b/usr/src/man/man3socket/getaddrinfo.3socket index fa14f040f8..87920be09b 100644 --- a/usr/src/man/man3socket/getaddrinfo.3socket +++ b/usr/src/man/man3socket/getaddrinfo.3socket @@ -3,12 +3,11 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH GETADDRINFO 3SOCKET "Feb 25, 2017" +.TH GETADDRINFO 3SOCKET "March 30, 2022" .SH NAME getaddrinfo, getnameinfo, freeaddrinfo, gai_strerror \- translate between node name and address .SH SYNOPSIS -.LP .nf \fBcc\fR [ \fIflag\fR\&.\|.\|. ] \fIfile\fR \&.\|.\|. \fB-lsocket\fR \fB -lnsl \fR [ \fIlibrary\fR \&.\|.\|. ] #include <sys/socket.h> @@ -36,7 +35,6 @@ name and address .fi .SH DESCRIPTION -.LP These functions perform translations from node name to address and from address to node name in a protocol-independent manner. .sp @@ -277,7 +275,7 @@ hosts. If the flag bit \fBNI_NUMERICHOST\fR is set, or if the host's name cannot be located in the name service, the numeric form of the host's address is returned instead of its name, for example, by calling \fBinet_ntop()\fR (see -\fBinet\fR(3SOCKET)) instead of \fBgetipnodebyname\fR(3SOCKET). If the flag bit +\fBinet\fR(3C)) instead of \fBgetipnodebyname\fR(3SOCKET). If the flag bit \fBNI_NAMEREQD\fR is set, an error is returned if the host's name cannot be located in the name service database. .sp @@ -298,7 +296,6 @@ TCP. These \fBNI_\fR* flags are defined in <\fBnetdb.h\fR> along with the \fBAI_\fR* flags already defined for \fBgetaddrinfo()\fR. .SH RETURN VALUES -.LP For \fBgetaddrinfo()\fR, if the query is successful, a pointer to a linked list of one or more \fBaddrinfo\fR structures is returned by the fourth argument and the function returns \fB0\fR. The order of the addresses returned in the fourth @@ -312,7 +309,6 @@ pointer to a string containing an error message appropriate for the \fBEAI_\fR* errors is returned. If \fIerrcode\fR is not one of the \fBEAI_\fR* values, a pointer to a string indicating an unknown error is returned. .SS "Address Ordering" -.LP AF_INET6 addresses returned by the fourth argument of \fBgetaddrinfo()\fR are ordered according to the algorithm described in \fIRFC 3484, Default Address Selection for Internet Protocol version 6 (IPv6)\fR. The addresses are ordered @@ -372,7 +368,6 @@ T} .TE .SH ERRORS -.LP The following names are the error values returned by \fBgetaddrinfo()\fR and are defined in <\fBnetdb.h\fR>: .sp @@ -511,7 +506,6 @@ configuration file for the name service switch .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(7) for description of the following attributes: .sp @@ -530,12 +524,11 @@ Standard See \fBstandards\fR(7). .TE .SH SEE ALSO -.LP .BR htonl (3C), +.BR inet (3C), .BR netdb.h (3HEAD), .BR gethostbyname (3NSL), .BR getipnodebyname (3SOCKET), -.BR inet (3SOCKET), .BR sockaddr (3SOCKET), .BR socket (3SOCKET), .BR inet6 (4P), @@ -549,5 +542,4 @@ Standard See \fBstandards\fR(7). Draves, R. \fIRFC 3484, Default Address Selection for Internet Protocol version 6 (IPv6)\fR. Network Working Group. February 2003. .SH NOTES -.LP IPv4-mapped addresses are not recommended. diff --git a/usr/src/man/man3socket/getipnodebyname.3socket b/usr/src/man/man3socket/getipnodebyname.3socket index cc1418254b..d5fde341b0 100644 --- a/usr/src/man/man3socket/getipnodebyname.3socket +++ b/usr/src/man/man3socket/getipnodebyname.3socket @@ -3,11 +3,10 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH GETIPNODEBYNAME 3SOCKET "Sep 10, 2013" +.TH GETIPNODEBYNAME 3SOCKET "March 30, 2022" .SH NAME getipnodebyname, getipnodebyaddr, freehostent \- get IP node entry .SH SYNOPSIS -.LP .nf \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lsocket\fR \fB -lnsl \fR [ \fIlibrary\fR... ] #include <sys/socket.h> @@ -92,7 +91,6 @@ Pointer to \fBhostent\fR structure .RE .SH DESCRIPTION -.LP The \fBgetipnodebyname()\fR function searches the \fBipnodes\fR database from the beginning. The function finds the first \fBh_name\fR member that matches the hostname specified by \fIname\fR. The function takes an \fIaf\fR argument @@ -308,7 +306,6 @@ terminated by a \fINULL\fR pointer. .RE .SH RETURN VALUES -.LP Upon successful completion, \fBgetipnodebyname()\fR and \fBgetipnodebyaddr()\fR return a \fBhostent\fR structure. Otherwise they return \fINULL\fR. .sp @@ -423,7 +420,6 @@ This structure, and the information pointed to by this structure, are dynamically allocated by \fBgetipnodebyname()\fR and \fBgetipnodebyaddr()\fR. The \fBfreehostent()\fR function frees this memory. .SH EXAMPLES -.LP \fBExample 1 \fRGetting the Canonical Name, Aliases, and Internet IP Addresses for a Given Hostname .sp @@ -486,7 +482,6 @@ hostname. .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(7) for descriptions of the following attributes: .sp @@ -503,17 +498,15 @@ MT-Level Safe .TE .SH SEE ALSO -.LP .BR htonl (3C), +.BR inet (3C), .BR netdb.h (3HEAD), .BR gethostbyname (3NSL), .BR getaddrinfo (3SOCKET), -.BR inet (3SOCKET), .BR hosts (5), .BR nsswitch.conf (5), .BR attributes (7) .SH NOTES -.LP No enumeration functions are provided for IPv6. Existing enumeration functions such as \fBsethostent\fR(3NSL) do not work in combination with the \fBgetipnodebyname()\fR and \fBgetipnodebyaddr()\fR functions. diff --git a/usr/src/man/man3socket/getnetbyname.3socket b/usr/src/man/man3socket/getnetbyname.3socket index c2d4fdfbe3..208e256e78 100644 --- a/usr/src/man/man3socket/getnetbyname.3socket +++ b/usr/src/man/man3socket/getnetbyname.3socket @@ -2,12 +2,11 @@ .\" Copyright (C) 2004, Sun Microsystems, Inc. All Rights Reserved. .\" Copyright 1989 AT&T .\" Copyright (c) 1983 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. -.TH GETNETBYNAME 3SOCKET "Nov 4, 2004" +.TH GETNETBYNAME 3SOCKET "March 30, 2022" .SH NAME getnetbyname, getnetbyname_r, getnetbyaddr, getnetbyaddr_r, getnetent, getnetent_r, setnetent, endnetent \- get network entry .SH SYNOPSIS -.LP .nf \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsocket\fR \fB -lnsl \fR [ \fIlibrary\fR ... ] #include <netdb.h> @@ -54,8 +53,6 @@ getnetent_r, setnetent, endnetent \- get network entry .fi .SH DESCRIPTION -.sp -.LP These functions are used to obtain entries for networks. An entry may come from any of the sources for \fBnetworks\fR specified in the \fB/etc/nsswitch.conf\fR file. See \fBnsswitch.conf\fR(5). @@ -72,7 +69,7 @@ address. This should be one of the address families defined in .sp .LP Network numbers and local address parts are returned as machine format integer -values, that is, in host byte order. See also \fBinet\fR(3SOCKET). +values, that is, in host byte order. See also \fBinet\fR(3C). .sp .LP The \fBnetent.n_net\fR member in the \fBnetent\fR structure pointed to by the @@ -142,8 +139,6 @@ resources it was using. It is still allowed, but possibly less efficient, for the process to call more network entry retrieval functions after calling \fBendnetent()\fR. .SS "Reentrant Interfaces" -.sp -.LP The functions \fBgetnetbyname()\fR, \fBgetnetbyaddr()\fR, and \fBgetnetent()\fR use static storage that is reused in each call, making these routines unsafe for use in multi-threaded applications. @@ -184,8 +179,6 @@ Like their non-reentrant counterparts, \fBgetnetbyname_r()\fR and \fBgetnetbyaddr_r()\fR leave the enumeration position in an indeterminate state. .SH RETURN VALUES -.sp -.LP Network entries are represented by the \fBstruct netent\fR structure defined in \fB<netdb.h>\fR\&. .sp @@ -213,15 +206,12 @@ equal to the \fIresult\fR pointer that was supplied by the caller. The functions \fBsetnetent()\fR and \fBendnetent()\fR return \fB0\fR on success. .SH ERRORS -.sp -.LP The reentrant functions \fBgetnetbyname_r()\fR, \fBgetnetbyaddr_r\fR and \fBgetnetent_r()\fR will return \fBNULL\fR and set \fIerrno\fR to \fBERANGE\fR if the length of the buffer supplied by caller is not large enough to store the result. See \fBIntro\fR(2) for the proper usage and interpretation of \fIerrno\fR in multi-threaded applications. .SH FILES -.sp .ne 2 .na \fB\fB/etc/networks\fR\fR @@ -240,8 +230,6 @@ configuration file for the name service switch .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(7) for descriptions of the following attributes: .sp @@ -256,13 +244,11 @@ MT-Level MT-Safe .TE .SH SEE ALSO -.sp -.LP .BR Intro (2), .BR Intro (3), +.BR byteorder (3C), +.BR inet (3C), .BR netdb.h (3HEAD), -.BR byteorder (3SOCKET), -.BR inet (3SOCKET), .BR networks (5), .BR nsswitch.conf (5), .BR attributes (7) @@ -272,17 +258,13 @@ Fuller, V., Li, T., Yu, J., and Varadhan, K. \fIRFC 1519, Classless Inter-Domain Routing (CIDR): an Address Assignment and Aggregation Strategy\fR. Network Working Group. September 1993. .SH WARNINGS -.sp -.LP The reentrant interfaces \fBgetnetbyname_r()\fR, \fBgetnetbyaddr_r()\fR, and \fBgetnetent_r()\fR are included in this release on an uncommitted basis only, and are subject to change or removal in future minor releases. .SH NOTES -.sp -.LP The current implementation of these functions only return or accept network numbers for the Internet address family (type \fBAF_INET\fR). The functions -described in \fBinet\fR(3SOCKET) may be helpful in constructing and +described in \fBinet\fR(3C) may be helpful in constructing and manipulating addresses and network numbers in this form. .sp .LP |