mirror of
https://github.com/freebsd/freebsd-src.git
synced 2024-11-29 11:02:44 +00:00
mdoc(7) police: Nm -> Fn where appropriate.
This commit is contained in:
parent
3b8ecdbbbe
commit
563f6bde6e
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=68946
@ -71,12 +71,7 @@ flag bits that are used to initialize a new mount point
|
||||
using the filesystem
|
||||
.El
|
||||
.Sh RETURN VALUES
|
||||
If the call to
|
||||
.Nm getvfsbyname
|
||||
is successful, 0 is returned.
|
||||
Otherwise \-1 is returned and
|
||||
.Va errno
|
||||
is set appropriately.
|
||||
.Rv -std getvfsbyname
|
||||
.Sh ERRORS
|
||||
The following errors may be reported:
|
||||
.Bl -tag -width Er
|
||||
|
@ -47,13 +47,13 @@
|
||||
.Fn shm_unlink "const char *path"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
function opens (or optionally creates) a
|
||||
.Tn POSIX
|
||||
shared memory object named
|
||||
.Fa path .
|
||||
The
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
function removes a shared memory object named
|
||||
.Fa path .
|
||||
.Pp
|
||||
@ -63,9 +63,9 @@ implementation,
|
||||
.Tn POSIX
|
||||
shared memory objects are implemented as ordinary files.
|
||||
The
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
and
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
act as wrappers around the
|
||||
.Xr open 2
|
||||
and
|
||||
@ -87,7 +87,7 @@ In addition, the
|
||||
implementation causes
|
||||
.Fn mmap
|
||||
of a descriptor returned by
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
to behave as if the
|
||||
.Dv MAP_NOSYNC
|
||||
flag had been specified to
|
||||
@ -96,7 +96,7 @@ flag had been specified to
|
||||
.Xr fcntl 2 . )
|
||||
.Pp
|
||||
The
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
function makes no effort to ensure that
|
||||
.Fa path
|
||||
refers to a shared memory object.
|
||||
@ -173,16 +173,16 @@ specifies an access mode of
|
||||
.Xr unlink 2
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
and
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
functions are believed to conform to
|
||||
.St -p1003.1b .
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
and
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
functions first appeared in
|
||||
.Fx 5.0 .
|
||||
.Sh AUTHORS
|
||||
@ -191,4 +191,3 @@ functions first appeared in
|
||||
.Pp
|
||||
.An Matthew Dillon Aq dillon@FreeBSD.org
|
||||
.Pq Dv MAP_NOSYNC
|
||||
|
||||
|
@ -232,6 +232,6 @@ or
|
||||
.Xr tty 4
|
||||
.Sh HISTORY
|
||||
This
|
||||
.Nm signal
|
||||
.Fn signal
|
||||
facility appeared in
|
||||
.Bx 4.0 .
|
||||
|
@ -47,7 +47,7 @@
|
||||
.Fn tcsetpgrp "int fd" "pid_t pgrp_id"
|
||||
.Sh DESCRIPTION
|
||||
If the process has a controlling terminal, the
|
||||
.Nm tcsetpgrp
|
||||
.Fn tcsetpgrp
|
||||
function sets the foreground process group ID associated with the
|
||||
terminal device to
|
||||
.Fa pgrp_id .
|
||||
@ -60,16 +60,12 @@ The value of
|
||||
.Fa pgrp_id
|
||||
must be the same as the process group ID of a process in the same
|
||||
session as the calling process.
|
||||
.Pp
|
||||
Upon successful completion,
|
||||
.Nm tcsetpgrp
|
||||
returns a value of zero.
|
||||
.Sh RETURN VALUES
|
||||
.Rv -std tcsetpgrp
|
||||
.Sh ERRORS
|
||||
If an error occurs,
|
||||
.Nm tcsetpgrp
|
||||
returns -1 and the global variable
|
||||
.Va errno
|
||||
is set to indicate the error, as follows:
|
||||
The
|
||||
.Fn tcsetpgrp
|
||||
function will fail if:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er EBADF
|
||||
The
|
||||
@ -97,7 +93,7 @@ session as the calling process.
|
||||
.Xr tcgetpgrp 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm tcsetpgprp
|
||||
.Fn tcsetpgrp
|
||||
function is expected to be compliant with the
|
||||
.St -p1003.1-88
|
||||
specification.
|
||||
|
@ -190,7 +190,7 @@ if (unvis(&out, (char)0, &state, UNVIS_END) == UNVIS_VALID)
|
||||
.Re
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm unvis
|
||||
.Fn unvis
|
||||
function
|
||||
first appeared in
|
||||
.Bx 4.4 .
|
||||
|
@ -411,7 +411,7 @@ Similarly, if it resolves to IPv6,
|
||||
socket is used.
|
||||
Observe that there is no hardcoded reference to particular address family.
|
||||
The code works even if
|
||||
.Nm getaddrinfo
|
||||
.Fn getaddrinfo
|
||||
returns addresses that are not IPv4/v6.
|
||||
.Bd -literal -offset indent
|
||||
struct addrinfo hints, *res, *res0;
|
||||
|
@ -235,17 +235,17 @@ for malformed requests.
|
||||
.Re
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm inet_ntop
|
||||
.Fn inet_ntop
|
||||
and
|
||||
.Nm inet_pton
|
||||
.Fn inet_pton
|
||||
functions conform to
|
||||
.St -xns5.2d2.0 .
|
||||
Note that
|
||||
.Nm inet_pton
|
||||
.Fn inet_pton
|
||||
does not accept 1-, 2-, or 3-part dotted addresses; all four parts
|
||||
must be specified.
|
||||
This is a narrower input set than that accepted by
|
||||
.Nm inet_aton .
|
||||
.Fn inet_aton .
|
||||
.Sh HISTORY
|
||||
These
|
||||
functions appeared in
|
||||
|
@ -57,7 +57,7 @@ The
|
||||
.Fn getrpcent
|
||||
function reads the next line of the file, opening the file if necessary.
|
||||
The
|
||||
.Nm getrpcent
|
||||
.Fn setrpcent
|
||||
function opens and rewinds the file. If the
|
||||
.Fa stayopen
|
||||
flag is non-zero,
|
||||
|
@ -37,11 +37,11 @@
|
||||
.Fn setresuid "uid_t ruid" "uid_t euid" "uid_t suid"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm setresuid
|
||||
.Fn setresuid
|
||||
system call sets the real,
|
||||
effective and saved user IDs of the current process.
|
||||
The analogous
|
||||
.Nm setresgid
|
||||
.Fn setresgid
|
||||
sets the real, effective and saved group IDs.
|
||||
.Pp
|
||||
Privileged processes may set these IDs
|
||||
|
@ -47,13 +47,13 @@
|
||||
.Fn shm_unlink "const char *path"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
function opens (or optionally creates) a
|
||||
.Tn POSIX
|
||||
shared memory object named
|
||||
.Fa path .
|
||||
The
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
function removes a shared memory object named
|
||||
.Fa path .
|
||||
.Pp
|
||||
@ -63,9 +63,9 @@ implementation,
|
||||
.Tn POSIX
|
||||
shared memory objects are implemented as ordinary files.
|
||||
The
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
and
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
act as wrappers around the
|
||||
.Xr open 2
|
||||
and
|
||||
@ -87,7 +87,7 @@ In addition, the
|
||||
implementation causes
|
||||
.Fn mmap
|
||||
of a descriptor returned by
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
to behave as if the
|
||||
.Dv MAP_NOSYNC
|
||||
flag had been specified to
|
||||
@ -96,7 +96,7 @@ flag had been specified to
|
||||
.Xr fcntl 2 . )
|
||||
.Pp
|
||||
The
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
function makes no effort to ensure that
|
||||
.Fa path
|
||||
refers to a shared memory object.
|
||||
@ -173,16 +173,16 @@ specifies an access mode of
|
||||
.Xr unlink 2
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
and
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
functions are believed to conform to
|
||||
.St -p1003.1b .
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm shm_open
|
||||
.Fn shm_open
|
||||
and
|
||||
.Nm shm_unlink
|
||||
.Fn shm_unlink
|
||||
functions first appeared in
|
||||
.Fx 5.0 .
|
||||
.Sh AUTHORS
|
||||
@ -191,4 +191,3 @@ functions first appeared in
|
||||
.Pp
|
||||
.An Matthew Dillon Aq dillon@FreeBSD.org
|
||||
.Pq Dv MAP_NOSYNC
|
||||
|
||||
|
@ -57,7 +57,7 @@ any objects in a lower layer of the
|
||||
union stack to become visible once more.
|
||||
.Pp
|
||||
Eventually, the
|
||||
.Nm undelete
|
||||
.Fn undelete
|
||||
functionality may be expanded to other filesystems able to recover
|
||||
deleted files such as the log-structured filesystem.
|
||||
.Sh RETURN VALUES
|
||||
@ -102,5 +102,5 @@ points outside the process's allocated address space.
|
||||
.Xr mount_union 8
|
||||
.Sh HISTORY
|
||||
An
|
||||
.Nm undelete
|
||||
.Fn undelete
|
||||
function call first appeared in 4.4BSD-Lite.
|
||||
|
@ -49,21 +49,26 @@
|
||||
.Fn ascftime "char *s" "const char *format" "const struct tm *tmptr"
|
||||
.Sh DESCRIPTION
|
||||
.Bf -symbolic
|
||||
The cftime and ascftime functions are made obsolete by strftime(3).
|
||||
The
|
||||
.Fn cftime
|
||||
and
|
||||
.Fn ascftime
|
||||
functions are made obsolete by
|
||||
.Xr strftime 3 .
|
||||
They are available from the compatibility library, libcompat.
|
||||
.Ef
|
||||
.Pp
|
||||
Use of the functions
|
||||
.Nm cftime
|
||||
.Fn cftime
|
||||
and
|
||||
.Nm ascftime
|
||||
.Fn ascftime
|
||||
is strongly deprecated, since there is no way to check for a buffer
|
||||
overflow condition.
|
||||
Use
|
||||
.Xr strftime 3
|
||||
instead.
|
||||
|
||||
.Nm Ascftime
|
||||
.Fn Ascftime
|
||||
is almost identical with
|
||||
.Xr strftime 3 ,
|
||||
with the only exception there's no parameter to tell about the
|
||||
@ -75,7 +80,7 @@ if a
|
||||
.Em NULL
|
||||
pointer is given.
|
||||
|
||||
.Nm Cftime
|
||||
.Fn Cftime
|
||||
does the same job, but it first invokes
|
||||
.Xr localtime 3
|
||||
in order to convert the given
|
||||
@ -86,9 +91,9 @@ argument.
|
||||
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Nm cftime
|
||||
.Fn cftime
|
||||
and
|
||||
.Nm ascftime
|
||||
.Fn ascftime
|
||||
functions return the number of characters written to the output
|
||||
buffer
|
||||
.Fa s ,
|
||||
|
@ -43,12 +43,15 @@
|
||||
.Fn cuserid "char *s"
|
||||
.Sh DESCRIPTION
|
||||
.Bf -symbolic
|
||||
The cuserid function is made obsolete by getpwuid.
|
||||
The
|
||||
.Fn cuserid
|
||||
function is made obsolete by
|
||||
.Xr getpwuid 3 .
|
||||
It is available from the compatibility library, libcompat.
|
||||
.Ef
|
||||
.Pp
|
||||
The function
|
||||
.Nm cuserid
|
||||
.Fn cuserid
|
||||
gets the user name associated with the effective UID of the current
|
||||
process. If the argument
|
||||
.Fa s
|
||||
@ -64,7 +67,7 @@ If
|
||||
.Fa s
|
||||
is NULL, an internal array is used and its address will be returned.
|
||||
.Sh RETURN VALUES
|
||||
.Nm cuserid
|
||||
.Fn cuserid
|
||||
returns the address of an array in which the name has been stored.
|
||||
|
||||
If the name associated with the effective UID of the current process
|
||||
|
@ -112,11 +112,11 @@ will underflow.
|
||||
.Xr math 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm lgamma
|
||||
.Fn lgamma
|
||||
function appeared in
|
||||
.Bx 4.3 .
|
||||
The
|
||||
.Nm gamma
|
||||
.Fn gamma
|
||||
function appeared in
|
||||
.Bx 4.4 .
|
||||
The name
|
||||
|
@ -113,11 +113,11 @@ carried.
|
||||
.Xr math 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm sqrt
|
||||
.Fn sqrt
|
||||
function conforms to
|
||||
.St -ansiC .
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm cbrt
|
||||
.Fn cbrt
|
||||
function appeared in
|
||||
.Bx 4.3 .
|
||||
|
@ -125,11 +125,11 @@ will underflow.
|
||||
.Xr math 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm lgamma
|
||||
.Fn lgamma
|
||||
function appeared in
|
||||
.Bx 4.3 .
|
||||
The
|
||||
.Nm gamma
|
||||
.Fn gamma
|
||||
function appeared in
|
||||
.Bx 4.4 .
|
||||
The name
|
||||
|
@ -124,11 +124,11 @@ carried.
|
||||
.Xr math 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm sqrt
|
||||
.Fn sqrt
|
||||
function conforms to
|
||||
.St -ansiC .
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm cbrt
|
||||
.Fn cbrt
|
||||
function appeared in
|
||||
.Bx 4.3 .
|
||||
|
Loading…
Reference in New Issue
Block a user