summaryrefslogtreecommitdiff
path: root/usr/src/man/man3c/clock.3c
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
committerRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
commitc10c16dec587a0662068f6e2991c29ed3a9db943 (patch)
treef414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3c/clock.3c
parent68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff)
downloadillumos-joyent-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com Reviewed by: gwr@nexenta.com Reviewed by: trisk@opensolaris.org Approved by: gwr@nexenta.com --HG-- extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3c/clock.3c')
-rw-r--r--usr/src/man/man3c/clock.3c62
1 files changed, 62 insertions, 0 deletions
diff --git a/usr/src/man/man3c/clock.3c b/usr/src/man/man3c/clock.3c
new file mode 100644
index 0000000000..3eed93c744
--- /dev/null
+++ b/usr/src/man/man3c/clock.3c
@@ -0,0 +1,62 @@
+'\" te
+.\" Copyright 1989 AT&T Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
+.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
+.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
+.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
+.TH clock 3C "24 Jul 2002" "SunOS 5.11" "Standard C Library Functions"
+.SH NAME
+clock \- report CPU time used
+.SH SYNOPSIS
+.LP
+.nf
+#include <time.h>
+
+\fBclock_t\fR \fBclock\fR(\fBvoid\fR);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBclock()\fR function returns the amount of CPU time (in microseconds)
+used since the first call to \fBclock()\fR in the calling process. The time
+reported is the sum of the user and system times of the calling process and its
+terminated child processes for which it has executed the \fBwait\fR(3C)
+function, the \fBpclose\fR(3C) function, or the \fBsystem\fR(3C) function.
+.SH RETURN VALUES
+.sp
+.LP
+Dividing the value returned by \fBclock()\fR by the constant
+\fBCLOCKS_PER_SEC\fR, defined in the <\fBtime.h\fR> header, will give the time
+in seconds. If the process time used is not available or cannot be
+represented, clock returns the value \fB(clock_t) \(mi1\fR.
+.SH USAGE
+.sp
+.LP
+The value returned by \fBclock()\fR is defined in microseconds for
+compatibility with systems that have CPU clocks with much higher resolution.
+Because of this, the value returned will wrap around after accumulating only
+2147 seconds of CPU time (about 36 minutes).
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i)
+lw(2.75i) |lw(2.75i)
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+Interface StabilityStandard
+_
+MT-LevelMT-Safe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBtimes\fR(2), \fBpopen\fR(3C), \fBsystem\fR(3C), \fBwait\fR(3C),
+\fBattributes\fR(5), \fBstandards\fR(5)