Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Various improvements: sort errors; use more 

markup; fixes for HTML and PostScript output.
This commit is contained in:
wiz 2007-08-07 20:45:03 +00:00
parent d70a2a3a9d
commit 90a93c1dcd
9 changed files with 70 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/librt/aio_cancel.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: aio_cancel.3,v 1.2 2007/05/05 19:16:01 ad Exp $
.\" $NetBSD: aio_cancel.3,v 1.3 2007/08/07 20:45:03 wiz Exp $
.\"
.\" Copyright (c) 1999 Softweyr LLC.
.\" All rights reserved.
@ -63,7 +63,7 @@ for file descriptors associated with raw disk devices.
.Sh RETURN VALUES
The
.Fn aio_cancel
system call 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.
@ -82,8 +82,7 @@ indicates:
.It Bq Er EBADF
The
.Fa fildes
argument
is an invalid file descriptor.
argument is an invalid file descriptor.
.El
.Sh SEE ALSO
.Xr aio_error 3 ,

8
lib/librt/aio_error.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: aio_error.3,v 1.2 2007/05/05 19:16:01 ad Exp $
.\" $NetBSD: aio_error.3,v 1.3 2007/08/07 20:45:03 wiz Exp $
.\"
.\" Copyright (c) 1999 Softweyr LLC.
.\" All rights reserved.
@ -59,10 +59,8 @@ or
.Xr fsync 2 .
On failure,
.Fn aio_error
returns
.Dv -1
and sets
.Dv errno
returns \-1 and sets
.Va errno
to indicate the error condition.
.Sh ERRORS
The

4
lib/librt/aio_fsync.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: aio_fsync.3,v 1.1 2007/06/17 12:47:41 rmind Exp $
.\" $NetBSD: aio_fsync.3,v 1.2 2007/08/07 20:45:03 wiz Exp $
.\"
.\" Copyright (c) 2007 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -31,7 +31,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd Jun 17, 2007
.Dd June 17, 2007
.Dt AIO_FSYNC 3
.Os
.Sh NAME

48
lib/librt/aio_read.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: aio_read.3,v 1.2 2007/05/05 19:16:01 ad Exp $
.\" $NetBSD: aio_read.3,v 1.3 2007/08/07 20:45:04 wiz Exp $
.\"
.\" Copyright (c) 1998 Terry Lambert
.\" All rights reserved.
@ -42,24 +42,26 @@
The
.Fn aio_read
system call allows the calling process to read
.Fa aiocbp->aio_nbytes
.Fa aiocbp-\*[Gt]aio_nbytes
from the descriptor
.Fa aiocbp->aio_fildes
.Fa aiocbp-\*[Gt]aio_fildes
beginning at the offset
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
into the buffer pointed to by
.Fa aiocbp->aio_buf .
.Fa aiocbp-\*[Gt]aio_buf .
The call returns immediately after the read request has
been enqueued to the descriptor; the read may or may not have
completed at the time the call returns.
.Pp
If _POSIX_PRIORITIZED_IO is defined, and the descriptor supports it,
If
.Dv _POSIX_PRIORITIZED_IO
is defined, and the descriptor supports it,
then the enqueued operation is submitted at a priority equal to that
of the calling process minus
.Fa aiocbp->aio_reqprio .
.Fa aiocbp-\*[Gt]aio_reqprio .
.Pp
The
.Fa aiocbp->aio_lio_opcode
.Fa aiocbp-\*[Gt]aio_lio_opcode
argument
is ignored by the
.Fn aio_read
@ -78,14 +80,14 @@ If the request could not be enqueued (generally due to invalid arguments),
then the call returns without having enqueued the request.
.Pp
If the request is successfully enqueued, the value of
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
can be modified during the request as context, so this value must
not be referenced after the request is enqueued.
.Sh RESTRICTIONS
The Asynchronous I/O Control Block structure pointed to by
.Fa aiocbp
and the buffer that the
.Fa aiocbp->aio_buf
.Fa aiocbp-\*[Gt]aio_buf
member of that structure references must remain valid until the
operation has completed.
For this reason, use of auto (stack) variables
@ -102,9 +104,9 @@ buffer contents after the request has been enqueued, but before the
request has completed, are not allowed.
.Pp
If the file offset in
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
is past the offset maximum for
.Fa aiocbp->aio_fildes ,
.Fa aiocbp-\*[Gt]aio_fildes ,
no I/O will occur.
.Sh RETURN VALUES
.Rv -std aio_read
@ -125,11 +127,11 @@ system call is made, or asynchronously, at any time thereafter.
If they
are detected at call time,
.Fn aio_read
returns -1 and sets
returns \-1 and sets
.Va errno
appropriately; otherwise the
.Fn aio_return
system call 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
@ -138,24 +140,24 @@ returned in
.Bl -tag -width Er
.It Bq Er EBADF
The
.Fa aiocbp->aio_fildes
.Fa aiocbp-\*[Gt]aio_fildes
argument
is invalid.
.It Bq Er EINVAL
The offset
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
is not valid, the priority specified by
.Fa aiocbp->aio_reqprio
.Fa aiocbp-\*[Gt]aio_reqprio
is not a valid priority, or the number of bytes specified by
.Fa aiocbp->aio_nbytes
.Fa aiocbp-\*[Gt]aio_nbytes
is not valid.
.It Bq Er EOVERFLOW
The file is a regular file,
.Fa aiocbp->aio_nbytes
.Fa aiocbp-\*[Gt]aio_nbytes
is greater than zero, the starting offset in
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
is before the end of the file, but is at or beyond the
.Fa aiocbp->aio_fildes
.Fa aiocbp-\*[Gt]aio_fildes
offset maximum.
.El
.Pp
@ -172,7 +174,7 @@ system call, or one of:
.Bl -tag -width Er
.It Bq Er EBADF
The
.Fa aiocbp->aio_fildes
.Fa aiocbp-\*[Gt]aio_fildes
argument
is invalid for reading.
.It Bq Er ECANCELED
@ -180,7 +182,7 @@ The request was explicitly cancelled via a call to
.Fn aio_cancel .
.It Bq Er EINVAL
The offset
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
would be invalid.
.El
.Sh SEE ALSO

6
lib/librt/aio_return.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: aio_return.3,v 1.2 2007/05/05 19:16:01 ad Exp $
.\" $NetBSD: aio_return.3,v 1.3 2007/08/07 20:45:04 wiz Exp $
.\"
.\" Copyright (c) 1999 Softweyr LLC.
.\" All rights reserved.
@ -50,9 +50,9 @@ The
system call
should only be called once, to obtain the final status of an asynchronous
I/O operation once it has completed
.Xr ( aio_error 3
.Po Xr aio_error 3
returns something other than
.Er EINPROGRESS ) .
.Er EINPROGRESS Pc .
.Sh RETURN VALUES
If the asynchronous I/O request has completed, the status is returned
as described in

10
lib/librt/aio_suspend.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: aio_suspend.3,v 1.2 2007/05/05 19:16:01 ad Exp $
.\" $NetBSD: aio_suspend.3,v 1.3 2007/08/07 20:45:04 wiz Exp $
.\"
.\" Copyright (c) 1999 Softweyr LLC.
.\" All rights reserved.
@ -71,7 +71,7 @@ If one or more of the specified asynchronous I/O requests have
completed,
.Fn aio_suspend
returns 0.
Otherwise it returns -1 and sets
Otherwise it returns \-1 and sets
.Va errno
to indicate the error, as enumerated below.
.Sh ERRORS
@ -80,9 +80,11 @@ The
system call will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
the
The
.Fa timeout
expired before any I/O requests completed.
.It Bq Er EINTR
The suspend was interrupted by a signal.
.It Bq Er EINVAL
The
.Fa list
@ -91,8 +93,6 @@ contains more than
.Dv AIO_LISTIO_MAX
asynchronous I/O requests, or at least one of the requests is not
valid.
.It Bq Er EINTR
the suspend was interrupted by a signal.
.El
.Sh SEE ALSO
.Xr aio_cancel 3 ,

40
lib/librt/aio_write.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: aio_write.3,v 1.2 2007/05/05 19:16:01 ad Exp $
.\" $NetBSD: aio_write.3,v 1.3 2007/08/07 20:45:04 wiz Exp $
.\"
.\" Copyright (c) 1999 Softweyr LLC.
.\" All rights reserved.
@ -42,11 +42,11 @@
The
.Fn aio_write
system call allows the calling process to write
.Fa aiocbp->aio_nbytes
.Fa aiocbp-\*[Gt]aio_nbytes
from the buffer pointed to by
.Fa aiocbp->aio_buf
.Fa aiocbp-\*[Gt]aio_buf
to the descriptor
.Fa aiocbp->aio_fildes .
.Fa aiocbp-\*[Gt]aio_fildes .
The call returns immediately after the write request has been enqueued
to the descriptor; the write may or may not have completed at the time
the call returns.
@ -57,7 +57,7 @@ request.
If
.Dv O_APPEND
is set for
.Fa aiocbp->aio_fildes ,
.Fa aiocbp-\*[Gt]aio_fildes ,
.Fn aio_write
operations append to the file in the same order as the calls were
made.
@ -65,14 +65,14 @@ If
.Dv O_APPEND
is not set for the file descriptor, the write operation will occur at
the absolute position from the beginning of the file plus
.Fa aiocbp->aio_offset .
.Fa aiocbp-\*[Gt]aio_offset .
.Pp
If
.Dv _POSIX_PRIORITIZED_IO
is defined, and the descriptor supports it, then the enqueued
operation is submitted at a priority equal to that of the calling
process minus
.Fa aiocbp->aio_reqprio .
.Fa aiocbp-\*[Gt]aio_reqprio .
.Pp
The
.Fa aiocbp
@ -84,14 +84,14 @@ in order to determine return or error status for the enqueued operation
while it is in progress.
.Pp
If the request is successfully enqueued, the value of
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
can be modified during the request as context, so this value must not
be referenced after the request is enqueued.
.Sh RESTRICTIONS
The Asynchronous I/O Control Block structure pointed to by
.Fa aiocbp
and the buffer that the
.Fa aiocbp->aio_buf
.Fa aiocbp-\*[Gt]aio_buf
member of that structure references must remain valid until the
operation has completed.
For this reason, use of auto (stack) variables
@ -108,9 +108,9 @@ buffer contents after the request has been enqueued, but before the
request has completed, are not allowed.
.Pp
If the file offset in
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
is past the offset maximum for
.Fa aiocbp->aio_fildes ,
.Fa aiocbp-\*[Gt]aio_fildes ,
no I/O will occur.
.Sh RETURN VALUES
.Rv -std aio_write
@ -129,11 +129,11 @@ system call is made, or asynchronously, at any time thereafter.
If they
are detected at call time,
.Fn aio_write
returns -1 and sets
returns \-1 and sets
.Va errno
appropriately; otherwise the
.Fn aio_return
system call 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
@ -142,16 +142,16 @@ returned in
.Bl -tag -width Er
.It Bq Er EBADF
The
.Fa aiocbp->aio_fildes
.Fa aiocbp-\*[Gt]aio_fildes
argument
is invalid, or is not opened for writing.
.It Bq Er EINVAL
The offset
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
is not valid, the priority specified by
.Fa aiocbp->aio_reqprio
.Fa aiocbp-\*[Gt]aio_reqprio
is not a valid priority, or the number of bytes specified by
.Fa aiocbp->aio_nbytes
.Fa aiocbp-\*[Gt]aio_nbytes
is not valid.
.El
.Pp
@ -168,7 +168,7 @@ system call, or one of:
.Bl -tag -width Er
.It Bq Er EBADF
The
.Fa aiocbp->aio_fildes
.Fa aiocbp-\*[Gt]aio_fildes
argument
is invalid for writing.
.It Bq Er ECANCELED
@ -176,11 +176,11 @@ The request was explicitly canceled via a call to
.Fn aio_cancel .
.It Bq Er EINVAL
The offset
.Fa aiocbp->aio_offset
.Fa aiocbp-\*[Gt]aio_offset
would be invalid.
.El
.Sh SEE ALSO
.Xr siginfo 2 ,
.Xr siginfo 2 ,
.Xr aio_cancel 3 ,
.Xr aio_error 3 ,
.Xr aio_return 3 ,

10
lib/librt/lio_listio.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: lio_listio.3,v 1.1 2007/05/04 22:37:36 rmind Exp $
.\" $NetBSD: lio_listio.3,v 1.2 2007/08/07 20:45:04 wiz Exp $
.\"
.\" Copyright (c) 2003 Tim J. Robbins
.\" All rights reserved.
@ -31,7 +31,7 @@
.Os
.Sh NAME
.Nm lio_listio
.Nd "list directed I/O (REALTIME)"
.Nd list directed I/O (REALTIME)
.Sh LIBRARY
.Lb librt
.Sh SYNOPSIS
@ -125,6 +125,8 @@ There are not enough resources to enqueue the requests.
The request would cause the system-wide limit
.Dv AIO_MAX
to be exceeded.
.It Bq Er EINTR
A signal interrupted the system call before it could be completed.
.It Bq Er EINVAL
The
.Fa mode
@ -136,8 +138,6 @@ or
.Fa nent
is greater than
.Dv AIO_LISTIO_MAX .
.It Bq Er EINTR
A signal interrupted the system call before it could be completed.
.It Bq Er EIO
One or more requests failed.
.El
@ -166,7 +166,7 @@ structure individually by calling
.Xr write 2 ,
.Xr aio_error 3 ,
.Xr aio_read 3 ,
.Xr aio_write 3 ,
.Xr aio_write 3
.Sh STANDARDS
The
.Fn lio_listio

8
lib/librt/sem_destroy.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: sem_destroy.3,v 1.1 2003/01/24 01:52:44 thorpej Exp $
.\" $NetBSD: sem_destroy.3,v 1.2 2007/08/07 20:45:05 wiz Exp $
.\"
.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
.\" All rights reserved.
@ -55,13 +55,13 @@ is unusable until re-initialized by another call to
.Fn sem_destroy
will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa sem
points to an invalid semaphore.
.It Bq Er EBUSY
There are currently threads blocked on the semaphore that
.Fa sem
points to.
.It Bq Er EINVAL
.Fa sem
points to an invalid semaphore.
.El
.Sh SEE ALSO
.Xr sem_init 3