Fix some typos, attempt some markup normalization, align wording a little

more with other manual pages.
This commit is contained in:
kleink 2003-09-13 23:00:38 +00:00
parent bb2796d215
commit b9f1052a4d
3 changed files with 33 additions and 27 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: timer_create.2,v 1.2 2003/09/13 22:31:04 kleink Exp $
.\" $NetBSD: timer_create.2,v 1.3 2003/09/13 23:00:38 kleink Exp $
.\"
.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -65,7 +65,7 @@ must be a valid clock id as defined in
The timer is created in a disarmed state.
.Pp
An optional (non-
.Dv NULL
.Dv NULL )
sigevent argument can be specified by the
.Ar evp
argument. If the
@ -89,12 +89,14 @@ Timers are not inherited after a
and are disarmed and deleted by an
.Xr exec 2 .
.Sh RETURN VALUES
If the
If successful, the
.Fn timer_create
call succeed, it returns 0, and fills in the
function returns 0, and fills in the
.Ar timerid
argument with the id of the new timer that was created.
If the call fails, it returns -1, and sets errno to indicate the error.
Otherwise, it returns \-1, and sets
.Dv errno
to indicate the error.
.Sh ERRORS
The
.Fn timer_create
@ -104,9 +106,9 @@ function will fail if:
The system is out of resources to satisfy this request, or the process has
created all the timers it is allowed.
.It Bq Er EINVAL
The clock id in the
The argument
.Ar clockid
is invalid.
is not a valid clock id.
.Sh SEE ALSO
.Xr clock_gettime 2 ,
.Xr clock_settime 2 ,

View File

@ -1,4 +1,4 @@
.\" $NetBSD: timer_delete.2,v 1.2 2003/09/13 22:44:23 christos Exp $
.\" $NetBSD: timer_delete.2,v 1.3 2003/09/13 23:00:38 kleink Exp $
.\"
.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -51,26 +51,29 @@ The
.Fn timer_delete
functions deletes the timer specified in the
.Ar timerid
argument. The
argument.
The
.Ar timerid
argument must point to valid timer id, created by
.Xr timer_create 2 .
If the deletion is successful, the timer is disarmed and deleted.
Pending notification events (signals) may or may not be delivered.
.Sh RETURN VALUES
The
If successful, the
.Fn timer_delete
functions returns 0 if it succeeds and -1 on error, setting errno to indicate
the nature of the error.
functions returns 0.
Otherwise, it returns \-1, and sets
.Dv errno
to indicate error.
.Sh ERRORS
The
.Fn timer_delete
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The timer id specified in the
The argument
.Ar timerid
argument is not valid.
is not a valid timer id.
.El
.Sh SEE ALSO
.Xr timer_create 2 ,

View File

@ -1,4 +1,4 @@
.\" $NetBSD: timer_settime.2,v 1.2 2003/09/13 22:31:04 kleink Exp $
.\" $NetBSD: timer_settime.2,v 1.3 2003/09/13 23:00:38 kleink Exp $
.\"
.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -53,7 +53,7 @@
.Sh DESCRIPTION
The
.Fn timer_settime
sets the next expiration time of the timer who's id is specified by
sets the next expiration time of the timer with id
.Ar timerid
to the
.Fa it_value
@ -75,7 +75,8 @@ the
.Ar tim
argument from the time the call to
.Fn timer_settime
was made. If the
was made.
If the
.Ar flags
argument is set to
.Dv TIMER_ABSTIME
@ -103,8 +104,8 @@ argument.
Only one notification event (signal) can be pending for a given timer
and process.
If a timer expires while the signal is still queued for delivery, then
the overrun counter for that timer is increased. The counter can store
values up to
the overrun counter for that timer is increased.
The counter can store values up to
.Dv DELAYTIMER_MAX .
When the signal is finally delivered to the process, then the
.Fn timer_getoverrun
@ -127,16 +128,16 @@ argment of
are subject to the above rounding effect and might not exactly match the
requested values by the user.
.Sh RETURN VALUES
The
If successful, the
.Fn timer_gettime
and
.Fn timer_settime
functions return 0 on success or -1 on failure with errno set to indicate the
error.
The
functions return 0, and the
.Fn timer_getoverrun
returns the expiration overrun count for the specified timer when it succeeds,
or -1 with errno set to indicated the error.
function returns the expiration overrun count for the specified timer.
Otherwise, the functions return \-1, and set
.Dv errno
to indicate the error.
.Sh ERRORS
The
.Fn timer_gettime ,
@ -146,9 +147,9 @@ and
functions will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The
The argument
.Ar timerid
argument does not correspond to a valid timer id as returned by
does not correspond to a valid timer id as returned by
.Fn timer_create
or that timer id has been deleted by
.Fn timer_delete .