Changeset f1ccfde in rtems


Ignore:
Timestamp:
Sep 29, 1998, 9:51:08 PM (21 years ago)
Author:
Wade A Smith <warm38@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
80189ac2
Parents:
21bfd93
Message:

Made cosmetic changes to the file and documented the time, times, and
getimeofday routines.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/new_chapters/clock.t

    r21bfd93 rf1ccfde  
    2121@item @code{sleep} - Delay Process Execution
    2222@item @code{nanosleep} -
    23 @item @code{gettimeofday} -
    24 @item @code{time} -
     23@item @code{gettimeofday} - Get the Time of Day
     24@item @code{time} - Get time in seconds
     25@item @code{times} - Get process times
    2526@end itemize
    2627
     
    204205
    205206@page
    206 @subsection gettimeofday -
     207@subsection gettimeofday - Get the Time of Day
    207208
    208209@subheading CALLING SEQUENCE:
     
    220221@subheading STATUS CODES:
    221222
    222 On error, this routine returns -1 and sets errno as appropriate.
    223 
    224 @subheading DESCRIPTION:
    225 
    226 @subheading NOTES:
    227 
    228 Currently, the timezone information is not supported.
    229 
    230 @page
    231 @subsection time -
     223On error, this routine returns -1 and sets @code{errno} as appropriate.
     224
     225@table @b
     226@item EPERM
     227@code{settimeofdat} is called by someone other than the superuser.
     228
     229@item EINVAL
     230Timezone (or something else) is invalid.
     231
     232@item EFAULT
     233One of @code{tv} or @code{tz} pointed outside your accessible address
     234space
     235
     236@end table
     237
     238@subheading DESCRIPTION:
     239
     240This routine returns the current time of day in the @code{tp} structure.
     241
     242@subheading NOTES:
     243
     244Currently, the timezone information is not supported.  The @code{tzp}
     245argument is ignored.
     246
     247@page
     248@subsection time - Get time in seconds
    232249 
    233250@subheading CALLING SEQUENCE:
     
    246263
    247264@subheading DESCRIPTION:
     265
     266@code{time} returns the time since 00:00:00 GMT, January 1, 1970,
     267measured in seconds
     268
     269If @code{tloc} in non null, the return value is also stored in the
     270memory pointed to by @code{t}.
    248271 
    249272@subheading NOTES:
     
    251274NONE
    252275 
     276@page
     277@subsection times - Get process times
     278 
     279@subheading CALLING SEQUENCE:
     280 
     281@example
     282#include <sys/time.h>
     283 
     284int time(
     285  clock_t times(struct tms *buf
     286);
     287@end example
     288 
     289@subheading STATUS CODES:
     290
     291This routine returns the process times
     292
     293@subheading DESCRIPTION:
     294
     295@code{times} stores the current process times in @code{buf}.
     296
     297@code{struct tms} is as defined in @code{/usr/include/sys/times.h}:
     298
     299struct  tms  {
     300             clock_t tms_utime;  /* user time */
     301             clock_t tms_stime;  /* system time */
     302             clock_t tms_cutime; /* user time of children */
     303             clock_t tms_cstime; /* system time of children */
     304             };
     305
     306@code{times} returns the number of clock ticks that have elapsed
     307since the systm has been up.
     308 
     309@subheading NOTES:
     310
     311NONE
     312 
Note: See TracChangeset for help on using the changeset viewer.