summaryrefslogtreecommitdiffstats
path: root/lib/libc/net
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-08-07 15:48:51 +0000
committerru <ru@FreeBSD.org>2001-08-07 15:48:51 +0000
commit43457588767caedd16dbf19162de0a6a435dfeda (patch)
tree0505e005ecc9492a4b759dc8e06eb138613e4aa4 /lib/libc/net
parent6b00d6a3ebd552afe7b0a0844e598ee70810f887 (diff)
downloadFreeBSD-src-43457588767caedd16dbf19162de0a6a435dfeda.zip
FreeBSD-src-43457588767caedd16dbf19162de0a6a435dfeda.tar.gz
mdoc(7) police:
Avoid using parenthesis enclosure macros (.Pq and .Po/.Pc) with plain text. Not only this slows down the mdoc(7) processing significantly, but it also has an undesired (in this case) effect of disabling hyphenation within the entire enclosed block.
Diffstat (limited to 'lib/libc/net')
-rw-r--r--lib/libc/net/addr2ascii.39
-rw-r--r--lib/libc/net/getaddrinfo.316
-rw-r--r--lib/libc/net/getifaddrs.36
-rw-r--r--lib/libc/net/getipnodebyname.336
-rw-r--r--lib/libc/net/getnameinfo.314
-rw-r--r--lib/libc/net/if_indextoname.32
-rw-r--r--lib/libc/net/inet6_option_space.36
-rw-r--r--lib/libc/net/inet6_rthdr_space.38
8 files changed, 41 insertions, 56 deletions
diff --git a/lib/libc/net/addr2ascii.3 b/lib/libc/net/addr2ascii.3
index b9f6fa9..4003a83 100644
--- a/lib/libc/net/addr2ascii.3
+++ b/lib/libc/net/addr2ascii.3
@@ -105,13 +105,16 @@ addresses in the specified family:
.Bl -tag -width AF_INETxxxx -compact
.It Dv AF_INET
.Li struct in_addr
-.Pq in Aq Pa netinet/in.h
+(in
+.Aq Pa netinet/in.h )
.It Dv AF_LINK
.Li struct sockaddr_dl
-.Pq in Aq Pa net/if_dl.h
+(in
+.Aq Pa net/if_dl.h )
.\" .It Dv AF_INET6
.\" .Li struct in6_addr
-.\" .Pq in Aq Pa netinet6/in6.h
+.\" (in
+.\" .Aq Pa netinet6/in6.h )
.El
.Sh RETURN VALUES
The
diff --git a/lib/libc/net/getaddrinfo.3 b/lib/libc/net/getaddrinfo.3
index 7dd98a1..cd73f28 100644
--- a/lib/libc/net/getaddrinfo.3
+++ b/lib/libc/net/getaddrinfo.3
@@ -107,9 +107,7 @@ A
.Pf non Dv -NULL
.Fa nodename
string can be either a node name or a numeric host address string
-.Po
-i.e., a dotted-decimal IPv4 address or an IPv6 hex address
-.Pc .
+(i.e., a dotted-decimal IPv4 address or an IPv6 hex address).
A
.Pf non Dv -NULL
.Fa servname
@@ -226,13 +224,13 @@ member of the
structure, then the returned socket address structure will be ready for a
call to
.Fn connect
-.Pq for a connection-oriented protocol
+(for a connection-oriented protocol)
or either
.Fn connect ,
.Fn sendto ,
or
.Fn sendmsg
-.Pq for a connectionless protocol .
+(for a connectionless protocol).
In this case, if the
.Fa nodename
argument is a
@@ -379,10 +377,8 @@ and allows cut-and-paste input of scoped addresses.
At the moment the code supports only link-local addresses in this format.
The scope identifier is hardcoded to name of hardware interface associated
with the link,
-.Po
-such as
-.Li ne0
-.Pc .
+(such as
+.Li ne0 ) .
For example,
.Dq Li fe80::1%ne0 ,
which means
@@ -615,7 +611,7 @@ function is defined in
.St -p1003.1g-2000 ,
and documented in
.Dq Basic Socket Interface Extensions for IPv6
-.Pq RFC2553 .
+(RFC2553).
.\"
.Sh BUGS
The current implementation is not thread-safe.
diff --git a/lib/libc/net/getifaddrs.3 b/lib/libc/net/getifaddrs.3
index a83e397..b1da0bc 100644
--- a/lib/libc/net/getifaddrs.3
+++ b/lib/libc/net/getifaddrs.3
@@ -114,11 +114,13 @@ field references address family specific data. For
.Dv AF_LINK
addresses it contains a pointer to the
.Fa struct if_data
-.Pq as defined in include file Aq Pa net/if.h
+(as defined in include file
+.Aq Pa net/if.h )
which contains various interface attributes and statistics.
For all other address families, it contains a pointer to the
.Fa struct ifa_data
-.Pq as defined in include file Aq Pa net/if.h
+(as defined in include file
+.Aq Pa net/if.h )
which contains per-address interface statistics.
.Pp
The data returned by
diff --git a/lib/libc/net/getipnodebyname.3 b/lib/libc/net/getipnodebyname.3
index b31fe33..f960957 100644
--- a/lib/libc/net/getipnodebyname.3
+++ b/lib/libc/net/getipnodebyname.3
@@ -75,12 +75,10 @@ and
for specifying address family and operation mode.
The additional arguments allow programmer to get address for a nodename,
for specific address family
-.Po
-such as
+(such as
.Dv AF_INET
or
-.Dv AF_INET6
-.Pc .
+.Dv AF_INET6 ) .
The functions also require an additional pointer argument,
.Ar error_num
to return the appropriate error code,
@@ -97,9 +95,7 @@ the
.Ar name
argument can be either a node name or a numeric address
string
-.Po
-i.e., a dotted-decimal IPv4 address or an IPv6 hex address
-.Pc .
+(i.e., a dotted-decimal IPv4 address or an IPv6 hex address).
The
.Ar af
argument specifies the address family, either
@@ -112,7 +108,7 @@ argument specifies the types of addresses that are searched for,
and the types of addresses that are returned.
We note that a special flags value of
.Dv AI_DEFAULT
-.Pq defined below
+(defined below)
should handle most applications.
That is, porting simple applications to use IPv6 replaces the call
.Bd -literal -offset
@@ -192,10 +188,8 @@ That is, if no
records are found then a query is made for
.Li A
records and any found are returned as IPv4-mapped IPv6 addresses
-.Po
-.Li h_length
-will be 16
-.Pc .
+.Li ( h_length
+will be 16).
The
.Dv AI_V4MAPPED
flag is ignored unless
@@ -284,9 +278,7 @@ We noted that the
function must allow the
.Ar name
argument to be either a node name or a literal address string
-.Po
-i.e., a dotted-decimal IPv4 address or an IPv6 hex address
-.Pc .
+(i.e., a dotted-decimal IPv4 address or an IPv6 hex address).
This saves applications from having to call
.Xr inet_pton 3
to handle literal address strings.
@@ -329,15 +321,11 @@ is a copy of the
argument,
.Li h_length
is either 4
-.Po
-for
-.Dv AF_INET
-.Pc
+(for
+.Dv AF_INET )
or 16
-.Po
-for
-.Dv AF_INET6
-.Pc ,
+(for
+.Dv AF_INET6 ) ,
.Li h_addr_list[0]
is a pointer to the 4-byte or 16-byte binary address,
and
@@ -453,7 +441,7 @@ and
.Fn getipnodebyaddr
are documented in
.Dq Basic Socket Interface Extensions for IPv6
-.Pq RFC2553 .
+(RFC2553).
.\"
.Sh BUGS
.Fn getipnodebyname
diff --git a/lib/libc/net/getnameinfo.3 b/lib/libc/net/getnameinfo.3
index 6b4f02d..8dc026c 100644
--- a/lib/libc/net/getnameinfo.3
+++ b/lib/libc/net/getnameinfo.3
@@ -122,9 +122,7 @@ The first value is actually defined as the constant
in recent versions of BIND's
.Aq Pa arpa/nameser.h
header
-.Po
-older versions of BIND define this constant to be 256
-.Pc
+(older versions of BIND define this constant to be 256)
and the second is a guess based on the services listed in the current
Assigned Numbers RFC.
.Pp
@@ -143,12 +141,10 @@ bit
.Dv NI_NUMERICHOST
is set, or if the host's name cannot be located in the DNS,
the numeric form of the host's address is returned instead of its name
-.Po
-e.g., by calling
+(e.g., by calling
.Fn inet_ntop
instead of
-.Fn getnodebyaddr
-.Pc .
+.Fn getnodebyaddr ) .
If the
.Fa flag
bit
@@ -158,7 +154,7 @@ is set, an error is returned if the host's name cannot be located in the DNS.
If the flag bit
.Dv NI_NUMERICSERV
is set, the numeric form of the service address is returned
-.Pq e.g., its port number
+(e.g., its port number)
instead of its name.
The two
.Dv NI_NUMERICxxx
@@ -302,7 +298,7 @@ function is defined in
.St -p1003.1g-2000 ,
and documented in
.Dq Basic Socket Interface Extensions for IPv6
-.Pq RFC2553 .
+(RFC2553).
.\"
.Sh BUGS
The current implementation is not thread-safe.
diff --git a/lib/libc/net/if_indextoname.3 b/lib/libc/net/if_indextoname.3
index adf82cb..29ae464 100644
--- a/lib/libc/net/if_indextoname.3
+++ b/lib/libc/net/if_indextoname.3
@@ -139,4 +139,4 @@ R. Gilligan, S. Thomson, J. Bound, and W. Stevens,
The implementation first appeared in WIDE Hydrangea IPv6 protocol stack kit.
.Sh STANDARDS
These functions are defined in ``Basic Socket Interface Extensions for IPv6''
-.Pq RFC2533 .
+(RFC2533).
diff --git a/lib/libc/net/inet6_option_space.3 b/lib/libc/net/inet6_option_space.3
index c2338fc..726a41c 100644
--- a/lib/libc/net/inet6_option_space.3
+++ b/lib/libc/net/inet6_option_space.3
@@ -102,7 +102,7 @@ is the number of options to be stored in the object.
This is of little consequence, since it is assumed that most
Hop-by-Hop option headers and Destination option headers carry only
one option
-.Pq appendix B of [RFC-2460] .
+(appendix B of [RFC-2460]).
.\"
.Ss inet6_option_init
.Fn inet6_option_init
@@ -171,7 +171,7 @@ field is immediately followed by the 8-bit option data length field,
which is then followed immediately by the option data.
The caller
initializes these three fields
-.Pq the type-length-value, or TLV
+(the type-length-value, or TLV)
before calling this function.
.Pp
The option type must have a value from
@@ -439,7 +439,7 @@ The implementation first appeared in KAME advanced networking kit.
The functions
are documented in
.Dq Advanced Sockets API for IPv6
-.Pq RFC2292 .
+(RFC2292).
.\"
.Sh BUGS
The text was shamelessly copied from RFC2292.
diff --git a/lib/libc/net/inet6_rthdr_space.3 b/lib/libc/net/inet6_rthdr_space.3
index 2c3fd9c..d09bba6 100644
--- a/lib/libc/net/inet6_rthdr_space.3
+++ b/lib/libc/net/inet6_rthdr_space.3
@@ -106,7 +106,7 @@ header of the specified
.Fa type
containing the specified number of
.Fa segments
-.Pq addresses .
+(addresses).
For an IPv6 Type 0 Routing header, the number
of segments must be between 1 and 23, inclusive. The return value
includes the size of the cmsghdr structure that precedes the Routing
@@ -218,14 +218,14 @@ and writes a new Routing
header that sends datagrams along the reverse of that route.
Both
arguments are allowed to point to the same buffer
-.Pq that is, the reversal can occur in place .
+(that is, the reversal can occur in place).
.Pp
The return value of the function is 0 on success, or -1 upon an
error.
.\"
.Ss inet6_rthdr_segments
This function returns the number of segments
-.Pq addresses
+(addresses)
contained in
the Routing header described by
.Fa cmsg .
@@ -314,7 +314,7 @@ The implementation first appeared in KAME advanced networking kit.
The functions
are documented in
.Dq Advanced Sockets API for IPv6
-.Pq RFC2292 .
+(RFC2292).
.\"
.Sh BUGS
The text was shamelessly copied from RFC2292.
OpenPOWER on IntegriCloud