mdoc(7) police: Fixed abuses of the .Ar and .Em macros.
This commit is contained in:
parent
1fae73b137
commit
5c564bae0a
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=108040
@ -69,7 +69,7 @@ alarm and the signal SIGALRM will not be delivered.
|
||||
Due to
|
||||
.Xr setitimer 2
|
||||
restriction the maximum number of
|
||||
.Ar seconds
|
||||
.Fa seconds
|
||||
allowed is 100000000.
|
||||
.Sh RETURN VALUES
|
||||
The return value of
|
||||
|
@ -42,19 +42,19 @@ The
|
||||
.Fn basename
|
||||
function
|
||||
returns the last component from the pathname pointed to by
|
||||
.Ar path ,
|
||||
.Fa path ,
|
||||
deleting any trailing
|
||||
.Sq \&/
|
||||
characters.
|
||||
If
|
||||
.Ar path
|
||||
.Fa path
|
||||
consists entirely of
|
||||
.Sq \&/
|
||||
characters, a pointer to the string
|
||||
.Qq \&/
|
||||
is returned.
|
||||
If
|
||||
.Ar path
|
||||
.Fa path
|
||||
is a null pointer or the empty string, a pointer to the string
|
||||
.Qq \&.
|
||||
is returned.
|
||||
@ -62,7 +62,7 @@ is returned.
|
||||
On successful completion,
|
||||
.Fn basename
|
||||
returns a pointer to the last component of
|
||||
.Ar path .
|
||||
.Fa path .
|
||||
.Pp
|
||||
If
|
||||
.Fn basename
|
||||
|
@ -53,14 +53,14 @@ function generates a string, that, when used as a pathname, refers to
|
||||
the current controlling terminal of the calling process.
|
||||
.Pp
|
||||
If
|
||||
.Ar buf
|
||||
.Fa buf
|
||||
is the
|
||||
.Dv NULL
|
||||
pointer, a pointer to a static area is returned.
|
||||
Otherwise, the pathname is copied into the memory referenced by
|
||||
.Ar buf .
|
||||
.Fa buf .
|
||||
The argument
|
||||
.Ar buf
|
||||
.Fa buf
|
||||
is assumed to be at least
|
||||
.Dv L_ctermid
|
||||
(as defined in the include
|
||||
@ -74,7 +74,7 @@ function
|
||||
provides the same functionality as
|
||||
.Fn ctermid
|
||||
except that if
|
||||
.Ar buf
|
||||
.Fa buf
|
||||
is a
|
||||
.Dv NULL
|
||||
pointer,
|
||||
|
@ -44,13 +44,13 @@ function
|
||||
is the converse of
|
||||
.Xr basename 3 ;
|
||||
it returns a pointer to the parent directory of the pathname pointed to by
|
||||
.Ar path .
|
||||
.Fa path .
|
||||
Any trailing
|
||||
.Sq \&/
|
||||
characters are not counted as part of the directory
|
||||
name.
|
||||
If
|
||||
.Ar path
|
||||
.Fa path
|
||||
is a null pointer, the empty string, or contains no
|
||||
.Sq \&/
|
||||
characters,
|
||||
@ -62,7 +62,7 @@ signifying the current directory.
|
||||
On successful completion,
|
||||
.Fn dirname
|
||||
returns a pointer to the parent directory of
|
||||
.Ar path .
|
||||
.Fa path .
|
||||
.Pp
|
||||
If
|
||||
.Fn dirname
|
||||
|
@ -101,7 +101,7 @@ is related to the specification of
|
||||
A period is always
|
||||
.Dq leading
|
||||
if it is the first character in
|
||||
.Ar string .
|
||||
.Fa string .
|
||||
Additionally, if
|
||||
.Dv FNM_PATHNAME
|
||||
is set,
|
||||
|
@ -54,24 +54,24 @@ The
|
||||
function breaks a floating-point number into a normalized
|
||||
fraction and an integral power of 2.
|
||||
It stores the integer in the
|
||||
.Em int
|
||||
.Vt int
|
||||
object pointed to by
|
||||
.Fa exp .
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn frexp
|
||||
function returns the value
|
||||
.Em x ,
|
||||
.Va x ,
|
||||
such that
|
||||
.Em x
|
||||
.Va x
|
||||
is a
|
||||
.Em double
|
||||
.Vt double
|
||||
with magnitude in the interval
|
||||
.Bo 1/2 , 1 Pc
|
||||
or zero, and
|
||||
.Fa value
|
||||
equals
|
||||
.Em x
|
||||
.Va x
|
||||
times 2 raised to the power
|
||||
.Fa *exp .
|
||||
If
|
||||
|
@ -69,7 +69,7 @@ which is described
|
||||
in
|
||||
.Xr group 5 .
|
||||
Each line of the database is defined by the structure
|
||||
.Ar group
|
||||
.Vt group
|
||||
found in the include
|
||||
file
|
||||
.Aq Pa grp.h :
|
||||
@ -87,9 +87,9 @@ The functions
|
||||
and
|
||||
.Fn getgrgid
|
||||
search the group database for the given group name pointed to by
|
||||
.Ar name
|
||||
.Fa name
|
||||
or the group id pointed to by
|
||||
.Ar gid ,
|
||||
.Fa gid ,
|
||||
respectively, returning the first one encountered. Identical group
|
||||
names or group gids may result in undefined behavior.
|
||||
.Pp
|
||||
|
@ -67,7 +67,7 @@ which is described
|
||||
in
|
||||
.Xr passwd 5 .
|
||||
Each entry in the database is defined by the structure
|
||||
.Ar passwd
|
||||
.Vt passwd
|
||||
found in the include
|
||||
file
|
||||
.Aq Pa pwd.h :
|
||||
|
@ -56,7 +56,7 @@ function breaks the argument
|
||||
into integral and fractional parts, each of which has the
|
||||
same sign as the argument.
|
||||
It stores the integral part as a
|
||||
.Em double
|
||||
.Vt double
|
||||
in the object pointed to by
|
||||
.Fa iptr .
|
||||
.Sh RETURN VALUES
|
||||
|
@ -116,7 +116,7 @@ All accessible objects have values as of the time
|
||||
.Fn longjmp
|
||||
routine was called, except that the values of objects of automatic storage
|
||||
invocation duration that do not have the
|
||||
.Em volatile
|
||||
.Vt volatile
|
||||
type and have been changed between the
|
||||
.Fn setjmp
|
||||
invocation and
|
||||
|
@ -218,7 +218,7 @@ will fail and no action will take place if one of the
|
||||
following occur:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er EINVAL
|
||||
.Em Sig
|
||||
.Fa sig
|
||||
is not a valid signal number.
|
||||
.It Bq Er EINVAL
|
||||
An attempt is made to ignore or supply a handler for
|
||||
|
@ -96,8 +96,8 @@ is contained in the signal set.
|
||||
These functions
|
||||
are provided as macros in the include file <signal.h>.
|
||||
Actual functions are available
|
||||
if their names are undefined (with #undef
|
||||
.Em name ) .
|
||||
if their names are undefined (with
|
||||
.Ic #undef Ar name ) .
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn sigismember
|
||||
|
@ -64,7 +64,7 @@ functions manipulate stringlists, which are lists of
|
||||
strings that extend automatically if necessary.
|
||||
.Pp
|
||||
The
|
||||
.Ar StringList
|
||||
.Vt StringList
|
||||
structure has the following definition:
|
||||
.Bd -literal -offset indent
|
||||
typedef struct _stringlist {
|
||||
@ -75,14 +75,14 @@ typedef struct _stringlist {
|
||||
.Ed
|
||||
.Pp
|
||||
.Bl -tag -width "sl_str" -offset indent
|
||||
.It Ar sl_str
|
||||
.It Va sl_str
|
||||
a pointer to the base of the array containing the list.
|
||||
.It Ar sl_max
|
||||
.It Va sl_max
|
||||
the size of
|
||||
.Ar sl_str .
|
||||
.It Ar sl_cur
|
||||
.Va sl_str .
|
||||
.It Va sl_cur
|
||||
the offset in
|
||||
.Ar sl_str
|
||||
.Va sl_str
|
||||
of the current element.
|
||||
.El
|
||||
.Pp
|
||||
@ -91,32 +91,32 @@ The following stringlist manipulation functions are available:
|
||||
.It Fn sl_init
|
||||
Create a stringlist.
|
||||
Returns a pointer to a
|
||||
.Ar StringList .
|
||||
.Vt StringList .
|
||||
.It Fn sl_free
|
||||
Releases memory occupied by
|
||||
.Ar sl
|
||||
.Fa sl
|
||||
and the
|
||||
.Ar sl->sl_str
|
||||
.Fa sl->sl_str
|
||||
array.
|
||||
If
|
||||
.Ar freeall
|
||||
.Fa freeall
|
||||
is non-zero, then each of the items within
|
||||
.Ar sl->sl_str
|
||||
.Fa sl->sl_str
|
||||
is released as well.
|
||||
.It Fn sl_add
|
||||
Add
|
||||
.Ar item
|
||||
.Fa item
|
||||
to
|
||||
.Ar sl->sl_str
|
||||
.Fa sl->sl_str
|
||||
at
|
||||
.Ar sl->sl_cur ,
|
||||
.Fa sl->sl_cur ,
|
||||
extending the size of
|
||||
.Ar sl->sl_str
|
||||
.Fa sl->sl_str
|
||||
.It Fn sl_find
|
||||
Find
|
||||
.Ar item
|
||||
.Fa item
|
||||
in
|
||||
.Ar sl ,
|
||||
.Fa sl ,
|
||||
returning NULL if it's not found.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
|
@ -240,10 +240,10 @@ If this value is
|
||||
into the
|
||||
.Fa action
|
||||
value, the values of the
|
||||
.Em c_cflag ,
|
||||
.Em c_ispeed ,
|
||||
.Va c_cflag ,
|
||||
.Va c_ispeed ,
|
||||
and
|
||||
.Em c_ospeed
|
||||
.Va c_ospeed
|
||||
fields are ignored.
|
||||
.El
|
||||
.Pp
|
||||
|
@ -54,13 +54,13 @@ See
|
||||
The
|
||||
.Fn timezone
|
||||
function returns a pointer to a time zone abbreviation for the specified
|
||||
.Ar zone
|
||||
.Fa zone
|
||||
and
|
||||
.Ar dst
|
||||
.Fa dst
|
||||
values.
|
||||
.Ar Zone
|
||||
.Fa Zone
|
||||
is the number of minutes west of GMT and
|
||||
.Ar dst
|
||||
.Fa dst
|
||||
is non-zero if daylight savings time is in effect.
|
||||
.Sh SEE ALSO
|
||||
.Xr ctime 3
|
||||
|
@ -59,7 +59,7 @@ These descriptors are not related to the standard
|
||||
typedef, but refer to the special device files found in
|
||||
.Pa /dev
|
||||
and named
|
||||
.Pa /dev/tty Ns Em xx
|
||||
.Pa /dev/tty Ns Ar xx
|
||||
and for which an entry exists
|
||||
in the initialization file
|
||||
.Pa /etc/ttys .
|
||||
|
@ -54,7 +54,7 @@ The
|
||||
.Fn ualarm
|
||||
function
|
||||
waits a count of
|
||||
.Ar microseconds
|
||||
.Fa microseconds
|
||||
before asserting the terminating signal
|
||||
.Dv SIGALRM .
|
||||
System activity or time used in processing the call may cause a slight
|
||||
@ -74,9 +74,9 @@ microseconds have passed).
|
||||
Due to
|
||||
.Xr setitimer 2
|
||||
restriction the maximum number of
|
||||
.Ar microseconds
|
||||
.Fa microseconds
|
||||
and
|
||||
.Ar interval
|
||||
.Fa interval
|
||||
is limited to 100000000000000
|
||||
(in case this value fit in the unsigned integer).
|
||||
.Sh RETURN VALUES
|
||||
|
@ -56,7 +56,7 @@ Upon successful completion,
|
||||
.Fn ulimit
|
||||
returns the value requested;
|
||||
otherwise the value \-1 is returned and the global variable
|
||||
.Ar errno
|
||||
.Va errno
|
||||
is set to indicate the error.
|
||||
.Sh ERRORS
|
||||
The
|
||||
|
@ -61,33 +61,33 @@ by the
|
||||
.Xr vis 3
|
||||
function, back into
|
||||
the original form. Unvis is called with successive characters in
|
||||
.Ar c
|
||||
.Fa c
|
||||
until a valid
|
||||
sequence is recognized, at which time the decoded character is
|
||||
available at the character pointed to by
|
||||
.Ar cp .
|
||||
.Fa cp .
|
||||
Strunvis decodes the
|
||||
characters pointed to by
|
||||
.Ar src
|
||||
.Fa src
|
||||
into the buffer pointed to by
|
||||
.Ar dst .
|
||||
.Fa dst .
|
||||
.Pp
|
||||
The
|
||||
.Fn strunvis
|
||||
function
|
||||
simply copies
|
||||
.Ar src
|
||||
.Fa src
|
||||
to
|
||||
.Ar dst ,
|
||||
.Fa dst ,
|
||||
decoding any escape sequences along the way,
|
||||
and returns the number of characters placed into
|
||||
.Ar dst ,
|
||||
.Fa dst ,
|
||||
or \-1 if an
|
||||
invalid escape sequence was detected. The size of
|
||||
.Ar dst
|
||||
.Fa dst
|
||||
should be
|
||||
equal to the size of
|
||||
.Ar src
|
||||
.Fa src
|
||||
(that is, no expansion takes place during
|
||||
decoding).
|
||||
.Pp
|
||||
@ -97,7 +97,7 @@ function does the same as the
|
||||
.Fn strunvis
|
||||
function,
|
||||
but it allows you to add a flag that specifies the style the string
|
||||
.Ar src
|
||||
.Fa src
|
||||
is encoded with.
|
||||
Currently, the only supported flag is
|
||||
.Dv VIS_HTTPSTYLE .
|
||||
@ -141,13 +141,13 @@ unknown state. The decoder is placed into the starting state.
|
||||
When all bytes in the stream have been processed, call
|
||||
.Fn unvis
|
||||
one more time with
|
||||
.Ar flag
|
||||
.Fa flag
|
||||
set to
|
||||
.Dv UNVIS_END
|
||||
to extract any remaining character (the character passed in is ignored).
|
||||
.Pp
|
||||
The
|
||||
.Ar flag
|
||||
.Fa flag
|
||||
argument is also used to specify the encoding style of the source.
|
||||
If set to
|
||||
.Dv VIS_HTTPSTYLE ,
|
||||
|
@ -76,6 +76,6 @@ function appeared in
|
||||
.Bx 3.0 .
|
||||
.Sh BUGS
|
||||
A
|
||||
.Em vfree
|
||||
.Fn vfree
|
||||
function
|
||||
has not been implemented.
|
||||
|
@ -243,13 +243,13 @@ Use URI encoding as described in RFC 1808.
|
||||
The form is
|
||||
.Ql %dd
|
||||
where
|
||||
.Em d
|
||||
.Ar d
|
||||
represents a hexadecimal digit.
|
||||
.It Dv VIS_OCTAL
|
||||
Use a three digit octal sequence. The form is
|
||||
.Ql \eddd
|
||||
where
|
||||
.Em d
|
||||
.Ar d
|
||||
represents an octal digit.
|
||||
.El
|
||||
.Pp
|
||||
|
@ -58,7 +58,7 @@ call-graph execution profiler.
|
||||
In typical operation, profiling begins at program startup
|
||||
and ends when the program calls exit.
|
||||
When the program exits, the profiling data are written to the file
|
||||
.Em progname.gmon ,
|
||||
.Ar progname Ns Pa .gmon ,
|
||||
where progname is the name of the program, then
|
||||
.Xr gprof 1
|
||||
can be used to examine the results.
|
||||
|
@ -77,7 +77,7 @@ it will be dispatched by the vm86 interrupt table.
|
||||
vm86 mode is entered by calling
|
||||
.Xr sigreturn 2
|
||||
with the correct machine context for vm86, and with the
|
||||
.Em PSL_VM
|
||||
.Dv PSL_VM
|
||||
bit set. Control returns to the process upon delivery of a signal.
|
||||
.Sh RETURN VALUES
|
||||
.Rv -std i386_vm86
|
||||
|
@ -110,7 +110,7 @@
|
||||
.Fn toupper "int c"
|
||||
.Sh DESCRIPTION
|
||||
The above functions perform character tests and conversions on the integer
|
||||
.Ar c .
|
||||
.Fa c .
|
||||
They are available as macros, defined in the include file
|
||||
.Aq Pa ctype.h ,
|
||||
or as true functions in the C library.
|
||||
|
@ -82,7 +82,7 @@ The
|
||||
function locates the first occurrence of
|
||||
.Fn rune
|
||||
in the string pointed to by
|
||||
.Ar string .
|
||||
.Fa string .
|
||||
The terminating
|
||||
.Dv NUL
|
||||
character is considered part of the string.
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -90,7 +90,7 @@ The
|
||||
.Fn putw
|
||||
function
|
||||
writes the specified
|
||||
.Em int
|
||||
.Vt int
|
||||
to the named output
|
||||
.Fa stream .
|
||||
.Sh RETURN VALUES
|
||||
@ -131,7 +131,7 @@ function appeared in
|
||||
.At v6 .
|
||||
.Sh BUGS
|
||||
The size and byte order of an
|
||||
.Em int
|
||||
.Vt int
|
||||
varies from one machine to another, and
|
||||
.Fn putw
|
||||
is not recommended for portable applications.
|
||||
|
@ -54,7 +54,7 @@ The
|
||||
function
|
||||
computes
|
||||
the absolute value of the integer
|
||||
.Ar j .
|
||||
.Fa j .
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn abs
|
||||
|
@ -53,11 +53,11 @@ The
|
||||
.Fn atexit
|
||||
function
|
||||
registers the given
|
||||
.Ar function
|
||||
.Fa function
|
||||
to be called at program exit, whether via
|
||||
.Xr exit 3
|
||||
or via return from the program's
|
||||
.Em main .
|
||||
.Fn main .
|
||||
Functions so registered are called in reverse order;
|
||||
no arguments are passed.
|
||||
.Pp
|
||||
|
@ -54,9 +54,9 @@ string to double
|
||||
The
|
||||
.Fn atof
|
||||
function converts the initial portion of the string pointed to by
|
||||
.Ar nptr
|
||||
.Fa nptr
|
||||
to
|
||||
.Ar double
|
||||
.Vt double
|
||||
representation.
|
||||
.Pp
|
||||
It is equivalent to:
|
||||
|
@ -54,9 +54,9 @@ string to integer
|
||||
The
|
||||
.Fn atoi
|
||||
function converts the initial portion of the string pointed to by
|
||||
.Em nptr
|
||||
.Fa nptr
|
||||
to
|
||||
.Em integer
|
||||
.Vt int
|
||||
representation.
|
||||
.Pp
|
||||
It is equivalent to:
|
||||
|
@ -55,11 +55,11 @@ computes the value
|
||||
and returns the quotient and remainder in a structure named
|
||||
.Fa div_t
|
||||
that contains two
|
||||
.Em int
|
||||
.Vt int
|
||||
members named
|
||||
.Fa quot
|
||||
.Va quot
|
||||
and
|
||||
.Fa rem .
|
||||
.Va rem .
|
||||
.Sh SEE ALSO
|
||||
.Xr imaxdiv 3 ,
|
||||
.Xr ldiv 3 ,
|
||||
|
@ -63,9 +63,9 @@ host
|
||||
.Em environment list .
|
||||
For compatibility with differing environment conventions,
|
||||
the given arguments
|
||||
.Ar name
|
||||
.Fa name
|
||||
and
|
||||
.Ar value
|
||||
.Fa value
|
||||
may be appended and prepended,
|
||||
respectively,
|
||||
with an equal sign
|
||||
@ -74,30 +74,31 @@ with an equal sign
|
||||
The
|
||||
.Fn getenv
|
||||
function obtains the current value of the environment variable,
|
||||
.Ar name .
|
||||
.Fa name .
|
||||
If the variable
|
||||
.Ar name
|
||||
.Fa name
|
||||
is not in the current environment,
|
||||
a null pointer is returned.
|
||||
.Pp
|
||||
The
|
||||
.Fn setenv
|
||||
function inserts or resets the environment variable
|
||||
.Ar name
|
||||
.Fa name
|
||||
in the current environment list.
|
||||
If the variable
|
||||
.Ar name
|
||||
.Fa name
|
||||
does not exist in the list,
|
||||
it is inserted with the given
|
||||
.Ar value .
|
||||
.Fa value .
|
||||
If the variable does exist, the argument
|
||||
.Ar overwrite
|
||||
.Fa overwrite
|
||||
is tested; if
|
||||
.Ar overwrite is
|
||||
.Fa overwrite
|
||||
is
|
||||
zero, the
|
||||
variable is not reset, otherwise it is reset
|
||||
to the given
|
||||
.Ar value .
|
||||
.Fa value .
|
||||
.Pp
|
||||
The
|
||||
.Fn putenv
|
||||
@ -140,14 +141,14 @@ Successive calls to
|
||||
or
|
||||
.Fn putenv
|
||||
assigning a differently sized
|
||||
.Ar value
|
||||
.Fa value
|
||||
to the same
|
||||
.Ar name
|
||||
.Fa name
|
||||
will result in a memory leak. The
|
||||
.Fx
|
||||
semantics for these functions
|
||||
(namely, that the contents of
|
||||
.Ar value
|
||||
.Fa value
|
||||
are copied and that old values remain accessible indefinitely) make this
|
||||
bug unavoidable. Future versions may eliminate one or both of these
|
||||
semantic guarantees in order to fix the bug.
|
||||
|
@ -53,7 +53,7 @@ The
|
||||
.Fn labs
|
||||
function
|
||||
returns the absolute value of the long integer
|
||||
.Ar j .
|
||||
.Fa j .
|
||||
.Sh SEE ALSO
|
||||
.Xr abs 3 ,
|
||||
.Xr cabs 3 ,
|
||||
|
@ -53,15 +53,15 @@ The
|
||||
.Fn ldiv
|
||||
function
|
||||
computes the value
|
||||
.Ar num/denom
|
||||
.Fa num Ns / Ns Fa denom
|
||||
and returns the quotient and remainder in a structure named
|
||||
.Ar ldiv_t
|
||||
.Vt ldiv_t
|
||||
that contains two
|
||||
.Em long integer
|
||||
.Vt long
|
||||
members named
|
||||
.Ar quot
|
||||
.Va quot
|
||||
and
|
||||
.Ar rem .
|
||||
.Va rem .
|
||||
.Sh SEE ALSO
|
||||
.Xr div 3 ,
|
||||
.Xr imaxdiv 3 ,
|
||||
|
@ -69,7 +69,7 @@ bytes of memory.
|
||||
The allocated space is suitably aligned (after possible pointer coercion)
|
||||
for storage of any type of object.
|
||||
If the space is at least
|
||||
.Em pagesize
|
||||
.Va pagesize
|
||||
bytes in length (see
|
||||
.Xr getpagesize 3 ) ,
|
||||
the returned memory will be page boundary aligned as well.
|
||||
|
@ -57,7 +57,7 @@ function converts the initial portion of the string
|
||||
pointed to by
|
||||
.Fa nptr
|
||||
to
|
||||
.Em double
|
||||
.Vt double
|
||||
representation.
|
||||
.Pp
|
||||
The expected form of the string is an optional plus (``+'') or minus
|
||||
|
@ -53,7 +53,7 @@ function
|
||||
locates the first character matching
|
||||
.Fa c
|
||||
(converted to a
|
||||
.Em char )
|
||||
.Vt char )
|
||||
in the null-terminated string
|
||||
.Fa s .
|
||||
.Sh RETURN VALUES
|
||||
|
@ -54,7 +54,7 @@ locates the last character
|
||||
matching
|
||||
.Fa c
|
||||
(converted to a
|
||||
.Em char )
|
||||
.Vt char )
|
||||
in the null-terminated string
|
||||
.Fa s .
|
||||
.Sh RETURN VALUES
|
||||
|
@ -52,9 +52,9 @@
|
||||
The
|
||||
.Fn strchr
|
||||
function locates the first occurrence of
|
||||
.Ar c
|
||||
.Fa c
|
||||
in the string pointed to by
|
||||
.Ar s .
|
||||
.Fa s .
|
||||
The terminating
|
||||
.Dv NUL
|
||||
character is considered part of the string.
|
||||
|
@ -63,7 +63,7 @@ or catches the
|
||||
signal,
|
||||
it is notified of the calling process's termination and
|
||||
the
|
||||
.Em status
|
||||
.Fa status
|
||||
is set as defined by
|
||||
.Xr wait 2 .
|
||||
.It
|
||||
|
@ -158,7 +158,7 @@ These values may be used in changing the effective IDs later (see
|
||||
.Xr setuid 2 ) .
|
||||
.Pp
|
||||
The set-ID bits are not honored if the respective file system has the
|
||||
.Ar nosuid
|
||||
.Cm nosuid
|
||||
option enabled or if the new process file is an interpreter file. Syscall
|
||||
tracing is disabled if effective IDs are changed.
|
||||
.Pp
|
||||
|
@ -72,7 +72,7 @@ Some file systems may not support these system calls
|
||||
with buffers smaller than this size.
|
||||
.Pp
|
||||
The data in the buffer is a series of
|
||||
.Em dirent
|
||||
.Vt dirent
|
||||
structures each containing the following entries:
|
||||
.Bd -literal -offset indent
|
||||
u_int32_t d_fileno;
|
||||
|
@ -105,7 +105,7 @@ soft limit is exceeded a process may receive a signal (for example, if
|
||||
the cpu time or file size is exceeded), but it will be allowed to
|
||||
continue execution until it reaches the hard limit (or modifies
|
||||
its resource limit). The
|
||||
.Em rlimit
|
||||
.Vt rlimit
|
||||
structure is used to specify the hard and soft limits on a resource,
|
||||
.Bd -literal -offset indent
|
||||
struct rlimit {
|
||||
|
@ -61,15 +61,15 @@ must be an open file descriptor.
|
||||
The third argument to
|
||||
.Fn ioctl
|
||||
is traditionally named
|
||||
.Ar "char *argp" .
|
||||
.Va "char *argp" .
|
||||
Most uses of
|
||||
.Fn ioctl
|
||||
in
|
||||
.Fx 3.0
|
||||
however, require the third argument to be a
|
||||
.Ar caddr_t
|
||||
.Vt caddr_t
|
||||
or an
|
||||
.Ar int .
|
||||
.Vt int .
|
||||
.Pp
|
||||
An
|
||||
.Fn ioctl
|
||||
|
@ -120,7 +120,7 @@ system call
|
||||
will fail and the file position pointer will remain unchanged if:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er EBADF
|
||||
.Em Fildes
|
||||
.Fa fildes
|
||||
is not an open file descriptor.
|
||||
.It Bq Er EINVAL
|
||||
.Fa Whence
|
||||
@ -132,7 +132,7 @@ The resulting file offset would be a value which cannot be represented
|
||||
correctly in an object of type
|
||||
.Fa off_t .
|
||||
.It Bq Er ESPIPE
|
||||
.Em Fildes
|
||||
.Fa fildes
|
||||
is associated with a pipe, socket, or FIFO.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
|
@ -54,28 +54,28 @@ The
|
||||
system call grafts
|
||||
a file system object onto the system file tree
|
||||
at the point
|
||||
.Ar dir .
|
||||
.Fa dir .
|
||||
The argument
|
||||
.Ar data
|
||||
.Fa data
|
||||
describes the file system object to be mounted.
|
||||
The argument
|
||||
.Ar type
|
||||
.Fa type
|
||||
tells the kernel how to interpret
|
||||
.Ar data
|
||||
.Fa data
|
||||
(See
|
||||
.Ar type
|
||||
.Fa type
|
||||
below).
|
||||
The contents of the file system
|
||||
become available through the new mount point
|
||||
.Ar dir .
|
||||
.Fa dir .
|
||||
Any files in
|
||||
.Ar dir
|
||||
.Fa dir
|
||||
at the time
|
||||
of a successful mount are swept under the carpet so to speak, and
|
||||
are unavailable until the file system is unmounted.
|
||||
.Pp
|
||||
The following
|
||||
.Ar flags
|
||||
.Fa flags
|
||||
may be specified to
|
||||
suppress default semantics which affect file system access.
|
||||
.Bl -tag -width MNT_SYNCHRONOUS
|
||||
@ -188,10 +188,10 @@ A component of
|
||||
does not exist.
|
||||
.It Bq Er ENOTDIR
|
||||
A component of
|
||||
.Ar name
|
||||
.Fa name
|
||||
is not a directory,
|
||||
or a path prefix of
|
||||
.Ar special
|
||||
.Fa special
|
||||
is not a directory.
|
||||
.It Bq Er EBUSY
|
||||
Another process currently holds a reference to
|
||||
@ -207,18 +207,18 @@ file system mount:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er ENODEV
|
||||
A component of ufs_args
|
||||
.Ar fspec
|
||||
.Fa fspec
|
||||
does not exist.
|
||||
.It Bq Er ENOTBLK
|
||||
.Ar Fspec
|
||||
.Fa fspec
|
||||
is not a block device.
|
||||
.It Bq Er ENXIO
|
||||
The major device number of
|
||||
.Ar fspec
|
||||
.Fa fspec
|
||||
is out of range (this indicates no device driver exists
|
||||
for the associated hardware).
|
||||
.It Bq Er EBUSY
|
||||
.Ar Fspec
|
||||
.Fa fspec
|
||||
is already mounted.
|
||||
.It Bq Er EMFILE
|
||||
No space remains in the mount table.
|
||||
@ -232,7 +232,7 @@ group information for the file system.
|
||||
An I/O error occurred while reading the super block or
|
||||
cylinder group information.
|
||||
.It Bq Er EFAULT
|
||||
.Ar Fspec
|
||||
.Fa fspec
|
||||
points outside the process's allocated address space.
|
||||
.El
|
||||
.Pp
|
||||
|
@ -67,9 +67,9 @@ The default, causing the system to reboot in its usual fashion.
|
||||
Interpreted by the bootstrap program itself, causing it to
|
||||
prompt on the console as to what file should be booted.
|
||||
Normally, the system is booted from the file
|
||||
.Dq Em xx Ns No (0,0)kernel ,
|
||||
.Dq Ar xx Ns No (0,0)kernel ,
|
||||
where
|
||||
.Em xx
|
||||
.Ar xx
|
||||
is the default disk name,
|
||||
without prompting for the file name.
|
||||
.It Dv RB_DFLTROOT
|
||||
|
@ -181,7 +181,7 @@ An I/O error occurred while making or updating a directory entry.
|
||||
The requested link requires writing in a directory on a read-only file
|
||||
system.
|
||||
.It Bq Er EFAULT
|
||||
.Em Path
|
||||
Path
|
||||
points outside the process's allocated address space.
|
||||
.It Bq Er EINVAL
|
||||
.Fa From
|
||||
|
@ -177,7 +177,7 @@ current and pending instances
|
||||
of the signal are ignored and discarded.
|
||||
.Pp
|
||||
Options may be specified by setting
|
||||
.Em sa_flags .
|
||||
.Va sa_flags .
|
||||
The meaning of the various bits is as follows:
|
||||
.Bl -tag -offset indent -width SA_RESETHANDXX
|
||||
.It Dv SA_NOCLDSTOP
|
||||
@ -238,7 +238,7 @@ Restart of pending calls is requested
|
||||
by setting the
|
||||
.Dv SA_RESTART
|
||||
bit in
|
||||
.Ar sa_flags .
|
||||
.Va sa_flags .
|
||||
The affected system calls include
|
||||
.Xr open 2 ,
|
||||
.Xr read 2 ,
|
||||
|
@ -89,7 +89,7 @@ When
|
||||
.Fa set
|
||||
is null,
|
||||
the value of
|
||||
.Ar how
|
||||
.Fa how
|
||||
is insignificant and the mask remains unset
|
||||
providing a way to examine the signal mask without modification.
|
||||
.Pp
|
||||
|
@ -225,7 +225,7 @@ Search permission is denied for a component of the path prefix.
|
||||
.It Bq Er EFAULT
|
||||
.Fa sb
|
||||
or
|
||||
.Em name
|
||||
.Fa path
|
||||
points to an invalid address.
|
||||
.It Bq Er EIO
|
||||
An I/O error occurred while reading from or writing to the file system.
|
||||
|
Loading…
Reference in New Issue
Block a user