From 72a62ad88f82fe1ffee50024db4dd0f3fa5806f7 Mon Sep 17 00:00:00 2001
From: Chris Johns <chrisj@rtems.org>
Date: Thu, 3 Nov 2016 16:58:08 +1100
Subject: Rename all manuals with an _ to have a -. It helps released naming of
 files.

---
 posix-users/timer.rst | 165 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 165 insertions(+)
 create mode 100644 posix-users/timer.rst

(limited to 'posix-users/timer.rst')

diff --git a/posix-users/timer.rst b/posix-users/timer.rst
new file mode 100644
index 0000000..f5be6c8
--- /dev/null
+++ b/posix-users/timer.rst
@@ -0,0 +1,165 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. COMMENT: COPYRIGHT(c) 1988-2002.
+.. COMMENT: On-Line Applications Research Corporation(OAR).
+.. COMMENT: All rights reserved.
+
+Timer Manager
+#############
+
+Introduction
+============
+
+The timer manager is ...
+
+The services provided by the timer manager are:
+
+- timer_create_ - Create a Per-Process Timer
+
+- timer_delete_ - Delete a Per-Process Timer
+
+- timer_settime_ - Set Next Timer Expiration
+
+- timer_gettime_ - Get Time Remaining on Timer
+
+- timer_getoverrun_ - Get Timer Overrun Count
+
+Background
+==========
+
+Operations
+==========
+
+System Calls
+============
+
+This section details the timer manager's services.  A subsection is dedicated
+to each of this manager's services and describes the calling sequence, related
+constants, usage, and status codes.
+
+.. COMMENT: timer_create
+
+.. _timer_create:
+
+timer_create - Create a Per-Process Timer
+-----------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+    #include <time.h>
+    #include <signal.h>
+    int timer_create(
+        clockid_t        clock_id,
+        struct sigevent *evp,
+        timer_t         *timerid
+    );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+.. COMMENT: timer_delete
+
+.. _timer_delete:
+
+timer_delete - Delete a Per-Process Timer
+-----------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+    #include <time.h>
+    int timer_delete(
+        timer_t timerid
+    );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+.. COMMENT: timer_settime
+
+.. _timer_settime:
+
+timer_settime - Set Next Timer Expiration
+-----------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+    #include <time.h>
+    int timer_settime(
+        timer_t                  timerid,
+        int                      flags,
+        const struct itimerspec *value,
+        struct itimerspec       *ovalue
+    );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+.. COMMENT: timer_gettime
+
+.. _timer_gettime:
+
+timer_gettime - Get Time Remaining on Timer
+-------------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+    #include <time.h>
+    int timer_gettime(
+        timer_t            timerid,
+        struct itimerspec *value
+    );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+.. COMMENT: timer_getoverrun
+
+.. _timer_getoverrun:
+
+timer_getoverrun - Get Timer Overrun Count
+------------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+    #include <time.h>
+    int timer_getoverrun(
+        timer_t   timerid
+    );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**
-- 
cgit v1.2.3