summaryrefslogtreecommitdiffstats
path: root/lib/libc/net
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2002-12-18 13:33:04 +0000
committerru <ru@FreeBSD.org>2002-12-18 13:33:04 +0000
commit863465c1ab2c58349d7f1f859822ef564e592280 (patch)
tree6086e75984c3472fb331e2598243ce260e65581f /lib/libc/net
parent8746d263e1451855025dc83dde5176cc9f1fbe3f (diff)
downloadFreeBSD-src-863465c1ab2c58349d7f1f859822ef564e592280.zip
FreeBSD-src-863465c1ab2c58349d7f1f859822ef564e592280.tar.gz
mdoc(7) police: Fixed abuses of the .Ar and .Em macros.
Diffstat (limited to 'lib/libc/net')
-rw-r--r--lib/libc/net/ethers.324
-rw-r--r--lib/libc/net/getipnodebyname.366
-rw-r--r--lib/libc/net/getnameinfo.32
-rw-r--r--lib/libc/net/resolver.312
4 files changed, 52 insertions, 52 deletions
diff --git a/lib/libc/net/ethers.3 b/lib/libc/net/ethers.3
index bfa5955..813fd74 100644
--- a/lib/libc/net/ethers.3
+++ b/lib/libc/net/ethers.3
@@ -59,7 +59,7 @@
.Fn ether_hostton "const char *hostname" "struct ether_addr *e"
.Sh DESCRIPTION
These functions operate on ethernet addresses using an
-.Ar ether_addr
+.Vt ether_addr
structure, which is defined in the header file
.Aq Pa netinet/if_ether.h :
.Bd -literal -offset indent
@@ -79,15 +79,15 @@ struct ether_addr {
The function
.Fn ether_line
scans
-.Ar l ,
+.Fa l ,
an
.Tn ASCII
string in
.Xr ethers 5
format and sets
-.Ar e
+.Fa e
to the ethernet address specified in the string and
-.Ar h
+.Fa h
to the hostname.
This function is used to parse lines from
.Pa /etc/ethers
@@ -98,12 +98,12 @@ The
function converts an
.Tn ASCII
representation of an ethernet address into an
-.Ar ether_addr
+.Vt ether_addr
structure.
Likewise,
.Fn ether_ntoa
converts an ethernet address specified as an
-.Ar ether_addr
+.Vt ether_addr
structure into an
.Tn ASCII
string.
@@ -128,13 +128,13 @@ The
function
returns zero on success and non-zero if it was unable to parse
any part of the supplied line
-.Ar l .
+.Fa l .
It returns the extracted ethernet address in the supplied
-.Ar ether_addr
+.Vt ether_addr
structure
-.Ar e
+.Fa e
and the hostname in the supplied string
-.Ar h .
+.Fa h .
.Pp
On success,
.Fn ether_ntoa
@@ -143,14 +143,14 @@ returns a pointer to a string containing an
representation of an ethernet address.
If it is unable to convert
the supplied
-.Ar ether_addr
+.Vt ether_addr
structure, it returns a
.Dv NULL
pointer.
Likewise,
.Fn ether_aton
returns a pointer to an
-.Ar ether_addr
+.Vt ether_addr
structure on success and a
.Dv NULL
pointer on failure.
diff --git a/lib/libc/net/getipnodebyname.3 b/lib/libc/net/getipnodebyname.3
index b564c41..d0b0b8c 100644
--- a/lib/libc/net/getipnodebyname.3
+++ b/lib/libc/net/getipnodebyname.3
@@ -70,9 +70,9 @@ and
The functions cover all the functionalities provided by the older ones,
and provide better interface to programmers.
The functions require additional arguments,
-.Ar af ,
+.Fa af ,
and
-.Ar flags ,
+.Fa flags ,
for specifying address family and operation mode.
The additional arguments allow programmer to get address for a nodename,
for specific address family
@@ -81,7 +81,7 @@ for specific address family
or
.Dv AF_INET6 ) .
The functions also require an additional pointer argument,
-.Ar error_num
+.Fa error_num
to return the appropriate error code,
to support thread safe error code returns.
.Pp
@@ -93,18 +93,18 @@ is described in
For
.Fn getipnodebyname ,
the
-.Ar name
+.Fa name
argument can be either a node name or a numeric address
string
(i.e., a dotted-decimal IPv4 address or an IPv6 hex address).
The
-.Ar af
+.Fa af
argument specifies the address family, either
.Dv AF_INET
or
.Dv AF_INET6 .
The
-.Ar flags
+.Fa flags
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
@@ -123,22 +123,22 @@ with
.Pp
Applications desiring finer control over the types of addresses
searched for and returned, can specify other combinations of the
-.Ar flags
+.Fa flags
argument.
.Pp
A
-.Ar flags
+.Fa flags
of
.Li 0
implies a strict interpretation of the
-.Ar af
+.Fa af
argument:
.Bl -bullet
.It
If
-.Ar flags
+.Fa flags
is 0 and
-.Ar af
+.Fa af
is
.Dv AF_INET ,
then the caller wants only IPv4 addresses.
@@ -154,9 +154,9 @@ structure will be 4, else the function returns a
pointer.
.It
If
-.Ar flags
+.Fa flags
is 0 and if
-.Ar af
+.Fa af
is
.Li AF_INET6 ,
then the caller wants only IPv6 addresses.
@@ -173,14 +173,14 @@ pointer.
.El
.Pp
Other constants can be logically-ORed into the
-.Ar flags
+.Fa flags
argument, to modify the behavior of the function.
.Bl -bullet
.It
If the
.Dv AI_V4MAPPED
flag is specified along with an
-.Ar af
+.Fa af
of
.Dv AF_INET6 ,
then the caller will accept IPv4-mapped IPv6 addresses.
@@ -194,7 +194,7 @@ will be 16).
The
.Dv AI_V4MAPPED
flag is ignored unless
-.Ar af
+.Fa af
equals
.Dv AF_INET6 .
.It
@@ -246,7 +246,7 @@ configured.
.Pp
For example, if the node has no IPv6 source addresses configured,
and
-.Ar af
+.Fa af
equals AF_INET6, and the node name being looked up has both
.Li AAAA
and
@@ -277,40 +277,40 @@ is defined as
We noted that the
.Fn getipnodebyname
function must allow the
-.Ar name
+.Fa name
argument to be either a node name or a literal address string
(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.
When the
-.Ar name
+.Fa name
argument is a literal address string,
the
-.Ar flags
+.Fa flags
argument is always ignored.
.Pp
There are four scenarios based on the type of literal address string
and the value of the
-.Ar af
+.Fa af
argument.
The two simple cases are when
-.Ar name
+.Fa name
is a dotted-decimal IPv4 address and
-.Ar af
+.Fa af
equals
.Dv AF_INET ,
or when
-.Ar name
+.Fa name
is an IPv6 hex address and
-.Ar af
+.Fa af
equals
.Dv AF_INET6 .
The members of the
returned hostent structure are:
.Li h_name
points to a copy of the
-.Ar name
+.Fa name
argument,
.Li h_aliases
is a
@@ -318,7 +318,7 @@ is a
pointer,
.Li h_addrtype
is a copy of the
-.Ar af
+.Fa af
argument,
.Li h_length
is either 4
@@ -336,9 +336,9 @@ is a
pointer.
.Pp
When
-.Ar name
+.Fa name
is a dotted-decimal IPv4 address and
-.Ar af
+.Fa af
equals
.Dv AF_INET6 ,
and
@@ -364,15 +364,15 @@ is a
pointer.
.Pp
It is an error when
-.Ar name
+.Fa name
is an IPv6 hex address and
-.Ar af
+.Fa af
equals
.Dv AF_INET .
The function's return value is a
.Dv NULL
pointer and the value pointed to by
-.Ar error_num
+.Fa error_num
equals
.Dv HOST_NOT_FOUND .
.Pp
@@ -416,7 +416,7 @@ returns
.Dv NULL
on errors.
The integer values pointed to by
-.Ar error_num
+.Fa error_num
may then be checked to see whether this is a temporary failure
or an invalid or unknown host.
The meanings of each error code are described in
diff --git a/lib/libc/net/getnameinfo.3 b/lib/libc/net/getnameinfo.3
index b34fa11..09da4a8 100644
--- a/lib/libc/net/getnameinfo.3
+++ b/lib/libc/net/getnameinfo.3
@@ -186,7 +186,7 @@ IPv6 link-local address will appear as string like
if
.Dv NI_WITHSCOPEID
bit is enabled in
-.Ar flags
+.Fa flags
argument.
Refer to
.Xr getaddrinfo 3
diff --git a/lib/libc/net/resolver.3 b/lib/libc/net/resolver.3
index 7910d76..60c1193 100644
--- a/lib/libc/net/resolver.3
+++ b/lib/libc/net/resolver.3
@@ -125,11 +125,11 @@ query and reply messages with Internet domain name servers.
.Pp
Global configuration and state information that is used by the
resolver routines is kept in the structure
-.Em _res .
+.Va _res .
Most of the values have reasonable defaults and can be ignored.
Options
stored in
-.Em _res.options
+.Va _res.options
are defined in
.Pa resolv.h
and are as follows.
@@ -228,16 +228,16 @@ This environment variable may contain several blank-separated
tokens if you wish to override the
.Em "search list"
on a per-process basis. This is similar to the
-.Em search
+.Ic search
command in the configuration file.
Another environment variable
.Dq Ev RES_OPTIONS
can be set to
override certain internal resolver options which are otherwise
set by changing fields in the
-.Em _res
+.Va _res
structure or are inherited from the configuration file's
-.Em options
+.Ic options
command. The syntax of the
.Dq Ev RES_OPTIONS
environment variable is explained in
@@ -335,7 +335,7 @@ is to update the list of pointers for
labels inserted into the message
as the name is compressed.
If
-.Em dnptr
+.Fa dnptr
is
.Dv NULL ,
names are not compressed.
OpenPOWER on IntegriCloud