Release calc version 2.12.1.6

help/runtime

@@ -1,5 +1,5 @@
 NAME
-    runtime - user runtime
+    runtime - CPU time used by the current process in both user and kernel modes
 
 SYNOPSIS
     runtime()
@@ -8,27 +8,33 @@ TYPES
     return	nonnegative real
 
 DESCRIPTION
-    Returns the current user mode cpu runtime in seconds.
+    In POSIX based systems, this function will return the CPU seconds
+    used by the current process in both user and kernel mode.  Time
+    spent in the kernel executing system calls and time spend executing
+    user code (such as performing computation on behalf of calc) are
+    both included.
+
+    On non-POSIX based systems, this function will always return 0.
+    In particular, most MS windows based systems do not have the required
+    POSIX system call and so this function will always return 0.
 
 EXAMPLE
-
-    The result for this example will depend on the speed and number of
-    of clock-ticks per second for the computer being used.  The result
-    is a multiple of 1/CLK_TCK, where CLK_TCK is usually 60, 100, or 1000.
+    The result for this example will depend on the speed of the CPU
+    and precision of the operating CPU time accounting sub-system:
 
     ; t = runtime();
-    ; pi = pi(1e-1000);
+    ; x = ptest(2^4253-1);
     ; runtime() - t;
-	.2
+	1.288804
 
 LIMITS
-    none
+    On non-POSIX based systems, this function always returns 0.
 
 LINK LIBRARY
     none
 
 SEE ALSO
-    ctime, time
+    config, ctime, systime, time, usertime
 
 ## Copyright (C) 1999-2006  Landon Curt Noll
 ##
@@ -46,8 +52,8 @@ SEE ALSO
 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
 ## 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
 ##
-## @(#) $Revision: 29.5 $
-## @(#) $Id: runtime,v 29.5 2006/06/25 22:16:55 chongo Exp $
+## @(#) $Revision: 29.7 $
+## @(#) $Id: runtime,v 29.7 2006/12/16 10:52:27 chongo Exp $
 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/runtime,v $
 ##
 ## Under source code control:	1996/03/12 23:10:01