BSD 4_4 release
[unix-history] / usr / src / lib / libc / gen / clock.3
CommitLineData
74155b62
KB
1.\" Copyright (c) 1990, 1991, 1993
2.\" The Regents of the University of California. All rights reserved.
936cff82 3.\"
043368e6
KB
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
936cff82 7.\"
c0567266
KB
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in the
15.\" documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\" must display the following acknowledgement:
18.\" This product includes software developed by the University of
19.\" California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\" may be used to endorse or promote products derived from this software
22.\" without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
936cff82 35.\"
ad787160
C
36.\" @(#)clock.3 8.1 (Berkeley) 6/4/93
37.\"
38.Dd June 4, 1993
ae59e04c
CL
39.Dt CLOCK 3
40.Os
41.Sh NAME
42.Nm clock
43.Nd determine processor time used
44.Sh SYNOPSIS
45.Fd #include <sys/types.h>
46.Ft clock_t
47.Fn clock void
48.Sh DESCRIPTION
49The
50.Fn clock
51function
52determines the amount of processor time used since the invocation of the
53calling process, measured in
54.Dv CLK_TCK Ns s.
55.Sh RETURN VALUES
56The
57.Fn clock
58function returns the amount of time used unless an error occurs, in which
59case the return value is \-1.
60.Sh SEE ALSO
61.Xr getrusage 2
62.Sh STANDARDS
63The
64.Fn clock
65function conforms to
66.St -ansiC .