d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

mdoc(7) police: Tidy up the syscall language.

Browse Source 
Stop calling system calls "function calls".

Use "The .Fn system call" a-la "The .Nm utility".

When referring to a non-BSD implementation in
the HISTORY section, call syscall a function,
to be safe.
This commit is contained in:
Ruslan Ermilov 2002-12-18 09:22:32 +00:00
parent a1096fe6df
commit 2faeeff4c9
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=108028
147 changed files with 1011 additions and 668 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lib/libc/sys/_exit.2
View File

@ -47,7 +47,7 @@
.Sh DESCRIPTION
The
.Fn _exit
function
system call
terminates a process with the following consequences:
.Bl -bullet
.It
@ -103,7 +103,9 @@ before
calling
.Fn _exit .
.Sh RETURN VALUES
The
.Fn _exit
system call
can never return.
.Sh SEE ALSO
.Xr fork 2 ,
@ -113,10 +115,10 @@ can never return.
.Sh STANDARDS
The
.Fn _exit
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
An
The
.Fn _exit
function call appeared in
function appeared in
.At v7 .

6
lib/libc/sys/accept.2
View File

@ -56,7 +56,7 @@ and is listening for connections after a
.Xr listen 2 .
The
.Fn accept
call
system call
extracts the first connection request
on the queue of pending connections, creates
a new socket with the same properties as
@ -125,7 +125,7 @@ integer that is a descriptor for the accepted socket.
.Sh ERRORS
The
.Fn accept
will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EBADF
The descriptor is invalid.
@ -165,5 +165,5 @@ on the listen queue.
.Sh HISTORY
The
.Fn accept
function appeared in
system call appeared in
.Bx 4.2 .

16
lib/libc/sys/access.2
View File

@ -51,7 +51,7 @@ The
.Fn access
and
.Fn eaccess
functions check the accessibility of the
system calls check the accessibility of the
file named by
the
.Fa path
@ -80,12 +80,12 @@ section of
.Pp
The
.Fn eaccess
call uses
system call uses
the effective user ID and the group access list
to authorize the request;
the
.Fn access
call uses
system call uses
the real user ID in place of the effective user ID,
the real group ID in place of the effective group ID,
and the rest of the group access list.
@ -130,7 +130,7 @@ An I/O error occurred while reading from or writing to the file system.
.Sh SECURITY CONSIDERATIONS
The
.Fn access
call
system call
is a potential security hole due to race conditions and
should never be used.
Set-user-ID and set-group-ID applications should restore the
@ -140,7 +140,7 @@ and perform actions directly rather than use
to simulate access checks for the real user or group ID.
The
.Fn eaccess
call
system call
likewise may be subject to races if used inappropriately.
.Sh SEE ALSO
.Xr chmod 2 ,
@ -149,10 +149,10 @@ likewise may be subject to races if used inappropriately.
.Sh STANDARDS
The
.Fn access
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
An
The
.Fn access
function call appeared in
function appeared in
.At v7 .

8
lib/libc/sys/acct.2
View File

@ -47,7 +47,7 @@
.Sh DESCRIPTION
The
.Fn acct
call enables or disables the collection of system accounting
system call enables or disables the collection of system accounting
records.
If the argument
.Fa file
@ -84,7 +84,7 @@ The file must exist and the call may be exercised only by the super-user.
.Sh ERRORS
The
.Fn acct
function will fail if one of the following is true:
system call will fail if one of the following is true:
.Bl -tag -width Er
.It Bq Er EPERM
The caller is not the super-user.
@ -112,7 +112,7 @@ An I/O error occurred while reading from or writing to the file system.
.Xr acct 5 ,
.Xr sa 8
.Sh HISTORY
An
The
.Fn acct
function call appeared in
function appeared in
.At v7 .

9
lib/libc/sys/adjtime.2
View File

@ -47,7 +47,7 @@
.Sh DESCRIPTION
The
.Fn adjtime
function
system call
makes small adjustments to the system time, as returned by
.Xr gettimeofday 2 ,
advancing or retarding it
@ -82,15 +82,16 @@ of computers in a local area network.
Such time servers would slow down the clocks of some machines
and speed up the clocks of others to bring them to the average network time.
.Pp
The call
The
.Fn adjtime
system call
is restricted to the super-user.
.Sh RETURN VALUES
.Rv -std adjtime
.Sh ERRORS
The
.Fn adjtime
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EFAULT
An argument points outside the process's allocated address space.
@ -110,5 +111,5 @@ The process's effective user ID is not that of the super-user.
.Sh HISTORY
The
.Fn adjtime
function call appeared in
system call appeared in
.Bx 4.3 .

12
lib/libc/sys/aio_cancel.2
View File

@ -39,7 +39,7 @@
.Sh DESCRIPTION
The
.Fn aio_cancel
function cancels the outstanding asynchronous
system call cancels the outstanding asynchronous
I/O request for the file descriptor specified in
.Fa fildes .
If
@ -52,16 +52,16 @@ Requests complete with an error result of
.Sh RESTRICTIONS
The
.Fn aio_cancel
function does not cancel asynchronous I/O requests for raw disk devices.
system call does not cancel asynchronous I/O requests for raw disk devices.
The
.Fn aio_cancel
function will always return
system call will always return
.Dv AIO_NOTCANCELED
for file descriptors associated with raw disk devices.
.Sh RETURN VALUES
The
.Fn aio_cancel
function returns -1 to indicate an error, or one of the following:
system call returns -1 to indicate an error, or one of the following:
.Bl -tag -width Dv
.It Bq Dv AIO_CANCELED
All outstanding requests meeting the criteria specified were cancelled.
@ -91,13 +91,13 @@ is an invalid file descriptor.
.Sh STANDARDS
The
.Fn aio_cancel
function is expected to conform to the
system call is expected to conform to the
.St -p1003.2
standard.
.Sh HISTORY
The
.Fn aio_cancel
function first appeared in
system call first appeared in
.Fx 3.0 .
The first functional implementation of
.Fn aio_cancel

10
lib/libc/sys/aio_error.2
View File

@ -39,7 +39,7 @@
.Sh DESCRIPTION
The
.Fn aio_error
function returns the error status of the asynchronous I/O request
system call returns the error status of the asynchronous I/O request
associated with the structure pointed to by
.Fa iocb .
.Sh RETURN VALUES
@ -64,7 +64,7 @@ to indicate the error condition.
.Sh ERRORS
The
.Fn aio_error
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa iocb
@ -81,14 +81,16 @@ does not reference an outstanding asynchronous I/O request.
.Xr write 2 ,
.Xr aio 4
.Sh STANDARDS
The
.Fn aio_error
system call
is expected to conform to the
.St -p1003.2
standard.
.Sh HISTORY
The
.Nm
function first appeared in
.Fn aio_error
system call first appeared in
.Fx 3.0 .
.Sh AUTHORS
This

26
lib/libc/sys/aio_read.2
View File

@ -40,7 +40,7 @@
.Sh DESCRIPTION
The
.Fn aio_read
function allows the calling process to read
system call allows the calling process to read
.Fa iocb->aio_nbytes
from the descriptor
.Fa iocb->aio_fildes
@ -61,7 +61,7 @@ The
.Fa iocb->aio_lio_opcode
is ignored by the
.Fn aio_read
call.
system call.
.Pp
The
.Fa iocb
@ -110,26 +110,26 @@ None.
.Sh ERRORS
The
.Fn aio_read
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
The request was not queued because of system resource limitations.
.It Bq Er ENOSYS
The
.Fn aio_read
call is not supported.
system call is not supported.
.El
.Pp
The following conditions may be synchronously detected when the
.Fn aio_read
call is made, or asynchronously, at any time thereafter. If they
system call is made, or asynchronously, at any time thereafter. If they
are detected at call time,
.Fn aio_read
returns -1 and sets
.Va errno
appropriately; otherwise the
.Fn aio_return
function must be called, and will return -1, and
system call must be called, and will return -1, and
.Fn aio_error
must be called to determine the actual calue that would have been
returned in
@ -160,13 +160,13 @@ offset maximum.
If the request is successfully enqueued, but subsequently cancelled
or an error occurs, the value returned by the
.Fn aio_return
function is per the
system call is per the
.Xr read 2
call, and the value returned by the
system call, and the value returned by the
.Fn aio_error
function is either one of the error returns from the
system call is either one of the error returns from the
.Xr read 2
call, or one of:
system call, or one of:
.Bl -tag -width Er
.It Bq Er EBADF
.Fa iocb->aio_fildes
@ -190,13 +190,13 @@ would be invalid.
.Sh STANDARDS
The
.Fn aio_read
call is expected to conform to the
system call is expected to conform to the
.St -p1003.2
standard.
.Sh HISTORY
The
.Nm
function first appeared in
.Fn aio_read
system call first appeared in
.Fx 3.0 .
.Sh AUTHORS
This

12
lib/libc/sys/aio_return.2
View File

@ -39,11 +39,13 @@
.Sh DESCRIPTION
The
.Fn aio_return
function returns the final status of the asynchronous I/O request
system call returns the final status of the asynchronous I/O request
associated with the structure pointed to by
.Fa iocb .
.Pp
The
.Fn aio_return
system call
should only be called once, to obtain the final status of an asynchronous
I/O operation once
.Xr aio_error 2
@ -66,7 +68,7 @@ to indicate the error condition.
.Sh ERRORS
The
.Fn aio_return
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa iocb
@ -83,14 +85,16 @@ does not reference an outstanding asynchronous I/O request.
.Xr write 2 ,
.Xr aio 4
.Sh STANDARDS
The
.Fn aio_return
system call
is expected to conform to the
.St -p1003.2
standard.
.Sh HISTORY
The
.Nm
function first appeared in
.Fn aio_return
system call first appeared in
.Fx 3.0 .
.Sh AUTHORS
This

10
lib/libc/sys/aio_suspend.2
View File

@ -39,7 +39,7 @@
.Sh DESCRIPTION
The
.Fn aio_suspend
function suspends the calling process until at least one of the
system call suspends the calling process until at least one of the
specified asynchronous I/O requests have completed, a signal is
delivered, or the
.Fa timeout
@ -70,7 +70,7 @@ to indicate the error, as enumerated below.
.Sh ERRORS
The
.Fn aio_suspend
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
the
@ -93,14 +93,16 @@ the suspend was interrupted by a signal.
.Xr aio_write 2 ,
.Xr aio 4
.Sh STANDARDS
The
.Fn aio_suspend
system call
is expected to conform to the
.St -p1003.2
standard.
.Sh HISTORY
The
.Nm
function first appeared in
.Fn aio_suspend
system call first appeared in
.Fx 3.0 .
.Sh AUTHORS
This

12
lib/libc/sys/aio_waitcomplete.2
View File

@ -39,7 +39,7 @@
.Sh DESCRIPTION
The
.Fn aio_waitcomplete
function waits for completion of an asynchronous I/O request.
system call waits for completion of an asynchronous I/O request.
Upon completion,
.Fn aio_waitcomplete
returns the result of the function and sets
@ -64,7 +64,7 @@ argument should be non-NULL, pointing to a zero-valued timeval structure.
.Pp
The
.Fn aio_waitcomplete
function also serves the function of
system call also serves the function of
.Fn aio_return ,
thus
.Fn aio_return
@ -91,7 +91,7 @@ to indicate the error condition.
.Sh ERRORS
The
.Fn aio_waitcomplete
function fails if:
system call fails if:
.Bl -tag -width Er
.It Bq Er EINVAL
The specified time limit is invalid.
@ -122,16 +122,16 @@ completed.
.Sh STANDARDS
The
.Fn aio_waitcomplete
function is a
system call is a
.Fx Ns -specific
extension.
.Sh HISTORY
The
.Fn aio_waitcomplete
function first appeared in
system call first appeared in
.Fx 4.0 .
.Sh AUTHORS
The
.Fn aio_waitcomplete
function and this manual page were written by
system call and this manual page were written by
.An Christopher M Sedore Aq cmsedore@maxwell.syr.edu .

26
lib/libc/sys/aio_write.2
View File

@ -39,7 +39,7 @@
.Sh DESCRIPTION
The
.Fn aio_write
function allows the calling process to write
system call allows the calling process to write
.Fa iocb->aio_nbytes
from the buffer pointed to by
.Fa iocb->aio_buf
@ -96,7 +96,7 @@ The asynchronous I/O control buffer
.Fa iocb
should be zeroed before the
.Fn aio_write
call to avoid passing bogus context information to the kernel.
system call to avoid passing bogus context information to the kernel.
.Pp
Modifications of the Asynchronous I/O Control Block structure or the
buffer contents after the request has been enqueued, but before the
@ -112,26 +112,26 @@ no I/O will occur.
.Sh ERRORS
The
.Fn aio_write
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
The request was not queued because of system resource limitations.
.It Bq Er ENOSYS
The
.Fn aio_write
call is not supported.
system call is not supported.
.El
.Pp
The following conditions may be synchronously detected when the
.Fn aio_write
call is made, or asynchronously, at any time thereafter. If they
system call is made, or asynchronously, at any time thereafter. If they
are detected at call time,
.Fn aio_write
returns -1 and sets
.Va errno
appropriately; otherwise the
.Fn aio_return
function must be called, and will return -1, and
system call must be called, and will return -1, and
.Fn aio_error
must be called to determine the actual value that would have been
returned in
@ -154,13 +154,13 @@ is not valid.
If the request is successfully enqueued, but subsequently canceled
or an error occurs, the value returned by the
.Fn aio_return
function is per the
system call is per the
.Xr write 2
call, and the value returned by the
system call, and the value returned by the
.Fn aio_error
function is either one of the error returns from the
system call is either one of the error returns from the
.Xr write 2
call, or one of:
system call, or one of:
.Bl -tag -width Er
.It Bq Er EBADF
.Fa iocb->aio_fildes
@ -181,14 +181,16 @@ would be invalid.
.Xr aio_waitcomplete 2 ,
.Xr aio 4
.Sh STANDARDS
The
.Fn aio_write
system call
is expected to conform to the
.St -p1003.2
standard.
.Sh HISTORY
The
.Nm
Function first appeared in
.Fn aio_write
system call first appeared in
.Fx 3.0 .
.Sh AUTHORS
This manual page was written by

8
lib/libc/sys/bind.2
View File

@ -48,7 +48,7 @@
.Sh DESCRIPTION
The
.Fn bind
function
system call
assigns the local protocol address to a socket.
When a socket is created
with
@ -56,7 +56,7 @@ with
it exists in an address family space but has no protocol address assigned.
The
.Fn bind
function requests that
system call requests that
.Fa addr
be assigned to the socket.
.Sh NOTES
@ -76,7 +76,7 @@ before populating it and passing it to
.Sh ERRORS
The
.Fn bind
call will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
Kernel resources to complete the request are
@ -127,5 +127,5 @@ An empty pathname was specified.
.Sh HISTORY
The
.Fn bind
function call appeared in
system call appeared in
.Bx 4.2 .

8
lib/libc/sys/brk.2
View File

@ -128,9 +128,11 @@ is returned and the global variable
.Va errno
is set to indicate the error.
.Sh ERRORS
The
.Fn brk
or
and
.Fn sbrk
functions
will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
@ -167,7 +169,7 @@ from a failure caused by exceeding the maximum size of
the data segment without consulting
.Xr getrlimit 2 .
.Sh HISTORY
A
The
.Fn brk
function call appeared in
function appeared in
.At v7 .

17
lib/libc/sys/chdir.2
View File

@ -53,7 +53,7 @@ The
argument points to the pathname of a directory.
The
.Fn chdir
function
system call
causes the named directory
to become the current working directory, that is,
the starting point for path searches of pathnames not beginning with
@ -62,7 +62,7 @@ a slash,
.Pp
The
.Fn fchdir
function
system call
causes the directory referenced by
.Fa fd
to become the current working directory,
@ -77,7 +77,7 @@ a process must have execute (search) access to the directory.
.Sh ERRORS
The
.Fn chdir
function
system call
will fail and the current working directory will be unchanged if
one or more of the following are true:
.Bl -tag -width Er
@ -102,7 +102,7 @@ An I/O error occurred while reading from or writing to the file system.
.Pp
The
.Fn fchdir
function
system call
will fail and the current working directory will be unchanged if
one or more of the following are true:
.Bl -tag -width Er
@ -121,15 +121,14 @@ is not a valid file descriptor.
.Sh STANDARDS
The
.Fn chdir
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
The
.Fn chdir
function call appeared in
system call appeared in
.At v7 .
The
.Fn fchdir
function call
appeared in
system call appeared in
.Bx 4.2 .

10
lib/libc/sys/chflags.2
View File

@ -123,7 +123,7 @@ for details.)
.Sh ERRORS
The
.Fn chflags
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
@ -154,7 +154,7 @@ The underlying file system does not support file flags.
.Pp
The
.Fn fchflags
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EBADF
The descriptor is not valid.
@ -181,8 +181,8 @@ The underlying file system does not support file flags.
.Xr mount_unionfs 8
.Sh HISTORY
The
.Nm chflags
.Fn chflags
and
.Nm fchflags
functions first appeared in
.Fn fchflags
system calls first appeared in
.Bx 4.4 .

23
lib/libc/sys/chmod.2
View File

@ -59,7 +59,7 @@ are changed to
.Fa mode .
The
.Fn chmod
function verifies that the process owner (user) either owns
system call verifies that the process owner (user) either owns
the file specified by
.Fa path
(or
@ -68,12 +68,12 @@ or
is the super-user.
The
.Fn chmod
function follows symbolic links to operate on the target of the link
system call follows symbolic links to operate on the target of the link
rather than the link itself.
.Pp
The
.Fa lchmod
function is similar to
.Fn lchmod
system call is similar to
.Fn chmod
but does not follow symbolic links.
.Pp
@ -161,7 +161,7 @@ at the expense of a degree of compatibility.
.Sh ERRORS
The
.Fn chmod
function
system call
will fail and the file mode will be unchanged if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -191,7 +191,7 @@ An attempt was made to set the sticky bit upon an executable.
.Pp
The
.Fn fchmod
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EBADF
The descriptor is not valid.
@ -212,23 +212,22 @@ An I/O error occurred while reading from or writing to the file system.
.Sh STANDARDS
The
.Fn chmod
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 ,
except for the return of
.Er EFTYPE
and the use of
.Dv S_ISTXT .
.Sh HISTORY
A
The
.Fn chmod
function call appeared in
function appeared in
.At v7 .
The
.Fn fchmod
function call
appeared in
system call appeared in
.Bx 4.2 .
The
.Fn lchmod
function call appeared in
system call appeared in
.Fx 3.0 .

23
lib/libc/sys/chown.2
View File

@ -70,26 +70,28 @@ capability is restricted to the super-user.
.Pp
The
.Fn chown
function
system call
clears the set-user-id and set-group-id bits
on the file
to prevent accidental or mischievous creation of
set-user-id and set-group-id programs if not executed
by the super-user.
The
.Fn chown
system call
follows symbolic links to operate on the target of the link
rather than the link itself.
.Pp
The
.Fn fchown
function
system call
is particularly useful when used in conjunction
with the file locking primitives (see
.Xr flock 2 ) .
.Pp
The
.Fn lchown
function is similar to
system call is similar to
.Fn chown
but does not follow symbolic links.
.Pp
@ -128,7 +130,7 @@ An I/O error occurred while reading from or writing to the file system.
.Pp
The
.Fn fchown
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EBADF
.Fa fd
@ -151,25 +153,24 @@ An I/O error occurred while reading from or writing to the file system.
.Sh STANDARDS
The
.Fn chown
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
The
.Fn chown
function call appeared in
function appeared in
.At v7 .
The
.Fn fchown
function call
appeared in
system call appeared in
.Bx 4.2 .
.Pp
The
.Fn chown
function was changed to follow symbolic links in
system call was changed to follow symbolic links in
.Bx 4.4 .
The
.Fn lchown
function was added in
system call was added in
.Fx 3.0
to compensate for the loss of functionality.

10
lib/libc/sys/chroot.2
View File

@ -49,7 +49,7 @@
is the address of the pathname of a directory, terminated by an ASCII NUL.
The
.Fn chroot
function causes
system call causes
.Fa dirname
to become the root directory,
that is, the starting point for path searches of pathnames
@ -87,9 +87,9 @@ is set to one (the default),
will fail with
.Er EPERM
if there are any directories open and the
process is already subject to a
process is already subject to the
.Fn chroot
call.
system call.
.Pp
Any other value for
.Ql kern.chroot_allow_open_directories
@ -102,7 +102,7 @@ is set to indicate an error.
.Sh ERRORS
The
.Fn chroot
function
system call
will fail and the root directory will be unchanged if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -131,5 +131,5 @@ An I/O error occurred while reading from or writing to the file system.
.Sh HISTORY
The
.Fn chroot
function call appeared in
system call appeared in
.Bx 4.2 .

11
lib/libc/sys/clock_gettime.2
View File

@ -1,5 +1,4 @@
.\" $OpenBSD: clock_gettime.2,v 1.4 1997/05/08 20:21:16 kstailey Exp $
.\" $FreeBSD$
.\"
.\" Copyright (c) 1980, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@ -32,6 +31,8 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd May 8, 1997
.Dt CLOCK_GETTIME 2
.Os
@ -91,7 +92,7 @@ system call even when the system is secure.
.Pp
The resolution (granularity) of a clock is returned by the
.Fn clock_getres
call. This value is placed in a (non-NULL)
system call. This value is placed in a (non-NULL)
.Fa *tp .
.Sh RETURN VALUES
.Rv -std
@ -118,6 +119,8 @@ A user other than the super-user attempted to set the time.
.Sh STANDARDS
The
.Fn clock_gettime ,
etc.\&
functions conform to
.Fn clock_settime ,
and
.Fn clock_getres
system calls conform to
.St -p1003.1b-93 .

12
lib/libc/sys/close.2
View File

@ -47,7 +47,7 @@
.Sh DESCRIPTION
The
.Fn close
call deletes a descriptor from the per-process object
system call deletes a descriptor from the per-process object
reference table.
If this is the last reference to the underlying object, the
object will be deactivated.
@ -74,7 +74,7 @@ When a process exits,
all associated file descriptors are freed, but since there is
a limit on active descriptors per processes, the
.Fn close
function call
system call
is useful when a large quantity of file descriptors are being handled.
.Pp
When a process forks (see
@ -106,7 +106,7 @@ which is to not close the descriptor.
.Sh ERRORS
The
.Fn close
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EBADF
.Fa D
@ -126,10 +126,10 @@ An interrupt was received.
.Sh STANDARDS
The
.Fn close
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
The
.Fn close
function call appeared in
function appeared in
.At v7 .

4
lib/libc/sys/connect.2
View File

@ -76,7 +76,7 @@ by connecting to an invalid address, such as a null address.
.Sh ERRORS
The
.Fn connect
call fails if:
system call fails if:
.Bl -tag -width Er
.It Bq Er EBADF
.Fa s
@ -142,5 +142,5 @@ Too many symbolic links were encountered in translating the pathname.
.Sh HISTORY
The
.Fn connect
function call appeared in
system call appeared in
.Bx 4.2 .

18
lib/libc/sys/dup.2
View File

@ -50,7 +50,7 @@
.Sh DESCRIPTION
The
.Fn dup
function
system call
duplicates an existing object descriptor and returns its value to
the calling process
.Fa ( newd
@ -89,7 +89,7 @@ If a separate pointer into the file is desired, a different
object reference to the file must be obtained by issuing an
additional
.Xr open 2
call.
system call.
The close-on-exec flag on the new file descriptor is unset.
.Pp
In
@ -100,9 +100,9 @@ is specified. If this descriptor is already in use and
.Fa oldd
\*(Ne
.Fa newd ,
the descriptor is first deallocated as if a
the descriptor is first deallocated as if the
.Xr close 2
call had been used.
system call had been used.
If
.Fa oldd
is not a valid descriptor, then
@ -127,7 +127,7 @@ The
.Fn dup
and
.Fn dup2
functions fail if:
system calls fail if:
.Bl -tag -width Er
.It Bq Er EBADF
.Fa Oldd
@ -151,12 +151,12 @@ The
.Fn dup
and
.Fn dup2
function calls are expected to conform to
system calls are expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
The
.Fn dup
and a
and
.Fn dup2
function call appeared in
functions appeared in
.At v7 .

12
lib/libc/sys/execve.2
View File

@ -47,7 +47,7 @@
.Sh DESCRIPTION
The
.Fn execve
function
system call
transforms the calling process into a new process.
The new process is constructed from an ordinary file,
whose name is pointed to by
@ -183,7 +183,7 @@ the calling process:
.Pp
When a program is executed as a result of an
.Fn execve
call, it is entered as follows:
system call, it is entered as follows:
.Bd -literal -offset indent
main(argc, argv, envp)
int argc;
@ -202,7 +202,7 @@ to the arguments themselves.
.Sh RETURN VALUES
As the
.Fn execve
function overlays the current process image
system call overlays the current process image
with a new process image the successful call
has no process to return to.
If
@ -214,7 +214,7 @@ is set to indicate the error.
.Sh ERRORS
The
.Fn execve
function
system call
will fail and return to the calling process if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -289,7 +289,7 @@ of a super-user as well.
.Sh STANDARDS
The
.Fn execve
function conforms to
system call conforms to
.St -p1003.1-2001 ,
with the exception of reopening descriptors 0, 1, and/or 2 in certain
circumstances.
@ -300,5 +300,5 @@ The support for executing interpreted programs is an extension.
.Sh HISTORY
The
.Fn execve
function call appeared in
system call appeared in
.Bx 4.2 .

12
lib/libc/sys/extattr_get_file.2
View File

@ -71,19 +71,19 @@ They exist as
pairs within a set of namespaces.
The
.Fn extattr_get_file
call retrieves the value of the specified extended attribute into
system call retrieves the value of the specified extended attribute into
a buffer pointed to by
.Fa data
of size
.Fa nbytes .
The
.Fn extattr_set_file
call sets the value of the specified extended attribute to the data
system call sets the value of the specified extended attribute to the data
described by
.Fa data .
The
.Fn extattr_delete_file
call deletes the extended attribute specified.
system call deletes the extended attribute specified.
The
.Fn extattr_get_file
and
@ -111,11 +111,11 @@ The
.Fn extattr_get_link ,
and
.Fn extattr_set_link
functions behave in the same way as their _file counterparts, except that
system calls behave in the same way as their _file counterparts, except that
they do not follow symlinks.
.Pp
The
.Fn extatttr_get_fd ,
.Fn extattr_get_fd ,
.Fn extattr_set_fd ,
and
.Fn extattr_delete_fd
@ -195,7 +195,7 @@ The
.Fn extattr_set_fd ,
and
.Fn extattr_delete_fd
functions may also fail if:
system calls may also fail if:
.Bl -tag -width Er
.It Bq Er EBADF
The file descriptor referenced by

16
lib/libc/sys/fcntl.2
View File

@ -47,14 +47,14 @@
.Sh DESCRIPTION
The
.Fn fcntl
function provides for control over descriptors.
system call provides for control over descriptors.
The argument
.Fa fd
is a descriptor to be operated on by
.Fa cmd
as described below. Depending on the value of
.Fa cmd ,
.Nm
.Fn fcntl
can take an additional third argument
.Fa "int arg" .
.Bl -tag -width F_GETOWNX
@ -145,7 +145,7 @@ flags are as follows:
.It Dv O_NONBLOCK
Non-blocking I/O; if no data is available to a
.Xr read 2
call, or if a
system call, or if a
.Xr write 2
operation would block,
the read or write call returns -1 with the error
@ -195,7 +195,7 @@ in the
.Fa flock
structure.
If no lock is found that would prevent this lock from being created,
the structure is left unchanged by this function call except for the
the structure is left unchanged by this system call except for the
lock type which is set to
.Dv F_UNLCK .
.It Dv F_SETLK
@ -331,7 +331,7 @@ requested a lock on the database.
Another minor semantic problem with this interface is that
locks are not inherited by a child process created using the
.Xr fork 2
function.
system call.
The
.Xr flock 2
interface has much more rational last close semantics and
@ -390,7 +390,7 @@ is set to indicate the error.
.Sh ERRORS
The
.Fn fcntl
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
The argument
@ -450,7 +450,7 @@ The argument
.Fa cmd
is
.Dv F_SETLKW ,
and the function was interrupted by a signal.
and the system call was interrupted by a signal.
.It Bq Er EINVAL
.Fa Cmd
is
@ -554,5 +554,5 @@ for the reasons as stated in
.Sh HISTORY
The
.Fn fcntl
function call appeared in
system call appeared in
.Bx 4.2 .

18
lib/libc/sys/fhopen.2
View File

@ -1,5 +1,4 @@
.\" $NetBSD: fhopen.2,v 1.1 1999/06/30 01:32:15 wrstuden Exp $
.\" $FreeBSD$
.\"
.\" Copyright (c) 1999 National Aeronautics & Space Administration
.\" All rights reserved.
@ -31,7 +30,9 @@
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"/
.\"
.\" $FreeBSD$
.\"
.Dd June 29, 1999
.Dt FHOPEN 2
.Os
@ -53,12 +54,14 @@
.Ft int
.Fn fhstatfs "const fhandle_t *fhp" "struct statfs *buf"
.Sh DESCRIPTION
These functions provide a means to access a file given the file handle
These system calls provide a means to access a file given the file handle
.Fa fhp .
As this method bypasses directory access restrictions, these calls are
restricted to the superuser.
.Pp
The
.Fn fhopen
system call
opens the file referenced by
.Fa fhp
for reading and/or writing as specified by the argument
@ -70,13 +73,15 @@ are specified by
.Em or Ns 'ing
together the flags used for the
.Xr open 2
call.
system call.
All said flags are valid except for
.Dv O_CREAT .
.Pp
The
.Fn fhstat
and
.Fn fhstatfs
system calls
provide the functionality of the
.Xr fstat 2
and
@ -128,11 +133,12 @@ The
.Fn fhstat ,
and
.Fn fhstatfs
functions first appeared in
system calls first appeared in
.Nx 1.5
and were adapted to
.Fx 4.0
by Alfred Perlstein.
by
.An Alfred Perlstein .
.Sh AUTHORS
This man page was written by
.An William Studenmund

6
lib/libc/sys/flock.2
View File

@ -51,7 +51,7 @@
.Sh DESCRIPTION
The
.Fn flock
function applies or removes an
system call applies or removes an
.Em advisory
lock on the file associated with the file descriptor
.Fa fd .
@ -118,7 +118,7 @@ Processes blocked awaiting a lock may be awakened by signals.
.Sh ERRORS
The
.Fn flock
call fails if:
system call fails if:
.Bl -tag -width Er
.It Bq Er EWOULDBLOCK
The file is locked and the
@ -146,5 +146,5 @@ refers to an object that does not support file locking.
.Sh HISTORY
The
.Fn flock
function call appeared in
system call appeared in
.Bx 4.2 .

8
lib/libc/sys/fork.2
View File

@ -48,7 +48,7 @@
.Sh DESCRIPTION
The
.Fn fork
function causes creation of a new process.
system call causes creation of a new process.
The new process (child process) is an exact copy of the
calling process (parent process) except for the following:
.Bl -bullet -offset indent
@ -92,7 +92,7 @@ is set to indicate the error.
.Sh ERRORS
The
.Fn fork
function will fail and no child process will be created if:
system call will fail and no child process will be created if:
.Bl -tag -width Er
.It Bq Er EAGAIN
The system-imposed limit on the total
@ -129,7 +129,7 @@ There is insufficient swap space for the new process.
.Xr vfork 2 ,
.Xr wait 2
.Sh HISTORY
A
The
.Fn fork
function call appeared in
function appeared in
.At v6 .

10
lib/libc/sys/fsync.2
View File

@ -45,14 +45,18 @@
.Ft int
.Fn fsync "int fd"
.Sh DESCRIPTION
.Fn Fsync
The
.Fn fsync
system call
causes all modified data and attributes of
.Fa fd
to be moved to a permanent storage device.
This normally results in all in-core modified copies
of buffers for the associated file to be written to a disk.
.Pp
.Fn Fsync
The
.Fn fsync
system call
should be used by programs that require a file to be
in a known state, for example, in building a simple transaction
facility.
@ -79,5 +83,5 @@ An I/O error occurred while reading from or writing to the file system.
.Sh HISTORY
The
.Fn fsync
function call appeared in
system call appeared in
.Bx 4.2 .

16
lib/libc/sys/getdirentries.2
View File

@ -53,7 +53,7 @@ The
.Fn getdirentries
and
.Fn getdents
functions read directory entries from the directory
system calls read directory entries from the directory
referenced by the file descriptor
.Fa fd
into the buffer pointed to by
@ -68,7 +68,7 @@ argument must be greater than or equal to the
block size associated with the file,
see
.Xr stat 2 .
Some file systems may not support these functions
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
@ -130,7 +130,7 @@ the end of the directory has been reached.
.Pp
The
.Fn getdirentries
function writes the position of the block read into the location pointed to by
system call writes the position of the block read into the location pointed to by
.Fa basep .
Alternatively, the current position pointer may be set and retrieved by
.Xr lseek 2 .
@ -138,7 +138,7 @@ The current position pointer should only be set to a value returned by
.Xr lseek 2 ,
a value returned in the location pointed to by
.Fa basep
.Pf ( Fn getdirentries
.Fn ( getdirentries
only)
or zero.
.Sh RETURN VALUES
@ -147,7 +147,9 @@ Otherwise, -1 is returned and the global variable
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn Getdirentries
The
.Fn getdirentries
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EBADF
@ -177,9 +179,9 @@ error occurred while reading from or writing to the file system.
.Sh HISTORY
The
.Fn getdirentries
function first appeared in
system call first appeared in
.Bx 4.4 .
The
.Fn getdents
function first appeared in
system call first appeared in
.Fx 3.0 .

6
lib/libc/sys/getdtablesize.2
View File

@ -48,9 +48,9 @@
Each process has a fixed size descriptor table,
which is guaranteed to have at least 20 slots. The entries in
the descriptor table are numbered with small integers starting at 0.
The call
The
.Fn getdtablesize
returns the size of this table.
system call returns the size of this table.
.Sh SEE ALSO
.Xr close 2 ,
.Xr dup 2 ,
@ -59,5 +59,5 @@ returns the size of this table.
.Sh HISTORY
The
.Fn getdtablesize
function call appeared in
system call appeared in
.Bx 4.2 .

11
lib/libc/sys/getfh.2
View File

@ -46,7 +46,9 @@
.Ft int
.Fn getfh "const char *path" "fhandle_t *fhp"
.Sh DESCRIPTION
.Fn Getfh
The
.Fn getfh
system call
returns a file handle for the specified file or directory
in the file handle pointed to by
.Fa fhp .
@ -54,7 +56,9 @@ This system call is restricted to the superuser.
.Sh RETURN VALUES
.Rv -std getfh
.Sh ERRORS
.Fn Getfh
The
.Fn getfh
system call
fails if one or more of the following are true:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -89,6 +93,5 @@ error occurred while reading from or writing to the file system.
.Sh HISTORY
The
.Fn getfh
function
first appeared in
system call first appeared in
.Bx 4.4 .

10
lib/libc/sys/getfsstat.2
View File

@ -47,7 +47,9 @@
.Ft int
.Fn getfsstat "struct statfs *buf" "long bufsize" "int flags"
.Sh DESCRIPTION
.Fn Getfsstat
The
.Fn getfsstat
system call
returns information about all mounted file systems.
.Fa Buf
is a pointer to
@ -152,7 +154,9 @@ Otherwise, -1 is returned and the global variable
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn Getfsstat
The
.Fn getfsstat
system call
fails if one or more of the following are true:
.Bl -tag -width Er
.It Bq Er EFAULT
@ -170,5 +174,5 @@ error occurred while reading from or writing to the file system.
.Sh HISTORY
The
.Fn getfsstat
function first appeared in
system call first appeared in
.Bx 4.4 .

6
lib/libc/sys/getgid.2
View File

@ -51,7 +51,7 @@
.Sh DESCRIPTION
The
.Fn getgid
function returns the real group ID of the calling process,
system call returns the real group ID of the calling process,
.Fn getegid
returns the effective group ID of the calling process.
.Pp
@ -69,7 +69,7 @@ The
.Fn getgid
and
.Fn getegid
functions are always successful, and no return value is reserved to
system calls are always successful, and no return value is reserved to
indicate an error.
.Sh SEE ALSO
.Xr getuid 2 ,
@ -81,5 +81,5 @@ The
.Fn getgid
and
.Fn getegid
function calls are expected to conform to
system calls are expected to conform to
.St -p1003.1-90 .

10
lib/libc/sys/getgroups.2
View File

@ -46,7 +46,9 @@
.Ft int
.Fn getgroups "int gidsetlen" "gid_t *gidset"
.Sh DESCRIPTION
.Fn Getgroups
The
.Fn getgroups
system call
gets the current group access list of the user process
and stores it in the array
.Fa gidset .
@ -54,7 +56,9 @@ The parameter
.Fa gidsetlen
indicates the number of entries that may be placed in
.Fa gidset .
.Fn Getgroups
The
.Fn getgroups
system call
returns the actual number of groups returned in
.Fa gidset .
No more than
@ -94,5 +98,5 @@ an invalid address.
.Sh HISTORY
The
.Fn getgroups
function call appeared in
system call appeared in
.Bx 4.2 .

10
lib/libc/sys/getitimer.2
View File

@ -56,13 +56,13 @@ defined in
.Ao Pa sys/time.h Ac .
The
.Fn getitimer
call returns the current value for the timer specified in
system call returns the current value for the timer specified in
.Fa which
in the structure at
.Fa value .
The
.Fn setitimer
call sets a timer to the specified
system call sets a timer to the specified
.Fa value
(returning the previous value of the timer if
.Fa ovalue
@ -149,9 +149,11 @@ compares two time values.
.Sh RETURN VALUES
.Rv -std
.Sh ERRORS
.Fn Getitimer
The
.Fn getitimer
and
.Fn setitimer
system calls
will fail if:
.Bl -tag -width Er
.It Bq Er EFAULT
@ -172,5 +174,5 @@ to be handled.
.Sh HISTORY
The
.Fn getitimer
function call appeared in
system call appeared in
.Bx 4.2 .

20
lib/libc/sys/getlogin.2
View File

@ -66,7 +66,9 @@ for example when
.Xr su 1
is used).
.Pp
The
.Fn getlogin_r
function
provides the same service as
.Fn getlogin
except the caller must provide the buffer
@ -78,10 +80,12 @@ to hold the result. The buffer should be at least
.Dv MAXLOGNAME
bytes in length.
.Pp
The
.Fn setlogin
system call
sets the login name of the user associated with the current session to
.Fa name .
This call is restricted to the super-user, and
This system call is restricted to the super-user, and
is normally used only when a new session is being created on behalf
of the named user
(for example, at login time, or when a remote shell is invoked).
@ -100,8 +104,8 @@ Making a
system call is the
.Em ONLY
way to do this. The
.Fn daemon
library call calls
.Xr daemon 3
function calls
.Fn setsid
which is an ideal way of detaching from a controlling terminal and
forking into the background.
@ -116,7 +120,7 @@ sufficient.
.Pp
Once a parent process does a
.Fn setsid
call, it is acceptable for some child of that process to then do a
system call, it is acceptable for some child of that process to then do a
.Fn setlogin
even though it is not the session leader, but beware that ALL processes
in the session will change their login name at the same time, even the
@ -136,7 +140,9 @@ succeeds, it returns a pointer to a null-terminated string in a static buffer,
or
.Dv NULL
if the name has not been set.
The
.Fn getlogin_r
function
returns zero if successful, or the error number upon failure.
.Pp
.Rv -std setlogin
@ -180,7 +186,7 @@ Portable programs should probably still make this check.
.Sh HISTORY
The
.Fn getlogin
function first appeared in
system call first appeared in
.Bx 4.4 .
The return value of
.Fn getlogin_r
@ -189,8 +195,12 @@ was changed from earlier versions of
to be conformant with
.St -p1003.1-96 .
.Sh STANDARDS
The
.Fn getlogin
system call
and
the
.Fn getlogin_r
function
conform to
.St -p1003.1-96 .

6
lib/libc/sys/getpeername.2
View File

@ -46,7 +46,9 @@
.Ft int
.Fn getpeername "int s" "struct sockaddr *name" "socklen_t *namelen"
.Sh DESCRIPTION
.Fn Getpeername
The
.Fn getpeername
system call
returns the name of the peer connected to
socket
.Fa s .
@ -92,5 +94,5 @@ process address space.
.Sh HISTORY
The
.Fn getpeername
function call appeared in
system call appeared in
.Bx 4.2 .

19
lib/libc/sys/getpgrp.2
View File

@ -65,7 +65,7 @@ that have the same process group as the terminal are foreground
and may read, while others will block with a signal if they attempt
to read.
.Pp
This call is thus used by programs such as
This system call is thus used by programs such as
.Xr csh 1
to create
process groups
@ -79,15 +79,17 @@ are used to get/set the process group of the control terminal.
.Sh RETURN VALUES
The
.Fn getpgrp
call always succeeds.
system call always succeeds.
Upon successful completion, the
.Fn getpgid
call returns the process group of the specified process;
system call returns the process group of the specified process;
otherwise, it returns a value of \-1 and sets
.Va errno
to indicate the error.
.Sh ERRORS
The
.Fn getpgid
system call
will succeed unless:
.Bl -tag -width Er
.It Bq Er ESRCH
@ -101,15 +103,16 @@ there is no process whose process ID equals
.Sh HISTORY
The
.Fn getpgrp
function call appeared in
system call appeared in
.Bx 4.0 .
The
.Fn getpgid
function call is derived from its usage in System V Release 4.
system call is derived from its usage in
.At V.4 .
.Sh STANDARDS
The
.Fn getpgrp
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
.Sh COMPATIBILITY
This version of
@ -127,7 +130,7 @@ Rationale:
.Bx 4.3
provides a
.Fn getpgrp
function that returns the process group ID for a specified process.
system call that returns the process group ID for a specified process.
Although this function is used to support job control, all known
job-control shells always specify the calling process with this
function.
@ -140,4 +143,4 @@ suffices, and the added complexity of the
has been omitted from POSIX.1.
The old functionality is available from the
.Fn getpgid
function.
system call.

16
lib/libc/sys/getpid.2
View File

@ -49,7 +49,9 @@
.Ft pid_t
.Fn getppid void
.Sh DESCRIPTION
.Fn Getpid
The
.Fn getpid
system call
returns
the process ID of
the calling process.
@ -60,7 +62,9 @@ security reasons; see
.Xr mkstemp 3
instead.
.Pp
.Fn Getppid
The
.Fn getppid
system call
returns the process ID of the parent
of the calling process.
.Sh ERRORS
@ -68,7 +72,7 @@ The
.Fn getpid
and
.Fn getppid
functions are always successful, and no return value is reserved to
system calls are always successful, and no return value is reserved to
indicate an error.
.Sh SEE ALSO
.Xr gethostid 3
@ -77,10 +81,10 @@ The
.Fn getpid
and
.Fn getppid
function calls are expected to conform to
system calls are expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
The
.Fn getpid
function call appeared in
function appeared in
.At v7 .

14
lib/libc/sys/getpriority.2
View File

@ -56,9 +56,9 @@ and
.Fa who
is obtained with the
.Fn getpriority
call and set with the
system call and set with the
.Fn setpriority
call.
system call.
.Fa Which
is one of
.Dv PRIO_PROCESS ,
@ -85,10 +85,10 @@ lower priorities cause more favorable scheduling.
.Pp
The
.Fn getpriority
call returns the highest priority (lowest numerical value)
system call returns the highest priority (lowest numerical value)
enjoyed by any of the specified processes. The
.Fn setpriority
call sets the priorities of all of the specified processes
system call sets the priorities of all of the specified processes
to the specified value. Only the super-user may lower priorities.
.Sh RETURN VALUES
Since
@ -102,9 +102,11 @@ if a -1 is an error or a legitimate value.
.Pp
.Rv -std setpriority
.Sh ERRORS
.Fn Getpriority
The
.Fn getpriority
and
.Fn setpriority
system calls
will fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
@ -139,5 +141,5 @@ A non super-user attempted to lower a process priority.
.Sh HISTORY
The
.Fn getpriority
function call appeared in
system call appeared in
.Bx 4.2 .

16
lib/libc/sys/getrlimit.2
View File

@ -53,9 +53,9 @@
Limits on the consumption of system resources by the current process
and each process it creates may be obtained with the
.Fn getrlimit
call, and set with the
system call, and set with the
.Fn setrlimit
call.
system call.
.Pp
The
.Fa resource
@ -72,14 +72,14 @@ each process.
The maximum size (in bytes) of the data segment for a process;
this defines how far a program may extend its break with the
.Xr sbrk 2
system call.
function.
.It Li RLIMIT_FSIZE
The largest size (in bytes) file that may be created.
.It Li RLIMIT_MEMLOCK
The maximum size (in bytes) which a process may lock into memory
using the
.Xr mlock 2
function.
system call.
.It Li RLIMIT_NOFILE
The maximum number of open files for this process.
.It Li RLIMIT_NPROC
@ -137,7 +137,7 @@ is thus a built-in command to
The system refuses to extend the data or stack space when the limits
would be exceeded in the normal way: a
.Xr brk 2
call fails if the data space limit is reached.
function fails if the data space limit is reached.
When the stack limit is reached, the process receives
a segmentation fault
.Pq Dv SIGSEGV ;
@ -157,9 +157,11 @@ offending process.
.Sh RETURN VALUES
.Rv -std
.Sh ERRORS
.Fn Getrlimit
The
.Fn getrlimit
and
.Fn setrlimit
system calls
will fail if:
.Bl -tag -width Er
.It Bq Er EFAULT
@ -183,5 +185,5 @@ raised the maximum limit value, and the caller is not the super-user.
.Sh HISTORY
The
.Fn getrlimit
function call appeared in
system call appeared in
.Bx 4.2 .

8
lib/libc/sys/getrusage.2
View File

@ -49,7 +49,9 @@
.Ft int
.Fn getrusage "int who" "struct rusage *rusage"
.Sh DESCRIPTION
.Fn Getrusage
The
.Fn getrusage
system call
returns information describing the resources utilized by the current
process, or all its terminated child processes.
The
@ -156,7 +158,7 @@ to the first process to read or write the data.
.Sh ERRORS
The
.Fn getrusage
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The
@ -177,5 +179,5 @@ that has not yet terminated.
.Sh HISTORY
The
.Fn getrusage
function call appeared in
system call appeared in
.Bx 4.2 .

11
lib/libc/sys/getsid.2
View File

@ -46,13 +46,16 @@ is zero,
.Fn getsid
returns the session ID of the current process.
.Sh RETURN VALUES
Upon successful completion, the function
Upon successful completion, the
.Fn getsid
system call
returns the session ID of
the specified process; otherwise, it returns a value of -1 and
sets errno to indicate an error.
.Sh ERRORS
The
.Fn getsid
system call
will succeed unless:
.Bl -tag -width Er
.It Bq Er ESRCH
@ -60,7 +63,7 @@ if there is no process with a process ID equal to
.Fa pid .
.El
.Pp
Note that an implementation may restrict this function call to
Note that an implementation may restrict this system call to
processes within the same session ID as the calling process.
.Sh SEE ALSO
.Xr getpgid 2 ,
@ -71,9 +74,9 @@ processes within the same session ID as the calling process.
.Sh HISTORY
The
.Fn getsid
function call appeared in
system call appeared in
.Fx 3.0 .
The
.Fn getsid
function call is derived from its usage in
system call is derived from its usage in
.At V .

6
lib/libc/sys/getsockname.2
View File

@ -46,7 +46,9 @@
.Ft int
.Fn getsockname "int s" "struct sockaddr *name" "socklen_t *namelen"
.Sh DESCRIPTION
.Fn Getsockname
The
.Fn getsockname
system call
returns the current
.Fa name
for the specified socket. The
@ -91,5 +93,5 @@ returns a zero length name.
.Sh HISTORY
The
.Fn getsockname
function call appeared in
system call appeared in
.Bx 4.2 .

10
lib/libc/sys/getsockopt.2
View File

@ -49,9 +49,11 @@
.Ft int
.Fn setsockopt "int s" "int level" "int optname" "const void *optval" "socklen_t optlen"
.Sh DESCRIPTION
.Fn Getsockopt
The
.Fn getsockopt
and
.Fn setsockopt
system calls
manipulate the
.Em options
associated with a socket. Options may exist at multiple
@ -164,7 +166,7 @@ enables debugging in the underlying protocol modules.
indicates that the rules used in validating addresses supplied
in a
.Xr bind 2
call should allow reuse of local addresses.
system call should allow reuse of local addresses.
.Dv SO_REUSEPORT
allows completely duplicate bindings by multiple processes
if they all set
@ -199,7 +201,7 @@ attempt until it is able to transmit the data or until it decides it
is unable to deliver the information (a timeout period, termed the
linger interval, is specified in seconds in the
.Fn setsockopt
call when
system call when
.Dv SO_LINGER
is requested).
If
@ -315,7 +317,7 @@ must be called on the socket before
trying to install the filter on it,
or else the
.Fn setsockopt
call will fail.
system call will fail.
.Bd -literal
struct accept_filter_arg {
char af_name[16];

6
lib/libc/sys/gettimeofday.2
View File

@ -56,9 +56,9 @@ the kernel.
The system's notion of the current Greenwich time and the current time
zone is obtained with the
.Fn gettimeofday
call, and set with the
system call, and set with the
.Fn settimeofday
call. The time is expressed in seconds and microseconds
system call. The time is expressed in seconds and microseconds
since midnight (0 hour), January 1, 1970. The resolution of the system
clock is hardware dependent, and the time may be updated continuously or
in
@ -128,5 +128,5 @@ A user other than the super-user attempted to set the time.
.Sh HISTORY
The
.Fn gettimeofday
function call appeared in
system call appeared in
.Bx 4.2 .

14
lib/libc/sys/getuid.2
View File

@ -51,10 +51,10 @@
.Sh DESCRIPTION
The
.Fn getuid
function returns the real user ID of the calling process.
system call returns the real user ID of the calling process.
The
.Fn geteuid
function
system call
returns the effective user ID of the calling process.
.Pp
The real user ID is that of the user who has invoked the program.
@ -70,7 +70,7 @@ The
.Fn getuid
and
.Fn geteuid
functions are always successful, and no return value is reserved to
system calls are always successful, and no return value is reserved to
indicate an error.
.Sh SEE ALSO
.Xr getgid 2 ,
@ -83,12 +83,12 @@ The
.Fn geteuid
and
.Fn getuid
function calls are expected to conform to
system calls are expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
The
.Fn getuid
and a
and
.Fn geteuid
function call appeared in
functions appeared in
.At v7 .

17
lib/libc/sys/intro.2
View File

@ -102,7 +102,7 @@ pathname was an empty string.
.It Er 3 ESRCH Em "No such process" .
No process could be found corresponding to that specified by the given
process ID.
.It Er 4 EINTR Em "Interrupted function call" .
.It Er 4 EINTR Em "Interrupted system call" .
An asynchronous signal (such as
.Dv SIGINT
or
@ -110,7 +110,7 @@ or
was caught by the process during the execution of an interruptible
function.
If the signal handler performs a normal return, the
interrupted function call will seem to have returned the error condition.
interrupted system call will seem to have returned the error condition.
.It Er 5 EIO Em "Input/output error" .
Some physical input or output error occurred.
This error will not be reported until a subsequent operation on the same file
@ -126,7 +126,7 @@ loaded on a drive.
The number of bytes used for the argument and environment
list of the new process exceeded the current limit
of 65536 bytes
.Pf ( Dv NCARGS
.Dv ( NCARGS
in
.Aq Pa sys/param.h ) .
.It Er 8 ENOEXEC Em "Exec format error" .
@ -170,7 +170,7 @@ in a manner which would have conflicted with the request.
An existing file was mentioned in an inappropriate context,
for instance, as the new link name in a
.Xr link 2
function.
system call.
.It Er 18 EXDEV Em "Improper link" .
A hard link to a file on another file system
was attempted.
@ -189,9 +189,10 @@ Some invalid argument was supplied.
(For example,
specifying an undefined signal to a
.Xr signal 3
or
function
or a
.Xr kill 2
function).
system call).
.It Er 23 ENFILE Em "Too many open files in system" .
Maximum number of file descriptors allowable on the system
has been reached and a requests for an open cannot be satisfied
@ -201,7 +202,7 @@ until at least one has been closed.
open files per process is 64.>
The
.Xr getdtablesize 2
function will obtain the current limit.
system call will obtain the current limit.
.It Er 25 ENOTTY Em "Inappropriate ioctl for device" .
A control function (see
.Xr ioctl 2 )
@ -230,7 +231,7 @@ on the file system.
.It Er 29 ESPIPE Em "Illegal seek" .
An
.Xr lseek 2
function was issued on a socket, pipe or
system call was issued on a socket, pipe or
.Tn FIFO .
.It Er 30 EROFS Em "Read-only file system" .
An attempt was made to modify a file or directory

12
lib/libc/sys/ioctl.2
View File

@ -48,7 +48,7 @@
.Sh DESCRIPTION
The
.Fn ioctl
function manipulates the underlying device parameters of special files.
system call manipulates the underlying device parameters of special files.
In particular, many operating
characteristics of character special files (e.g. terminals)
may be controlled with
@ -59,11 +59,11 @@ The argument
must be an open file descriptor.
.Pp
The third argument to
.Nm
.Fn ioctl
is traditionally named
.Ar "char *argp" .
Most uses of
.Nm
.Fn ioctl
in
.Fx 3.0
however, require the third argument to be a
@ -91,7 +91,9 @@ If an error has occurred, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
The
.Fn ioctl
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EBADF
@ -121,7 +123,7 @@ points outside the process's allocated address space.
.Xr intro 4 ,
.Xr tty 4
.Sh HISTORY
An
The
.Fn ioctl
function call appeared in
function appeared in
.At v7 .

8
lib/libc/sys/issetugid.2
View File

@ -48,7 +48,7 @@
.Sh DESCRIPTION
The
.Fn issetugid
function returns 1 if the process environment or memory address space
system call returns 1 if the process environment or memory address space
is considered
.Dq tainted ,
and returns 0 otherwise.
@ -81,7 +81,7 @@ which begin setuid but need to be able to create an untainted process.
.Sh ERRORS
The
.Fn issetugid
function is always successful, and no return value is reserved to
system call is always successful, and no return value is reserved to
indicate an error.
.Sh SEE ALSO
.Xr execve 2 ,
@ -93,9 +93,9 @@ indicate an error.
.Xr setreuid 2 ,
.Xr setuid 2
.Sh HISTORY
A
The
.Fn issetugid
function call first appeared in
system call first appeared in
.Ox 2.0
and was also implemented in
.Fx 3.0 .

6
lib/libc/sys/jail.2
View File

@ -23,7 +23,7 @@
.Fn jail "struct jail *jail"
.Sh DESCRIPTION
The
.Nm
.Fn jail
system call sets up a jail and locks the current process in it.
.Pp
The argument is a pointer to a structure describing the prison:
@ -75,7 +75,9 @@ it will show a field near the end of the line, either as
a single hyphen for a process at large, or the hostname currently
set for the prison for jailed processes.
.Sh ERRORS
The
.Fn jail
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
@ -96,7 +98,7 @@ manual page for details.
.Sh HISTORY
The
.Fn jail
function call appeared in
system call appeared in
.Fx 4.0 .
.Sh AUTHORS
The jail feature was written by

6
lib/libc/sys/kenv.2
View File

@ -41,7 +41,7 @@
.Sh DESCRIPTION
The
.Fn kenv
function manipulates kernel environment variables.
system call manipulates kernel environment variables.
It supports the well known userland actions of getting, setting and unsetting
environment variables, as well as the ability to dump all of the entries in
the kernel environment.
@ -119,7 +119,7 @@ points to.
.Sh RETURN VALUES
The
.Fn kenv
function returns 0 if successful in the case of
system call returns 0 if successful in the case of
.Dv KENV_SET
and
.Dv KENV_UNSET ,
@ -134,7 +134,9 @@ the global variable
.Va errno
is set to indicate the error.
.Sh ERRORS
The
.Fn kenv
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL

12
lib/libc/sys/kill.2
View File

@ -48,7 +48,7 @@
.Sh DESCRIPTION
The
.Fn kill
function sends the signal given by
system call sends the signal given by
.Fa sig
to
.Fa pid ,
@ -108,7 +108,9 @@ This is a variant of
.Sh RETURN VALUES
.Rv -std kill
.Sh ERRORS
.Fn Kill
The
.Fn kill
system call
will fail and no signal will be sent if:
.Bl -tag -width Er
.It Bq Er EINVAL
@ -136,10 +138,10 @@ of the group could not be signaled.
.Sh STANDARDS
The
.Fn kill
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
The
.Fn kill
function call appeared in
function appeared in
.At v7 .

5
lib/libc/sys/kldfind.2
View File

@ -39,12 +39,15 @@
.Ft int
.Fn kldfind "const char *file"
.Sh DESCRIPTION
The function
The
.Fn kldfind
system call
returns the fileid of the kld file referenced by
.Fa file .
.Sh RETURN VALUES
The
.Fn kldfind
system call
returns the fileid of the kld file referenced by
.Fa file .
Upon error,

2
lib/libc/sys/kldfirstmod.2
View File

@ -41,7 +41,7 @@
.Sh DESCRIPTION
The
.Fn kldfirstmod
function returns the module id pertaining to the first module referenced by
system call returns the module id pertaining to the first module referenced by
.Fa fileid .
.Sh RETURN VALUES
The

8
lib/libc/sys/kldload.2
View File

@ -39,12 +39,14 @@
.Ft int
.Fn kldload "const char *file"
.Sh DESCRIPTION
The function
The
.Fn kldload
system call
loads a kld file into the kernel using the kernel linker.
.Sh RETURN VALUES
The function
The
.Fn kldload
system call
returns the fileid of the kld file which was loaded into the kernel.
If an error occurs,
.Fn kldload
@ -58,7 +60,7 @@ The named file is loaded unless:
You do not have access to read the file or link it with the kernel.
You should be the root user to be able to use the
.Nm kld
functions.
system calls.
.It Bq Er EFAULT
Bad address encountered when adding kld info into the kernel space.
.It Bq Er ENOMEM

5
lib/libc/sys/kldnext.2
View File

@ -39,15 +39,18 @@
.Ft int
.Fn kldnext "int fileid"
.Sh DESCRIPTION
The function
The
.Fn kldnext
system call
returns the fileid of the next kld file (that is, the one after
.Va fileid )
or 0 if
.Va fileid
is the last file loaded.
.Sh RETURN VALUES
The
.Fn kldnext
system call
returns the fileid of the next kld file (see DESCRIPTION) or 0. If an error
occurs,
.Va errno

4
lib/libc/sys/kldstat.2
View File

@ -41,7 +41,7 @@
.Sh DESCRIPTION
The
.Fn kldstat
function writes the info for the file referred to by
system call writes the info for the file referred to by
.Fa fileid
into
.Fa stat .
@ -101,7 +101,7 @@ field.
There was a problem copying one, some, or all of the fields into
.Fa stat
in the
.Fn copyout
.Xr copyout 9
function.
.El
.Sh SEE ALSO

6
lib/libc/sys/kldsym.2
View File

@ -40,7 +40,7 @@
.Sh DESCRIPTION
The
.Fn kldsym
function returns the address of the symbol specified in
system call returns the address of the symbol specified in
.Fa data
in the module specified by
.Fa fileid .
@ -91,7 +91,7 @@ and the size of the data it points to, respectively.
.Sh ERRORS
The
.Fn kldsym
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value in
@ -116,5 +116,5 @@ or the specified symbol could not be found.
.Sh HISTORY
The
.Fn kldsym
function first appeared in
system call first appeared in
.Fx 3.0 .

3
lib/libc/sys/kldunload.2
View File

@ -39,8 +39,9 @@
.Ft int
.Fn kldunload "int fileid"
.Sh DESCRIPTION
The function
The
.Fn kldunload
system call
unloads a kld file from the kernel that was previously linked via
.Xr kldload 2 .
.Sh RETURN VALUES

29
lib/libc/sys/kqueue.2
View File

@ -43,7 +43,9 @@
.Fn kevent "int kq" "const struct kevent *changelist" "int nchanges" "struct kevent *eventlist" "int nevents" "const struct timespec *timeout"
.Fn EV_SET "&kev" ident filter flags fflags data udata
.Sh DESCRIPTION
The
.Fn kqueue
system call
provides a generic method of notifying the user when an event
happens or a condition holds, based on the results of small
pieces of kernel code termed filters.
@ -69,7 +71,9 @@ Calling
.Fn close
on a file descriptor will remove any kevents that reference the descriptor.
.Pp
The
.Fn kqueue
system call
creates a new kernel event queue and returns a descriptor.
The queue is not inherited by a child created with
.Xr fork 2 .
@ -80,7 +84,9 @@ is called without the
flag, then the descriptor table is shared,
which will allow sharing of the kqueue between two processes.
.Pp
The
.Fn kevent
system call
is used to register events with the queue, and return any pending
events to the user.
.Fa changelist
@ -115,8 +121,9 @@ structure. The same array may be used for the
and
.Fa eventlist .
.Pp
The
.Fn EV_SET
is a macro which is provided for ease of initializing a
macro is provided for ease of initializing a
kevent structure.
.Pp
The
@ -272,12 +279,16 @@ be attached to,
containing the udata value, and
.Va sigev_notify
set to SIGEV_KEVENT.
When the aio_* function is called, the event will be registered
When the
.Fn aio_*
system call is made, the event will be registered
with the specified kqueue, and the
.Va ident
argument set to the
.Fa struct aiocb
returned by the aio_* function.
returned by the
.Fn aio_*
system call.
The filter returns under the same conditions as aio_error.
.Pp
Alternatively, a kevent structure may be initialized, with
@ -294,7 +305,9 @@ and returns when one or more of the requested events occurs on the descriptor.
The events to monitor are:
.Bl -tag -width XXNOTE_RENAME
.It NOTE_DELETE
The
.Fn unlink
system call
was called on the file referenced by the descriptor.
.It NOTE_WRITE
A write occurred on the file referenced by the descriptor.
@ -378,12 +391,16 @@ contains the number of times the timeout has expired since the last call to
This filter automatically sets the EV_CLEAR flag internally.
.El
.Sh RETURN VALUES
The
.Fn kqueue
system call
creates a new kernel event queue and returns a file descriptor.
If there was an error creating the kernel event queue, a value of -1 is
returned and errno set.
.Pp
The
.Fn kevent
system call
returns the number of events placed in the
.Fa eventlist ,
up to the value given by
@ -411,7 +428,7 @@ returns 0.
.Sh ERRORS
The
.Fn kqueue
function fails if:
system call fails if:
.Bl -tag -width Er
.It Bq Er ENOMEM
The kernel failed to allocate enough memory for the kernel queue.
@ -423,7 +440,7 @@ The system file table is full.
.Pp
The
.Fn kevent
function fails if:
system call fails if:
.Bl -tag -width Er
.It Bq Er EACCES
The process does not have permission to register a filter.
@ -460,7 +477,7 @@ The
.Fn kqueue
and
.Fn kevent
functions first appeared in
system calls first appeared in
.Fx 4.1 .
.Sh AUTHORS
The

36
lib/libc/sys/kse.2
View File

@ -57,7 +57,7 @@
.Ft int
.Fn kse_thr_interrupt "struct kse_thr_mailbox *tmbx"
.Sh DESCRIPTION
These functions implement kernel support for multi-threaded processes.
These system calls implement kernel support for multi-threaded processes.
.\"
.Ss Overview
.\"
@ -210,7 +210,9 @@ received).
.\"
To become multi-threaded, a process must first invoke
.Fn kse_create .
The
.Fn kse_create
system call
creates a new KSE (except for the very first invocation; see below).
The KSE will be associated with the mailbox pointed to by
.Fa mbx .
@ -248,20 +250,24 @@ There may however be arbitrarily many user threads, and it is up to the
user thread scheduler to handle mapping the application's user threads
onto the available KSEs.
.Pp
The
.Fn kse_exit
system call
causes the KSE assigned to the currently running thread to be destroyed.
If this KSE is the last one in the KSE group, there must be no remaining
threads associated with the KSE group blocked in the kernel.
This function does not return.
This system call does not return.
.Pp
As a special case, if the last remaining KSE in the last remaining KSE group
invokes this function, then the KSE is not destroyed;
invokes this system call, then the KSE is not destroyed;
instead, the KSE just looses the association with its mailbox and
.Fn kse_exit
returns normally.
This returns the process to its original, unthreaded state.
.Pp
The
.Fn kse_release
system call
is used to
.Dq park
the KSE assigned to the currently running thread when it is not needed,
@ -272,13 +278,15 @@ If successful,
.Fn kse_release
does not return.
.Pp
The
.Fn kse_wakeup
system call
is the opposite of
.Fn kse_release .
It causes the KSE associated with the mailbox pointed to by
.Fa mbx
to be woken up, causing it to upcall.
If the KSE has already woken up for another reason, this function has no
If the KSE has already woken up for another reason, this system call has no
effect.
The
.Fa mbx
@ -287,7 +295,9 @@ may be
to specify
.Dq "any KSE in the current KSE group" .
.Pp
The
.Fn kse_thr_interrupt
system call
is used to interrupt a currently blocked thread.
The thread must either be blocked in the kernel or assigned to a KSE
(i.e., executing).
@ -488,22 +498,28 @@ may contain any of the following bits OR'ed together:
(No flags are defined yet.)
.El
.Sh RETURN VALUES
The
.Fn kse_create , kse_wakeup ,
and
.Fn kse_thr_interrupt
system calls
return zero if successful.
The
.Fn kse_exit
and
.Fn kse_release
system calls
do not return if successful.
.Pp
All of these functions return a non-zero error code in case of an error.
All of these system calls return a non-zero error code in case of an error.
.Pp
.Em Note :
error codes are returned directly rather than via
.Va errno .
.Sh ERRORS
The
.Fn kse_create
system call
will fail if:
.Bl -tag -width Er
.It Bq Er ENXIO
@ -535,7 +551,9 @@ would be exceeded (see
points to an address which is not a valid part of the process address space.
.El
.Pp
The
.Fn kse_exit
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EDEADLK
@ -548,7 +566,9 @@ in traditional, unthreaded mode (in this case use
to exit the process).
.El
.Pp
The
.Fn kse_release
system call
will fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
@ -556,7 +576,9 @@ The current KSE has no associated mailbox, i.e., the process is operating is
traditional, unthreaded mode.
.El
.Pp
The
.Fn kse_wakeup
system call
will fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
@ -574,7 +596,9 @@ and the current KSE has no associated mailbox, i.e., the process is operating
in traditional, unthreaded mode.
.El
.Pp
The
.Fn kse_thr_interrupt
system call
will fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
@ -601,7 +625,7 @@ kernel.
.%T "Scheduler activations: effective kernel support for the user-level management of parallelism"
.Re
.Sh HISTORY
The KSE function calls first appeared in
The KSE system calls first appeared in
.Fx 5.0 .
.Sh AUTHORS
KSE was originally implemented by

10
lib/libc/sys/ktrace.2
View File

@ -50,7 +50,7 @@
.Sh DESCRIPTION
The
.Fn ktrace
function enables or disables tracing of one or more processes.
system call enables or disables tracing of one or more processes.
Users may only trace their own processes.
Only the super-user can trace setuid or setgid programs.
.Pp
@ -137,7 +137,9 @@ include file.
.Sh RETURN VALUES
.Rv -std ktrace
.Sh ERRORS
.Fn Ktrace
The
.Fn ktrace
system call
will fail if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -162,7 +164,7 @@ support.
.Xr kdump 1 ,
.Xr ktrace 1
.Sh HISTORY
A
The
.Fn ktrace
function call first appeared in
system call first appeared in
.Bx 4.4 .

12
lib/libc/sys/link.2
View File

@ -47,7 +47,7 @@
.Sh DESCRIPTION
The
.Fn link
function call
system call
atomically creates the specified directory entry (hard link)
.Fa name2
with the attributes of the underlying object pointed at by
@ -82,7 +82,9 @@ may not be a directory.
.Sh RETURN VALUES
.Rv -std link
.Sh ERRORS
.Fn Link
The
.Fn link
system call
will fail and no link will be created if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -153,12 +155,12 @@ is outside the process's allocated address space.
.Sh STANDARDS
The
.Fn link
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
The
.Fn link
function call appeared in
function appeared in
.At v7 .
.Pp
The

8
lib/libc/sys/listen.2
View File

@ -57,7 +57,7 @@ accepted with
.Xr accept 2 .
The
.Fn listen
call applies only to sockets of type
system call applies only to sockets of type
.Dv SOCK_STREAM
or
.Dv SOCK_SEQPACKET .
@ -120,7 +120,9 @@ parameter.
.Sh RETURN VALUES
.Rv -std listen
.Sh ERRORS
.Fn Listen
The
.Fn listen
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EBADF
@ -145,7 +147,7 @@ The socket is not of a type that supports the operation
.Sh HISTORY
The
.Fn listen
function call appeared in
system call appeared in
.Bx 4.2 .
The ability to configure the maximum
.Fa backlog

18
lib/libc/sys/lseek.2
View File

@ -47,7 +47,7 @@
.Sh DESCRIPTION
The
.Fn lseek
function repositions the offset of the file descriptor
system call repositions the offset of the file descriptor
.Fa fildes
to the
argument
@ -58,7 +58,9 @@ The argument
.Fa fildes
must be an open
file descriptor.
.Fn Lseek
The
.Fn lseek
system call
repositions the file position pointer associated with the file
descriptor
.Fa fildes
@ -93,7 +95,7 @@ bytes.
.Pp
The
.Fn lseek
function allows the file offset to be set beyond the end
system call allows the file offset to be set beyond the end
of the existing end-of-file of the file.
If data is later written
at this point, subsequent reads of the data in the gap return
@ -112,7 +114,9 @@ a value of -1 is returned and
is set to indicate
the error.
.Sh ERRORS
.Fn Lseek
The
.Fn lseek
system call
will fail and the file position pointer will remain unchanged if:
.Bl -tag -width Er
.It Bq Er EBADF
@ -141,10 +145,10 @@ is incorrect English, but is maintained for historical reasons.
.Sh STANDARDS
The
.Fn lseek
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
The
.Fn lseek
function call appeared in
function appeared in
.At v7 .

4
lib/libc/sys/madvise.2
View File

@ -136,7 +136,7 @@ Include region in a core file.
.Sh ERRORS
The
.Fn madvise
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The virtual address range specified by the
@ -153,5 +153,5 @@ arguments is not valid.
.Sh HISTORY
The
.Fn madvise
function first appeared in
system call first appeared in
.Bx 4.4 .

2
lib/libc/sys/mincore.2
View File

@ -81,5 +81,5 @@ The vector description is wrong.
.Sh HISTORY
The
.Fn mincore
function first appeared in
system call first appeared in
.Bx 4.4 .

6
lib/libc/sys/minherit.2
View File

@ -61,7 +61,7 @@ Inheritance only effects children created by
It has no effect on
.Fn exec .
exec'd processes replace their address space entirely.
This function also
This system call also
has no effect on the parent's address space (other than to potentially
share the address space with its children).
.Pp
@ -101,7 +101,7 @@ space in the parent.
.Sh ERRORS
The
.Fn minherit
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The virtual address range specified by the
@ -137,5 +137,5 @@ short of unmapping and remapping the area.
.Sh HISTORY
The
.Fn minherit
function first appeared in
system call first appeared in
.Ox .

6
lib/libc/sys/mkdir.2
View File

@ -60,7 +60,9 @@ which it is created.
.Sh RETURN VALUES
.Rv -std mkdir
.Sh ERRORS
.Fn Mkdir
The
.Fn mkdir
system call
will fail and no directory will be created if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -108,5 +110,5 @@ points outside the process's allocated address space.
.Sh STANDARDS
The
.Fn mkdir
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .

10
lib/libc/sys/mkfifo.2
View File

@ -46,7 +46,9 @@
.Ft int
.Fn mkfifo "const char *path" "mode_t mode"
.Sh DESCRIPTION
.Fn Mkfifo
The
.Fn mkfifo
system call
creates a new fifo file with name
.Fa path .
The access permissions are
@ -62,7 +64,9 @@ which it is created.
.Sh RETURN VALUES
.Rv -std mkfifo
.Sh ERRORS
.Fn Mkfifo
The
.Fn mkfifo
system call
will fail and no fifo will be created if:
.Bl -tag -width Er
.It Bq Er ENOTSUP
@ -117,5 +121,5 @@ points outside the process's allocated address space.
.Sh STANDARDS
The
.Fn mkfifo
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .

12
lib/libc/sys/mknod.2
View File

@ -61,12 +61,16 @@ Otherwise,
.Fa dev
is ignored.
.Pp
.Fn Mknod
The
.Fn mknod
system call
requires super-user privileges.
.Sh RETURN VALUES
.Rv -std mknod
.Sh ERRORS
.Fn Mknod
The
.Fn mknod
system call
will fail and the file will be not created if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -118,7 +122,7 @@ is not supported.
.Xr stat 2 ,
.Xr umask 2
.Sh HISTORY
A
The
.Fn mknod
function call appeared in
function appeared in
.At v6 .

14
lib/libc/sys/mlock.2
View File

@ -59,7 +59,7 @@ for
bytes.
The
.Fn munlock
call unlocks pages previously locked by one or more
system call unlocks pages previously locked by one or more
.Fn mlock
calls.
For both, the
@ -73,7 +73,7 @@ The entire range must be allocated.
.Pp
After an
.Fn mlock
call, the indicated pages will cause neither a non-resident page
system call, the indicated pages will cause neither a non-resident page
nor address-translation fault until they are unlocked.
They may still cause protection-violation faults or TLB-miss faults on
architectures with software-managed TLBs.
@ -110,7 +110,9 @@ These calls are only available to the super-user.
If the call succeeds, all pages in the range become locked (unlocked);
otherwise the locked status of all pages in the range remains unchanged.
.Sh ERRORS
.Fn Mlock
The
.Fn mlock
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EPERM
@ -124,7 +126,9 @@ limit for locked memory.
Some portion of the indicated address range is not allocated.
There was an error faulting/mapping a page.
.El
.Fn Munlock
The
.Fn munlock
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EPERM
@ -167,5 +171,5 @@ The
.Fn mlock
and
.Fn munlock
functions first appeared in
system calls first appeared in
.Bx 4.4 .

10
lib/libc/sys/mmap.2
View File

@ -47,7 +47,7 @@
.Sh DESCRIPTION
The
.Fn mmap
function causes the pages starting at
system call causes the pages starting at
.Fa addr
and continuing for at most
.Fa len
@ -186,7 +186,7 @@ while reading a large file sequentially, e.g. using
.Pp
The
.Xr fsync 2
function will flush all dirty data and metadata associated with a file,
system call will flush all dirty data and metadata associated with a file,
including dirty NOSYNC VM data, to physical media.
The
.Xr sync 8
@ -233,7 +233,7 @@ address returned by the call.
.Pp
The
.Xr close 2
function does not unmap pages, see
system call does not unmap pages, see
.Xr munmap 2
for further information.
.Pp
@ -254,7 +254,9 @@ is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn Mmap
The
.Fn mmap
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EACCES

5
lib/libc/sys/modfind.2
View File

@ -39,12 +39,15 @@
.Ft int
.Fn modfind "const char *modname"
.Sh DESCRIPTION
The function
The
.Fn modfind
system call
returns the modid of the kernel module referenced by
.Fa modname .
.Sh RETURN VALUES
The
.Fn modfind
system call
returns the modid of the kernel module referenced by
.Fa file .
Upon error,

11
lib/libc/sys/modnext.2
View File

@ -41,8 +41,9 @@
.Ft int
.Fn modfnext "int modid"
.Sh DESCRIPTION
The function
The
.Fn modnext
system call
returns the modid of the next kernel module (that is, the one after
.Va modid )
or 0 if
@ -54,11 +55,17 @@ If the
value is 0, then
.Fn modnext
will return the modid of the first module.
The
.Fn modfnext
system call
must always be given a valid modid.
.Sh RETURN VALUES
The
.Fn modnext
returns the modid of the next module (see DESCRIPTION) or 0. If an error
system call
returns the modid of the next module (see
.Sx DESCRIPTION )
or 0. If an error
occurs,
.Va errno
is set to indicate the error.

4
lib/libc/sys/modstat.2
View File

@ -41,7 +41,7 @@
.Sh DESCRIPTION
The
.Fn modstat
function writes the info for the kernel module referred to by
system call writes the info for the kernel module referred to by
.Fa modid
into
.Fa stat .
@ -104,7 +104,7 @@ field.
There was a problem copying one, some, or all of the fields into
.Fa stat
in the
.Fn copyout
.Xr copyout 9
function.
.El
.Sh SEE ALSO

15
lib/libc/sys/mount.2
View File

@ -51,7 +51,7 @@
.Sh DESCRIPTION
The
.Fn mount
function grafts
system call grafts
a file system object onto the system file tree
at the point
.Ar dir .
@ -137,14 +137,14 @@ By convention file system manual pages are named
by prefixing ``mount_'' to the name of the file system as returned by
.Xr lsvfs 1 .
Thus the
.Nm NFS
.Tn NFS
file system is described by the
.Xr mount_nfs 8
manual page.
.Pp
The
.Fn unmount
function call disassociates the file system from the specified
system call disassociates the file system from the specified
mount point
.Fa dir .
.Pp
@ -173,7 +173,7 @@ pages for more information.
.Sh ERRORS
The
.Fn mount
function will fail when one of the following occurs:
system call will fail when one of the following occurs:
.Bl -tag -width Er
.It Bq Er EPERM
The caller is not the super-user.
@ -250,7 +250,7 @@ points outside the process's allocated address space.
.Pp
The
.Fn unmount
function may fail with one of the following errors:
system call may fail with one of the following errors:
.Bl -tag -width Er
.It Bq Er EPERM
The caller is not the super-user.
@ -284,8 +284,9 @@ mounted.
.Sh BUGS
Some of the error codes need translation to more obvious messages.
.Sh HISTORY
.Fn Mount
The
.Fn mount
and
.Fn unmount
function calls appeared in
functions appeared in
.At v6 .

4
lib/libc/sys/mprotect.2
View File

@ -57,7 +57,7 @@ the granularity of protection changes may be as large as an entire region.
.Sh ERRORS
The
.Fn mprotect
function will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The virtual address range specified by the
@ -80,5 +80,5 @@ argument.
.Sh HISTORY
The
.Fn mprotect
function first appeared in
system call first appeared in
.Bx 4.4 .

4
lib/libc/sys/msync.2
View File

@ -73,7 +73,9 @@ MS_INVALIDATE Invalidate all cached data
.Sh RETURN VALUES
.Rv -std msync
.Sh ERRORS
The
.Fn msync
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
@ -97,5 +99,5 @@ An I/O error occurred while writing to the file system.
.Sh HISTORY
The
.Fn msync
function first appeared in
system call first appeared in
.Bx 4.4 .

6
lib/libc/sys/munmap.2
View File

@ -54,7 +54,9 @@ to generate invalid memory references.
.Sh RETURN VALUES
.Rv -std munmap
.Sh ERRORS
.Fn Munmap
The
.Fn munmap
system call
will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
@ -76,5 +78,5 @@ valid address range for a process.
.Sh HISTORY
The
.Fn munmap
function first appeared in
system call first appeared in
.Bx 4.4 .

20
lib/libc/sys/nanosleep.2
View File

@ -1,4 +1,3 @@
.\" $FreeBSD$
.\" $OpenBSD: nanosleep.2,v 1.1 1997/04/20 20:56:20 tholo Exp $
.\" $NetBSD: nanosleep.2,v 1.1 1997/04/17 18:12:02 jtc Exp $
.\"
@ -34,6 +33,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)sleep.3 8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd April 17, 1997
.Dt NANOSLEEP 2
@ -48,7 +48,9 @@
.Ft int
.Fn nanosleep "const struct timespec *rqtp" "struct timespec *rmtp"
.Sh DESCRIPTION
.Fn Nanosleep
The
.Fn nanosleep
system call
causes the process to sleep for the specified time. An unmasked signal will
cause it to terminate the sleep early, regardless of the
.Dv SA_RESTART
@ -56,25 +58,25 @@ value on the interrupting signal.
.Sh RETURN VALUES
If the
.Fn nanosleep
function returns because the requested time has elapsed, the value
system call returns because the requested time has elapsed, the value
returned will be zero.
.Pp
If the
.Fn nanosleep
function returns due to the delivery of a signal, the value returned
system call returns due to the delivery of a signal, the value returned
will be the -1, and the global variable
.Va errno
will be set to indicate the interruption.
If
.Fa rmtp
is
.Pf non- Dv NULL ,
.No non- Ns Dv NULL ,
the timespec structure it references is updated to contain the
unslept amount (the request time minus the time actually slept).
.Sh ERRORS
The
.Fn nanosleep
call fails if:
system call fails if:
.Bl -tag -width Er
.It Bq Er EFAULT
Either
@ -84,14 +86,18 @@ or
points to memory that is not a valid part of the process
address space.
.It Bq Er EINTR
The
.Fn nanosleep
system call
was interrupted by the delivery of a signal.
.It Bq Er EINVAL
.Fa rqtp
specified a nanosecond value less than zero
or greater than or equal to 1000 million.
.It Bq Er ENOSYS
The
.Fn nanosleep
system call
is not supported by this implementation.
.El
.Sh SEE ALSO
@ -100,5 +106,5 @@ is not supported by this implementation.
.Sh STANDARDS
The
.Fn nanosleep
function conforms to
system call conforms to
.St -p1003.1b-93 .

6
lib/libc/sys/nfssvc.2
View File

@ -52,7 +52,7 @@
.Sh DESCRIPTION
The
.Fn nfssvc
function is used by the NFS daemons to pass information into and out
system call is used by the NFS daemons to pass information into and out
of the kernel and also to enter the kernel as a server daemon.
The
.Fa flags
@ -76,7 +76,7 @@ set to
.Dv NULL
to enter the kernel as a block I/O server daemon.
For
.Nm NQNFS ,
.Tn NQNFS ,
.Xr mount_nfs 8
calls
.Fn nfssvc
@ -243,7 +243,7 @@ The caller is not the super-user.
.Sh HISTORY
The
.Fn nfssvc
function first appeared in
system call first appeared in
.Bx 4.4 .
.Sh BUGS
The

10
lib/libc/sys/open.2
View File

@ -59,7 +59,7 @@ created if it does not exist (by specifying the
.Dv O_CREAT
flag).
In this case
.Nm
.Fn open
requires a third argument
.Fa "mode_t mode" ,
and the file is created with mode
@ -118,7 +118,7 @@ If the
.Dv O_NONBLOCK
flag is specified and the
.Fn open
call would result
system call would result
in the process being blocked for some reason (e.g., waiting for
carrier on a dialup line),
.Fn open
@ -286,7 +286,7 @@ allocating the inode for
The file is a pure procedure (shared text) file that is being
executed and the
.Fn open
call requests write access.
system call requests write access.
.It Bq Er EFAULT
.Fa Path
points outside the process's allocated address space.
@ -315,7 +315,7 @@ and
.Xr umask 2 ,
.Xr write 2
.Sh HISTORY
An
The
.Fn open
function call appeared in
function appeared in
.At v6 .

14
lib/libc/sys/pathconf.2
View File

@ -52,7 +52,7 @@ The
.Fn pathconf
and
.Fn fpathconf
functions provides a method for applications to determine the current
system calls provide a method for applications to determine the current
value of a configurable system limit or option variable associated
with a pathname or file descriptor.
.Pp
@ -155,7 +155,7 @@ If any of the following conditions occur, the
.Fn pathconf
and
.Fn fpathconf
functions shall return -1 and set
system calls shall return -1 and set
.Va errno
to the corresponding value.
.Bl -tag -width Er
@ -168,7 +168,9 @@ The implementation does not support an association of the variable
name with the associated file.
.El
.Pp
.Fn Pathconf
The
.Fn pathconf
system call
will fail if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -187,7 +189,9 @@ An I/O error occurred while reading from or writing to the file system.
.El
.Pp
.Bl -tag -width Er
.Fn Fpathconf
The
.Fn fpathconf
system call
will fail if:
.It Bq Er EBADF
.Fa fd
@ -202,5 +206,5 @@ The
.Fn pathconf
and
.Fn fpathconf
functions first appeared in
system calls first appeared in
.Bx 4.4 .

8
lib/libc/sys/pipe.2
View File

@ -47,7 +47,7 @@
.Sh DESCRIPTION
The
.Fn pipe
function
system call
creates a
.Em pipe ,
which is an object allowing
@ -92,7 +92,7 @@ pipe in one direction.
.Sh ERRORS
The
.Fn pipe
call will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EMFILE
Too many descriptors are active.
@ -111,9 +111,9 @@ space.
.Xr socketpair 2 ,
.Xr write 2
.Sh HISTORY
A
The
.Fn pipe
function call appeared in
function appeared in
.At v3 .
.Pp
Bidirectional pipes were first used on

12
lib/libc/sys/poll.2
View File

@ -41,7 +41,9 @@
.Ft int
.Fn poll "struct pollfd fds[]" "nfds_t nfds" "int timeout"
.Sh DESCRIPTION
.Fn Poll
The
.Fn poll
system call
examines a set of file descriptors to see if some of them are ready for
I/O.
The
@ -128,7 +130,9 @@ is zero, then
.Fn poll
will return without blocking.
.Sh RETURN VALUES
.Fn Poll
The
.Fn poll
system call
returns the number of descriptors that are ready for I/O, or -1 if an
error occured. If the time limit expires,
.Fn poll
@ -136,7 +140,7 @@ returns 0.
If
.Fn poll
returns with an error,
including one due to an interrupted call,
including one due to an interrupted system call,
the
.Fa fds
array will be unmodified.
@ -185,7 +189,7 @@ defined for compatibility with existing software.
.Sh HISTORY
The
.Fn poll
function call appeared in
function appeared in
.At V .
This manual page and the core of the implementation was taken from
.Nx .

6
lib/libc/sys/profil.2
View File

@ -50,7 +50,7 @@
.Sh DESCRIPTION
The
.Fn profil
function enables or disables
system call enables or disables
program counter profiling of the current process.
If profiling is enabled,
then at every profiling clock tick,
@ -110,9 +110,9 @@ contains an invalid address.
.Sh SEE ALSO
.Xr gprof 1
.Sh HISTORY
A
The
.Fn profil
function call appeared in
function appeared in
.At v7 .
.Sh BUGS
This routine should be named

10
lib/libc/sys/ptrace.2
View File

@ -16,7 +16,9 @@
.Ft int
.Fn ptrace "int request" "pid_t pid" "caddr_t addr" "int data"
.Sh DESCRIPTION
The
.Fn ptrace
system call
provides tracing and debugging facilities.
It allows one process
(the
@ -37,7 +39,9 @@ or the delivery of a
.Dv SIGCHLD
signal, examine the state of the stopped process, and cause it to
terminate or continue as appropriate.
The
.Fn ptrace
system call
is the mechanism by which all this happens.
.Pp
The
@ -252,7 +256,7 @@ can be set to 0 before the call and checked afterwards.
.Sh ERRORS
The
.Fn ptrace
function may fail if:
system call may fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
.Bl -bullet -compact
@ -324,7 +328,7 @@ above.
.Xr i386_clr_watch 3 ,
.Xr i386_set_watch 3
.Sh HISTORY
A
The
.Fn ptrace
function call appeared in
function appeared in
.At v7 .

12
lib/libc/sys/quotactl.2
View File

@ -51,7 +51,7 @@
.Sh DESCRIPTION
The
.Fn quotactl
call enables, disables and
system call enables, disables and
manipulates file system quotas.
A quota control command
given by
@ -129,7 +129,7 @@ structure (defined in
The usage fields of the
.Fa dqblk
structure are ignored.
This call is restricted to the super-user.
This system call is restricted to the super-user.
.It Dv Q_SETUSE
Set disk usage limits for the user or group
(as determined by the command type) with identifier
@ -140,7 +140,7 @@ is a pointer to a
structure (defined in
.Ao Pa ufs/ufs/quota.h Ac ) .
Only the usage fields are used.
This call is restricted to the super-user.
This system call is restricted to the super-user.
.It Dv Q_SYNC
Update the on-disk copy of quota usages.
The command type specifies which type of quotas are to be updated.
@ -153,9 +153,9 @@ parameters are ignored.
.Sh RETURN VALUES
.Rv -std quotactl
.Sh ERRORS
A
The
.Fn quotactl
call will fail if:
system call will fail if:
.Bl -tag -width Er
.It Bq Er EOPNOTSUPP
The kernel has not been compiled with the
@ -222,5 +222,5 @@ and
.Sh HISTORY
The
.Fn quotactl
function call appeared in
system call appeared in
.Bx 4.3 Reno .

36
lib/libc/sys/read.2
View File

@ -53,21 +53,27 @@
.Ft ssize_t
.Fn pread "int d" "void *buf" "size_t nbytes" "off_t offset"
.Sh DESCRIPTION
.Fn Read
The
.Fn read
system call
attempts to read
.Fa nbytes
of data from the object referenced by the descriptor
.Fa d
into the buffer pointed to by
.Fa buf .
.Fn Readv
The
.Fn readv
system call
performs the same action, but scatters the input data
into the
.Fa iovcnt
buffers specified by the members of the
.Fa iov
array: iov[0], iov[1], ..., iov[iovcnt\|\-\|1].
.Fn Pread
The
.Fn pread
system call
performs the same function, but reads from the specified position in
the file without modifying the file pointer.
.Pp
@ -88,7 +94,9 @@ Each
.Fa iovec
entry specifies the base address and length of an area
in memory where data should be placed.
.Fn Readv
The
.Fn readv
system call
will always fill an area completely before proceeding
to the next.
.Pp
@ -125,10 +133,12 @@ Otherwise, a -1 is returned and the global variable
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn Read ,
The
.Fn read ,
.Fn readv ,
and
.Fn pread
system calls
will succeed unless:
.Bl -tag -width Er
.It Bq Er EBADF
@ -178,7 +188,7 @@ points outside the process's allocated address space.
.Pp
The
.Fn pread
call may also return the following errors:
system call may also return the following errors:
.Bl -tag -width Er
.It Bq Er EINVAL
The specified file offset is invalid.
@ -196,26 +206,24 @@ The file descriptor is associated with a pipe, socket, or FIFO.
.Sh STANDARDS
The
.Fn read
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-90 .
The
.Fn readv
and
.Fn pread
functions are expected to conform to
system calls are expected to conform to
.St -xpg4.2 .
.Sh HISTORY
The
.Fn pread
function call
appeared in
function appeared in
.At V.4 .
The
.Fn readv
function call
appeared in
system call appeared in
.Bx 4.2 .
A
The
.Fn read
function call appeared in
function appeared in
.At v6 .

12
lib/libc/sys/readlink.2
View File

@ -45,7 +45,9 @@
.Ft int
.Fn readlink "const char *path" "char *buf" "int bufsiz"
.Sh DESCRIPTION
.Fn Readlink
The
.Fn readlink
system call
places the contents of the symbolic link
.Fa path
in the buffer
@ -54,7 +56,7 @@ which has size
.Fa bufsiz .
The
.Fn readlink
function does not append a
system call does not append a
.Dv NUL
character to
.Fa buf .
@ -64,7 +66,9 @@ if it succeeds, or a -1 if an error occurs, placing the error
code in the global variable
.Va errno .
.Sh ERRORS
.Fn Readlink
The
.Fn readlink
system call
will fail if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
@ -94,5 +98,5 @@ extends outside the process's allocated address space.
.Sh HISTORY
The
.Fn readlink
function call appeared in
system call appeared in
.Bx 4.2 .

8
lib/libc/sys/reboot.2
View File

@ -46,7 +46,9 @@
.Ft int
.Fn reboot "int howto"
.Sh DESCRIPTION
.Fn Reboot
The
.Fn reboot
system call
reboots the system.
Only the super-user may reboot a machine on demand.
However, a reboot is invoked
@ -103,7 +105,7 @@ Several other options have different meaning if combined
with this option, although their use may not be possible
via the
.Fn reboot
call.
system call.
See
.Xr ddb 4
for more information.
@ -162,5 +164,5 @@ nor
.Sh HISTORY
The
.Fn reboot
function call appeared in
system call appeared in
.Bx 4.0 .

18
lib/libc/sys/recv.2
View File

@ -52,9 +52,11 @@
.Ft ssize_t
.Fn recvmsg "int s" "struct msghdr *msg" "int flags"
.Sh DESCRIPTION
.Fn Recvfrom
The
.Fn recvfrom
and
.Fn recvmsg
system calls
are used to receive messages from a socket,
and may be used to receive data on a socket whether or not
it is connection-oriented.
@ -72,7 +74,7 @@ address stored there.
.Pp
The
.Fn recv
call is normally used only on a
function is normally used only on a
.Em connected
socket (see
.Xr connect 2 )
@ -111,11 +113,13 @@ described in
.Pp
The
.Xr select 2
call may be used to determine when more data arrive.
system call may be used to determine when more data arrive.
.Pp
The
.Fa flags
argument to a recv call is formed by
argument to a
.Fn recv
function is formed by
.Em or Ap ing
one or more of the values:
.Bl -column MSG_WAITALL -offset indent
@ -142,7 +146,7 @@ or the next data to be received is of a different type than that returned.
.Pp
The
.Fn recvmsg
call uses a
system call uses a
.Fa msghdr
structure to minimize the number of directly supplied parameters.
This structure has the following form, as defined in
@ -192,7 +196,7 @@ As an example, one could use this to learn of changes in the data-stream
in XNS/SPP, or in ISO, to obtain user-connection-request data by requesting
a recvmsg with no data buffer provided immediately after an
.Fn accept
call.
system call.
.Pp
Open file descriptors are now passed as ancillary data for
.Dv AF_UNIX
@ -291,5 +295,5 @@ address space.
.Sh HISTORY
The
.Fn recv
function call appeared in
function appeared in
.Bx 4.2 .

14
lib/libc/sys/rename.2
View File

@ -45,7 +45,9 @@
.Ft int
.Fn rename "const char *from" "const char *to"
.Sh DESCRIPTION
.Fn Rename
The
.Fn rename
system call
causes the link named
.Fa from
to be renamed as
@ -60,7 +62,9 @@ and
must be of the same type (that is, both directories or both
non-directories), and must reside on the same file system.
.Pp
.Fn Rename
The
.Fn rename
system call
guarantees that if
.Fa to
already exists, an instance of
@ -102,7 +106,9 @@ not the file or directory to which it points.
.Sh RETURN VALUES
.Rv -std rename
.Sh ERRORS
.Fn Rename
The
.Fn rename
system call
will fail and neither of the argument files will be
affected if:
.Bl -tag -width Er
@ -195,5 +201,5 @@ is a directory and is not empty.
.Sh STANDARDS
The
.Fn rename
function call is expected to conform to
system call is expected to conform to
.St -p1003.1-96 .

8
lib/libc/sys/revoke.2
View File

@ -50,7 +50,7 @@
.Sh DESCRIPTION
The
.Fn revoke
function invalidates all current open file descriptors in the system
system call invalidates all current open file descriptors in the system
for the file named by
.Fa path .
Subsequent operations on any such descriptors
@ -60,7 +60,7 @@ from a character device file which has been revoked
returns a count of zero (end of file),
and a
.Fn close
call will succeed.
system call will succeed.
If the file is a special file for a device which is open,
the device close function
is called as if all open references to the file had been closed.
@ -68,7 +68,7 @@ is called as if all open references to the file had been closed.
Access to a file may be revoked only by its owner or the super user.
The
.Fn revoke
function is currently supported only for block and character special
system call is currently supported only for block and character special
device files.
It is normally used to prepare a terminal device for a new login session,
preventing any access by a previous user of the terminal.
@ -103,5 +103,5 @@ The caller is neither the owner of the file nor the super user.
.Sh HISTORY
The
.Fn revoke
function was introduced in
system call first appeared in
.Bx 4.3 Reno .

20
lib/libc/sys/rfork.2
View File

@ -67,7 +67,7 @@ May be set only with
.Dv RFPROC .
A helper function is provided to assist with this problem and will cause
the new process to run on the provided stack. See
.Fn rfork_thread 3
.Xr rfork_thread 3
for information.
.It RFSIGSHARE
If set, the kernel will force sharing the sigacts structure between the
@ -93,10 +93,14 @@ the return value is zero.
Process id's range from 1 to the maximum integer
.Ft ( int )
value.
.Fn Rfork
The
.Fn rfork
system call
will sleep, if necessary, until required process resources are available.
.Pp
.Fn Fork
The
.Fn fork
system call
can be implemented as a call to
.Fn rfork "RFFDG | RFPROC"
but isn't for backwards compatibility.
@ -111,7 +115,9 @@ variable
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn Rfork
The
.Fn rfork
system call
will fail and no child process will be created if:
.Bl -tag -width Er
.It Bq Er EAGAIN
@ -165,10 +171,10 @@ contains a working
.Fn clone
call that utilizes RFMEM.
The
.Fn rfork_thread
library call can often be used instead of
.Xr rfork_thread 3
function can often be used instead of
.Fn clone .
.Sh HISTORY
The
.Fn rfork
function call first appeared in Plan9.
function first appeared in Plan9.

6
lib/libc/sys/rmdir.2
View File

@ -45,7 +45,9 @@
.Ft int
.Fn rmdir "const char *path"
.Sh DESCRIPTION
.Fn Rmdir
The
.Fn rmdir
system call
removes a directory file
whose name is given by
.Fa path .
@ -101,5 +103,5 @@ points outside the process's allocated address space.
.Sh HISTORY
The
.Fn rmdir
function call appeared in
system call appeared in
.Bx 4.2 .

Some files were not shown because too many files have changed in this diff Show More