summaryrefslogtreecommitdiffstats
path: root/doc/user/clock.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1999-10-11 19:03:05 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1999-10-11 19:03:05 +0000
commit169502ea55d2c1d9ec9c2865c6302485bbaafc31 (patch)
tree5b253aae0732d83751d8ad94d21dd36e398fb86b /doc/user/clock.t
parentFixed variable reference for RTEMS-RELEASE. (diff)
downloadrtems-169502ea55d2c1d9ec9c2865c6302485bbaafc31.tar.bz2
Turned on concept and function name indexing.
Diffstat (limited to 'doc/user/clock.t')
-rw-r--r--doc/user/clock.t23
1 files changed, 20 insertions, 3 deletions
diff --git a/doc/user/clock.t b/doc/user/clock.t
index 3153adb878..0fafbef47b 100644
--- a/doc/user/clock.t
+++ b/doc/user/clock.t
@@ -8,6 +8,8 @@
@chapter Clock Manager
+@cindex clock
+
@section Introduction
The clock manager provides support for time of day
@@ -218,13 +220,18 @@ A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
+@c
+@c
+@c
@page
@subsection CLOCK_SET - Set system date and time
@subheading CALLING SEQUENCE:
+@cindex set the time of day
+
@ifset is-C
-@c @findex rtems_clock_set
+@findex rtems_clock_set
@example
rtems_status_code rtems_clock_set(
rtems_time_of_day *time_buffer
@@ -269,13 +276,18 @@ to be reset to an uninitialized state. Another call to
@code{@value{DIRPREFIX}clock_set} is required to re-initialize
the system date and time to application specific specifications.
+@c
+@c
+@c
@page
@subsection CLOCK_GET - Get system date and time information
+@cindex obtain the time of day
+
@subheading CALLING SEQUENCE:
@ifset is-C
-@c @findex rtems_clock_get
+@findex rtems_clock_get
@example
rtems_status_code rtems_clock_get(
rtems_clock_get_options option,
@@ -360,13 +372,18 @@ time to be reset to an uninitialized state. Another call to
@code{@value{DIRPREFIX}clock_set} is required to re-initialize the
system date and time to application specific specifications.
+@c
+@c
+@c
@page
@subsection CLOCK_TICK - Announce a clock tick
+@cindex clock tick
+
@subheading CALLING SEQUENCE:
@ifset is-C
-@c @findex rtems_clock_tick
+@findex rtems_clock_tick
@example
rtems_status_code rtems_clock_tick( void );
@end example