BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / gen / times.3

diff --git a/usr/src/lib/libc/gen/times.3 b/usr/src/lib/libc/gen/times.3
index 0662b11..205b315 100644 (file)
--- a/usr/src/lib/libc/gen/times.3
+++ b/usr/src/lib/libc/gen/times.3
@@ -1,100 +1,136 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" %sccs.include.redist.man%
+.\" 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 University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)times.3     6.3 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.

 .\"
 .\"

-.TH TIMES 3 ""
-.UC 4
-.SH NAME
-times \- process times
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/times.h>
-
-clock_t times(struct tms *tp);
-.ft R
-.fi
-.SH DESCRIPTION
-.ft B
-This interface is obsoleted by getrusage(2) and gettimeofday(3).
-.ft R
-.PP
+.\"     @(#)times.3    6.4 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt TIMES 3
+.Os BSD 4
+.Sh NAME
+.Nm times
+.Nd process times
+.Sh SYNOPSIS
+.Fd #include <sys/times.h>
+.Ft clock_t 
+.Fn times "struct tms *tp"
+.Sh DESCRIPTION
+.Bf -symbolic
+This interface is obsoleted by getrusage(2)
+and gettimeofday(3).
+.Ef
+.Pp

 The
 The

-.I times
-function returns the value of time in CLK_TCK's of a second since
+.Fn times
+function returns the value of time in
+.Dv CLK_TCK Ns 's
+of a second since

 0 hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated Universal
 Time.
 0 hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated Universal
 Time.

-.PP
+.Pp

 It also fills in the structure pointed to by
 It also fills in the structure pointed to by

-.I tp
+.Fa tp

 with time-accounting information.
 with time-accounting information.

-.PP
+.Pp

 The
 The

-.I tms
+.Fa tms

 structure is defined as follows:
 structure is defined as follows:

-.sp
+.Bd -literal -offset indent

 typedef struct {
 typedef struct {

-.RS
-clock_t tms_utime;
-.br
-clock_t tms_stime;
-.br
-clock_t tms_cutime;
-.br
-clock_t tms_cstime;
-.br
-.RE
+       clock_t tms_utime;
+       clock_t tms_stime;
+       clock_t tms_cutime;
+       clock_t tms_cstime;

 }
 }

-.PP
+.Ed
+.Pp

 The elements of this structure are defined as follows:
 The elements of this structure are defined as follows:

-.TP
-tms_utime
-The CPU time charged for the execution of user instructions.
-.TP
-tms_stime
-The CPU time charged for execution by the system on behalf of
+.Bl -tag -width tms_cutime
+.It Fa tms_utime
+The
+.Tn CPU
+time charged for the execution of user instructions.
+.It Fa tms_stime
+The
+.Tn CPU
+time charged for execution by the system on behalf of

 the process.
 the process.

-.TP
-tms_cutime
+.It Fa tms_cutime

 The sum of the
 The sum of the

-.IR tms_utime s
+.Fa tms_utime  s

 and
 and

-.IR tms_cutime s
+.Fa tms_cutime  s

 of the child processes.
 of the child processes.

-.TP
-tms_cstime
+.It Fa tms_cstime

 The sum of the
 The sum of the

-.IR tms_stime s
+.Fa tms_stime Ns s

 and
 and

-.IR tms_cstime s
+.Fa tms_cstime Ns s

 of the child processes.
 of the child processes.

-.PP
-All times are in CLK_TCK's of a second.
-.PP
+.El
+.Pp
+All times are in
+.Dv CLK_TCK Ns 's
+of a second.
+.Pp

 The times of a terminated child process are included in the
 The times of a terminated child process are included in the

-.I tms_cutime
+.Fa tms_cutime

 and
 and

-.I tms_cstime
+.Fa tms_cstime

 elements of the parent when one of the
 elements of the parent when one of the

-.IR wait ()
-functions returns the process ID of the terminated child to the parent
-(see
-.IR wait (2)).
+.Xr wait 2
+functions returns the process ID of the terminated child to the parent.

 If an error occurs,
 If an error occurs,

-.I times
-returns ((clock_t)-1), and sets errno to indicate the error.
-.SH ERRORS
-.I Times
-may fail and set errno for any of the errors specified for the library
+.Fn times
+returns the value
+.Pq (clock_t)\-1 ,
+and sets errno to indicate the error.
+.Sh ERRORS
+The
+.Fn times
+function
+may fail and set the global variable
+.Va errno
+for any of the errors specified for the library

 routines
 routines

-.IR getrusage (2)
+.Xr getrusage 2

 and
 and

-.IR gettimeofday (2).
-.SH "SEE ALSO"
-time(1), getrusage(2), gettimeofday(2), wait(2)
-.SH STANDARDS
-.B Times
-conforms to POSIX Std 1003.1-1988.
+.Xr gettimeofday 2 .
+.Sh SEE ALSO
+.Xr time 1 ,
+.Xr getrusage 2 ,
+.Xr gettimeofday 2 ,
+.Xr wait 2
+.Sh STANDARDS
+The
+.Fn times
+function
+conforms to
+.St -p1003.1-88 .