summaryrefslogtreecommitdiffstats
path: root/lib/libc/net
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libc/net')
-rw-r--r--lib/libc/net/addr2ascii.310
-rw-r--r--lib/libc/net/getaddrinfo.312
-rw-r--r--lib/libc/net/gethostbyname.312
-rw-r--r--lib/libc/net/getnameinfo.32
-rw-r--r--lib/libc/net/getnetent.31
-rw-r--r--lib/libc/net/inet6_option_space.332
-rw-r--r--lib/libc/net/inet_net.34
-rw-r--r--lib/libc/net/rcmdsh.33
-rw-r--r--lib/libc/net/resolver.34
-rw-r--r--lib/libc/net/sockatmark.34
10 files changed, 68 insertions, 16 deletions
diff --git a/lib/libc/net/addr2ascii.3 b/lib/libc/net/addr2ascii.3
index ce5d720..31e9f3f 100644
--- a/lib/libc/net/addr2ascii.3
+++ b/lib/libc/net/addr2ascii.3
@@ -87,16 +87,16 @@ function performs the inverse operation to
.Fn addr2ascii .
In addition to
.Fa af ,
-it takes two parameters,
+it takes two arguments,
.Fa ascii
and
.Fa result .
The
.Fa ascii
-parameter is a pointer to the string which is to be converted into
+argument is a pointer to the string which is to be converted into
binary. The
.Fa result
-parameter is a pointer to an appropriate network address structure for
+argument is a pointer to an appropriate network address structure for
the specified family.
.Pp
The following gives the appropriate structure to use for binary
@@ -171,12 +171,12 @@ The
.Fn addr2ascii
routine was passed a
.Fa len
-parameter which was inappropriate for the address family given by
+argument which was inappropriate for the address family given by
.Fa af .
.It Bq Er EPROTONOSUPPORT
Either routine was passed an
.Fa af
-parameter other than
+argument other than
.Dv AF_INET
or
.Dv AF_LINK .
diff --git a/lib/libc/net/getaddrinfo.3 b/lib/libc/net/getaddrinfo.3
index 4dbd771..f8c8f57 100644
--- a/lib/libc/net/getaddrinfo.3
+++ b/lib/libc/net/getaddrinfo.3
@@ -342,9 +342,10 @@ To return this information to the system the function
.Fn freeaddrinfo
is called.
The
-.Fa addrinfo
+.Vt addrinfo
structure pointed to by the
-.Fa ai argument
+.Fa ai
+argument
is freed, along with any dynamic storage pointed to by the structure.
This operation is repeated until a
.Dv NULL
@@ -531,7 +532,9 @@ Invalid value for
.It Dv EAI_FAIL
Non-recoverable failure in name resolution.
.It Dv EAI_FAMILY
+The
.Fa ai_family
+address family is
not supported.
.It Dv EAI_MEMORY
Memory allocation failure.
@@ -539,16 +542,21 @@ Memory allocation failure.
No address associated with
.Fa nodename .
.It Dv EAI_NONAME
+Neither
.Fa nodename
nor
.Fa servname
provided, or not known.
.It Dv EAI_SERVICE
+The
.Fa servname
+service name is
not supported for
.Fa ai_socktype .
.It Dv EAI_SOCKTYPE
+The
.Fa ai_socktype
+socket type is
not supported.
.It Dv EAI_SYSTEM
System error returned in
diff --git a/lib/libc/net/gethostbyname.3 b/lib/libc/net/gethostbyname.3
index 4f4b9dc..c6f7b90 100644
--- a/lib/libc/net/gethostbyname.3
+++ b/lib/libc/net/gethostbyname.3
@@ -92,7 +92,7 @@ referenced by name or by address, respectively.
.Pp
The
.Fa name
-parameter passed to
+argument passed to
.Fn gethostbyname
or
.Fn gethostbyname2
@@ -101,7 +101,7 @@ should point to a
hostname.
The
.Fa addr
-parameter passed to
+argument passed to
.Fn gethostbyaddr
should point to an address which is
.Fa len
@@ -112,7 +112,7 @@ in binary form
form).
The
.Fa type
-parameter specifies the address family
+argument specifies the address family
(e.g.\&
.Dv AF_INET , AF_INET6 ,
etc.) of this address.
@@ -217,8 +217,8 @@ connection.
The
.Fn herror
function writes a message to the diagnostic output consisting of the
-string parameter
-.Fa s ,
+string argument
+.Fa string ,
the constant string
.Qq Li ":\ " ,
and a message corresponding to the value of
@@ -229,7 +229,7 @@ The
function returns a string which is the message text corresponding to the
value of the
.Fa err
-parameter.
+argument.
.Sh FILES
.Bl -tag -width /etc/nsswitch.conf -compact
.It Pa /etc/hosts
diff --git a/lib/libc/net/getnameinfo.3 b/lib/libc/net/getnameinfo.3
index 09da4a8..f0496e7 100644
--- a/lib/libc/net/getnameinfo.3
+++ b/lib/libc/net/getnameinfo.3
@@ -246,7 +246,7 @@ for the specified family.
.It Bq Er EAI_MEMORY
There was a memory allocation failure.
.It Bq Er EAI_NONAME
-The name does not resolve for the supplied parameters.
+The name does not resolve for the supplied arguments.
.Dv NI_NAMEREQD
is set and the host's name cannot be located,
or both nodename and servname were null.
diff --git a/lib/libc/net/getnetent.3 b/lib/libc/net/getnetent.3
index 8a9fb69..f05df36 100644
--- a/lib/libc/net/getnetent.3
+++ b/lib/libc/net/getnetent.3
@@ -133,6 +133,7 @@ or until
is encountered.
The
.Fa type
+argument
must be
.Dv AF_INET .
Network numbers are supplied in host order.
diff --git a/lib/libc/net/inet6_option_space.3 b/lib/libc/net/inet6_option_space.3
index 00a9b46..aae9791 100644
--- a/lib/libc/net/inet6_option_space.3
+++ b/lib/libc/net/inet6_option_space.3
@@ -118,7 +118,9 @@ on success or
.Li -1
on an error.
.Pp
+The
.Fa bp
+argument
is a pointer to previously allocated space that will contain the
ancillary data object.
It must be large enough to contain all the
@@ -127,17 +129,23 @@ individual options to be added by later calls to
and
.Fn inet6_option_alloc .
.Pp
+The
.Fa cmsgp
+argument
is a pointer to a pointer to a
.Li cmsghdr
structure.
+The
.Fa *cmsgp
+argument
is initialized by this function to point to the
.Li cmsghdr
structure constructed by this function in the buffer pointed to by
.Fa bp .
.Pp
+The
.Fa type
+argument
is either
.Dv IPV6_HOPOPTS
or
@@ -161,14 +169,18 @@ if it succeeds or
.Li -1
on an error.
.Pp
+The
.Fa cmsg
+argument
is a pointer to the
.Li cmsghdr
structure that must have been
initialized by
.Fn inet6_option_init .
.Pp
+The
.Fa typep
+argument
is a pointer to the 8-bit option type.
It is assumed that this
field is immediately followed by the 8-bit option data length field,
@@ -198,7 +210,9 @@ and
.Li 255 ,
inclusive, and is the length of the option data that follows.
.Pp
+The
.Fa multx
+argument
is the value
.Li x
in the alignment term
@@ -210,7 +224,9 @@ It must have a value of
or
.Li 8 .
.Pp
+The
.Fa plusy
+argument
is the value
.Li y
in the alignment term
@@ -237,14 +253,18 @@ the ancillary data object while the current function returns a
pointer to the space in the data object where the option's TLV must
then be built by the caller.
.Pp
+The
.Fa cmsg
+argument
is a pointer to the
.Li cmsghdr
structure that must have been
initialized by
.Fn inet6_option_init .
.Pp
+The
.Fa datalen
+argument
is the value of the option data length byte for this option.
This value is required as an argument to allow the function to
determine if padding must be appended at the end of the option.
@@ -253,7 +273,9 @@ determine if padding must be appended at the end of the option.
function does not need a data length argument
since the option data length must already be stored by the caller.)
.Pp
+The
.Fa multx
+argument
is the value
.Li x
in the alignment term
@@ -265,7 +287,9 @@ It must have a value of
or
.Li 8 .
.Pp
+The
.Fa plusy
+argument
is the value
.Li y
in the alignment term
@@ -302,7 +326,9 @@ and
is not
.Dv NULL .
.Pp
+The
.Fa cmsg
+argument
is a pointer to
.Li cmsghdr
structure of which
@@ -316,7 +342,9 @@ equals either
or
.Dv IPV6_DSTOPTS .
.Pp
+The
.Fa tptrp
+argument
is a pointer to a pointer to an 8-bit byte and
.Fa *tptrp
is used
@@ -339,7 +367,9 @@ This function is similar to the previously described
function, except this function lets the caller
specify the option type to be searched for, instead of always
returning the next option in the ancillary data object.
+The
.Fa cmsg
+argument
is a
pointer to
.Li cmsghdr
@@ -354,7 +384,9 @@ equals either
or
.Dv IPV6_DSTOPTS .
.Pp
+The
.Fa tptrp
+argument
is a pointer to a pointer to an 8-bit byte and
.Fa *tptrp
is used
diff --git a/lib/libc/net/inet_net.3 b/lib/libc/net/inet_net.3
index 72fc445..9ca00a6 100644
--- a/lib/libc/net/inet_net.3
+++ b/lib/libc/net/inet_net.3
@@ -61,7 +61,9 @@ function converts an Internet network number from network format (usually a
.Vt "struct in_addr"
or some other binary form, in network byte order) to CIDR presentation format
(suitable for external display purposes).
+The
.Fa bits
+argument
is the number of bits in
.Fa src
that are the network number.
@@ -90,7 +92,9 @@ The only value for
.Fa af
currently supported is
.Dv AF_INET .
+The
.Fa size
+argument
is the size of the result buffer
.Fa dst .
.Pp
diff --git a/lib/libc/net/rcmdsh.3 b/lib/libc/net/rcmdsh.3
index 10d95a2..91b81b9 100644
--- a/lib/libc/net/rcmdsh.3
+++ b/lib/libc/net/rcmdsh.3
@@ -79,8 +79,9 @@ residing at the well-known Internet port
.Dq Li shell/tcp
(or whatever port is used by
.Fa rshprog ) .
-The parameter
+The
.Fa inport
+argument
is ignored; it is only included to provide an interface similar to
.Xr rcmd 3 .
.Pp
diff --git a/lib/libc/net/resolver.3 b/lib/libc/net/resolver.3
index 60c1193..2a89500 100644
--- a/lib/libc/net/resolver.3
+++ b/lib/libc/net/resolver.3
@@ -292,7 +292,9 @@ but can be any of the query types defined in
.Aq Pa arpa/nameser.h .
The domain name for the query is given by
.Fa dname .
-.Fa Newrr
+The
+.Fa newrr_in
+argument
is currently unused but is intended for making update messages.
.Pp
The
diff --git a/lib/libc/net/sockatmark.3 b/lib/libc/net/sockatmark.3
index da073c0..61a1a9f 100644
--- a/lib/libc/net/sockatmark.3
+++ b/lib/libc/net/sockatmark.3
@@ -94,10 +94,14 @@ The
call fails if:
.Bl -tag -width Er
.It Bq Er EBADF
+The
.Fa s
+argument
is not a valid descriptor.
.It Bq Er ENOTTY
+The
.Fa s
+argument
is a descriptor for a file, not a socket.
.El
.Sh SEE ALSO
OpenPOWER on IntegriCloud