[src/trunk]: src/lib/libc/sys Add timer man pages. Hi Nathan!

To: source-changes-hg%NetBSD.org@localhost
Subject: [src/trunk]: src/lib/libc/sys Add timer man pages. Hi Nathan!
From: christos <christos%NetBSD.org@localhost>
Date: Fri, 24 Jan 2020 13:39:40 +0000
details:   https://anonhg.NetBSD.org/src/rev/eb5de9688fab
branches:  trunk
changeset: 551906:eb5de9688fab
user:      christos <christos%NetBSD.org@localhost>
date:      Sat Sep 13 22:22:29 2003 +0000

description:
Add timer man pages. Hi Nathan!

diffstat:

 lib/libc/sys/Makefile.inc    |    6 +-
 lib/libc/sys/timer_create.2  |  120 ++++++++++++++++++++++++++++++
 lib/libc/sys/timer_delete.2  |   81 ++++++++++++++++++++
 lib/libc/sys/timer_settime.2 |  172 +++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 377 insertions(+), 2 deletions(-)

diffs (truncated from 412 to 300 lines):

diff -r 13eccfaaa19e -r eb5de9688fab lib/libc/sys/Makefile.inc
--- a/lib/libc/sys/Makefile.inc Sat Sep 13 21:53:19 2003 +0000
+++ b/lib/libc/sys/Makefile.inc Sat Sep 13 22:22:29 2003 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile.inc,v 1.141 2003/08/01 17:03:58 lukem Exp $
+#      $NetBSD: Makefile.inc,v 1.142 2003/09/13 22:22:29 christos Exp $
 #      @(#)Makefile.inc        8.3 (Berkeley) 10/24/94
 
 # sys sources
@@ -151,7 +151,8 @@
        sigprocmask.2 sigreturn.2 sigstack.2 sigsuspend.2 sigtimedwait.2 \
        socket.2 \
        socketpair.2 stat.2 statfs.2 swapctl.2 swapon.3 symlink.2 \
-       sync.2 sysarch.2 syscall.2 truncate.2 umask.2 undelete.2 \
+       sync.2 sysarch.2 syscall.2 timer_create.2 timer_delete.2 \
+       truncate.2 umask.2 undelete.2 \
        unlink.2 utimes.2 utrace.2 vfork.2 wait.2 write.2
 
 MLINKS+=_exit.2 _Exit.2
@@ -195,6 +196,7 @@
 MLINKS+=setpgid.2 setpgrp.2
 MLINKS+=setuid.2 setegid.2 setuid.2 seteuid.2 setuid.2 setgid.2
 MLINKS+=shmat.2 shmdt.2
+MLINKS+=timer_settime.2 timer_gettime.2 timer_settime.2 timer_getoverrun.2
 MLINKS+=sigtimedwait.2 sigwaitinfo.2
 MLINKS+=sigtimedwait.2 sigwait.2
 MLINKS+=stat.2 fstat.2 stat.2 lstat.2
diff -r 13eccfaaa19e -r eb5de9688fab lib/libc/sys/timer_create.2
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libc/sys/timer_create.2       Sat Sep 13 22:22:29 2003 +0000
@@ -0,0 +1,120 @@
+.\"    $NetBSD: timer_create.2,v 1.1 2003/09/13 22:22:30 christos Exp $
+.\"
+.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Christos Zoulas.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" 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.
+.\"
+.Dd September 13, 2003
+.Dt TIMER_CREATE 2
+.Os
+.Sh NAME
+.Nm timer_create
+.Nd create a per-process timer
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.In time.h
+.In signal.h
+.Ft int
+.Fn timer_create "clockid_t clockid" "struct sigevent *evp" "timer_t *timerid"
+.Sh DESCRIPTION
+The
+.Fn timer_create
+function creates a per-process timer using the clock specified in the
+.Ar clockid
+argument.
+If it succeeds, the
+.Fn timer_create
+function fills in the
+.Ar timerid
+argument with an id accociated with the timer created that can be used by
+other timer related calls. The 
+.Ar clockid
+must be a valid clock id as defined in
+.In time.h .
+The timer is created in a disarmed state.
+.Pp
+An optional (non-
+.Dv NULL
+sigevent argument can be specified by the
+.Ar evp
+argument. If the
+.Ar evp
+argument is
+.Dv NULL ,
+then it defaults to
+.Fa sigev_notify 
+set to
+.Dv SIGEV_SIGVAL
+and
+.Fa sigev_value
+set to
+.Ar timerid .
+See 
+.Xr siginfo 5
+for accessing those values from a signal handler.
+.Sh NOTES
+Timers are not inherited after a
+.Xr fork 2
+and are disarmed and deleted by an
+.Xr exec 2 .
+.Sh RETURN VALUES
+If the
+.Fn timer_create
+call succeed, it 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.
+.Sh ERRORS
+The 
+.Fn timer_create
+function will fail if:
+.Bl -tag -width Er
+.It Bq Er EAGAIN
+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
+.Ar clockid
+is invalid.
+.Sh SEE ALSO
+.Xr clock_gettime 2 ,
+.Xr clock_settime 2 ,
+.Xr clock_getres 2 ,
+.Xr timer_delete 2 ,
+.Xr timer_gettime 2 ,
+.Xr timer_getoverrun 2 ,
+.Xr timer_settime 2
+.Sh STANDARDS
+.St -p1003.1b-93 ,
+.St -p1003.1i-95
diff -r 13eccfaaa19e -r eb5de9688fab lib/libc/sys/timer_delete.2
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libc/sys/timer_delete.2       Sat Sep 13 22:22:29 2003 +0000
@@ -0,0 +1,81 @@
+.\"    $NetBSD: timer_delete.2,v 1.1 2003/09/13 22:22:30 christos Exp $
+.\"
+.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Christos Zoulas.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" 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.
+.\"
+.Dd September 13, 2003
+.Dt TIMER_DELETE 2
+.Os
+.Sh NAME
+.Nm timer_delete
+.Nd delete a per-process timer
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.In time.h
+.Ft int
+.Fn timer_delete "timer_t timerid"
+.Sh DESCRIPTION
+The
+.Fn timer_delete
+functions deletes the timer specified in the
+.Ar timerid
+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
+.Fn timer_delete
+functions returns 0 if it succeeds and -1 on error, setting errno to indicate
+the nature of the 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
+.Ar timerid
+argument is not valid.
+.Sh SEE ALSO
+.Xr timer_create 2 ,
+.Xr timer_gettime 2 ,
+.Xr timer_getoverrun 2 ,
+.Xr timer_settime 2
+.Sh STANDARDS
+.St -p1003.1b-93 ,
+.St -p1003.1i-95
diff -r 13eccfaaa19e -r eb5de9688fab lib/libc/sys/timer_settime.2
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libc/sys/timer_settime.2      Sat Sep 13 22:22:29 2003 +0000
@@ -0,0 +1,172 @@
+.\"    $NetBSD: timer_settime.2,v 1.1 2003/09/13 22:22:30 christos Exp $
+.\"
+.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Christos Zoulas.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" 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.
+.\"
+.Dd September 13, 2003
+.Dt TIMER_SETTIME 2
+.Os
+.Sh NAME
+.Nm timer_settime, timer_gettime, timer_getoverrun
+.Nd process timer manipulation
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.In time.h
+.Ft int
+.Fn timer_settime "timer_t timerid" "int flags" "const struct itimerspec *tim" "struct itimerspec *otim"
+.Ft int
+.Fn timer_gettime "timer_t timerid" "struct itimerspec *tim"
+.Ft int 
+.Fn timer_getoverrun "timer_t timerid"
+.Sh DESCRIPTION
+The
+.Fn timer_settime
+sets the next expiration time of the timer who's id is specified by
+.Ar timerid
+to the
+.Fa it_value
+specified in the
Prev by Date: [src/trunk]: src/sys/lkm/vfs/coda5 fix for non-objdir build. reported by tron.
Next by Date: [src/trunk]: src/lib/libc/sys Fix markup.
Previous by Thread: [src/trunk]: src/sys/lkm/vfs/coda5 fix for non-objdir build. reported by tron.
Next by Thread: [src/trunk]: src/lib/libc/sys Fix markup.
Indexes:
Home | Main Index | Thread Index | Old Index