summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2013/man3p/clock.3p
diff options
context:
space:
mode:
Diffstat (limited to 'man-pages-posix-2013/man3p/clock.3p')
-rw-r--r--man-pages-posix-2013/man3p/clock.3p95
1 files changed, 95 insertions, 0 deletions
diff --git a/man-pages-posix-2013/man3p/clock.3p b/man-pages-posix-2013/man3p/clock.3p
new file mode 100644
index 0000000..8e5853c
--- /dev/null
+++ b/man-pages-posix-2013/man3p/clock.3p
@@ -0,0 +1,95 @@
+'\" et
+.TH CLOCK "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.SH PROLOG
+This manual page is part of the POSIX Programmer's Manual.
+The Linux implementation of this interface may differ (consult
+the corresponding Linux manual page for details of Linux behavior),
+or the interface may not be implemented on Linux.
+
+.SH NAME
+clock
+\(em report CPU time used
+.SH SYNOPSIS
+.LP
+.nf
+#include <time.h>
+.P
+clock_t clock(void);
+.fi
+.SH DESCRIPTION
+The functionality described on this reference page is aligned with the
+ISO\ C standard. Any conflict between the requirements described here and the
+ISO\ C standard is unintentional. This volume of POSIX.1\(hy2008 defers to the ISO\ C standard.
+.P
+The
+\fIclock\fR()
+function shall return the implementation's best approximation to the
+processor time used by the process since the beginning of an
+implementation-defined era related only to the process invocation.
+.SH "RETURN VALUE"
+To determine the time in seconds, the value returned by
+\fIclock\fR()
+should be divided by the value of the macro CLOCKS_PER_SEC.
+CLOCKS_PER_SEC is defined to be one million in
+.IR <time.h> .
+If the processor time used is not available or its value cannot be
+represented, the function shall return the value (\c
+.BR clock_t )\(mi1.
+.SH ERRORS
+No errors are defined.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+In order to measure the time spent in a program,
+\fIclock\fR()
+should be called at the start of the program and its return value
+subtracted from the value returned by subsequent calls. The value
+returned by
+\fIclock\fR()
+is defined for compatibility across systems that have clocks with
+different resolutions. The resolution on any particular system need
+not be to microsecond accuracy.
+.P
+The value returned by
+\fIclock\fR()
+may wrap around on some implementations. For example, on a machine with
+32-bit values for
+.BR clock_t ,
+it wraps after 2\|147 seconds or 36 minutes.
+.SH RATIONALE
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIasctime\fR\^(\|)",
+.IR "\fIctime\fR\^(\|)",
+.IR "\fIdifftime\fR\^(\|)",
+.IR "\fIgmtime\fR\^(\|)",
+.IR "\fIlocaltime\fR\^(\|)",
+.IR "\fImktime\fR\^(\|)",
+.IR "\fIstrftime\fR\^(\|)",
+.IR "\fIstrptime\fR\^(\|)",
+.IR "\fItime\fR\^(\|)",
+.IR "\fIutime\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2008,
+.IR "\fB<time.h>\fP"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, Copyright (C) 2013 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
+event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.unix.org/online.html .
+
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .