share/man/man1/time.1

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 1995, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH TIME 1 "Feb 1, 1995"
  11 .SH NAME
  12 time \- time a simple command
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBtime\fR [\fB-p\fR] \fIutility\fR [\fIargument\fR]...
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBtime\fR utility invokes \fIutility\fR operand with \fIargument\fR, and
  23 writes a message to standard error that lists timing statistics for
  24 \fIutility\fR. The message includes the following information:
  25 .RS +4
  26 .TP
  27 .ie t \(bu
  28 .el o
  29 The elapsed (real) time between invocation of \fIutility\fR and its
  30 termination.
  31 .RE
  32 .RS +4
  33 .TP
  34 .ie t \(bu
  35 .el o
  36 The User \fBCPU\fR time, equivalent to the sum of the \fItms_utime\fR and
  37 \fItms_cutime\fR fields returned by the \fBtimes\fR(2) function for the process
  38 in which \fIutility\fR is executed.
  39 .RE
  40 .RS +4
  41 .TP
  42 .ie t \(bu
  43 .el o
  44 The System \fBCPU\fR time, equivalent to the sum of the \fItms_stime\fR and
  45 \fItms_cstime\fR fields returned by the \fBtimes()\fR function for the process
  46 in which \fIutility\fR is executed.
  47 .RE
  48 .sp
  49 .LP
  50 When \fBtime\fR is used as part of a pipeline, the times reported are
  51 unspecified, except when it is the sole command within a grouping command in
  52 that pipeline. For example, the commands on the left are unspecified; those on
  53 the right report on utilities \fBa\fR and \fBc\fR, respectively:
  54 .sp
  55 .in +2
  56 .nf
  57 time a | b | c          { time a } | b | c
  58 a | b | time c          a | b | (time c)
  59 .fi
  60 .in -2
  61
  62 .SH OPTIONS
  63 .sp
  64 .LP
  65 The following option is supported:
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-p\fR \fR
  70 .ad
  71 .RS 7n
  72 Writes the timing output to standard error in the following format:
  73 .sp
  74 .in +2
  75 .nf
  76 real %f\enuser %f\ensys %f\en < \fIreal seconds\fR>, <\fIuser seconds\fR>,
  77 <\fIsystem seconds\fR>
  78 .fi
  79 .in -2
  80 .sp
  81
  82 .RE
  83
  84 .SH OPERANDS
  85 .sp
  86 .LP
  87 The following operands are supported:
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fIutility\fR \fR
  92 .ad
  93 .RS 13n
  94 The name of the utility that is to be invoked.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fIargument\fR \fR
 101 .ad
 102 .RS 13n
 103 Any string to be supplied as an argument when invoking \fIutility\fR.
 104 .RE
 105
 106 .SH USAGE
 107 .sp
 108 .LP
 109 The \fBtime\fR utility returns exit status \fB127\fR if an error occurs so that
 110 applications can distinguish "failure to find a utility" from "invoked utility
 111 exited with an error indication." The value \fB127\fR was chosen because it is
 112 not commonly used for other meanings. Most utilities use small values for
 113 "normal error conditions" and the values above \fB128\fR can be confused with
 114 termination due to receipt of a signal. The value \fB126\fR was chosen in a
 115 similar manner to indicate that the utility could be found, but not invoked.
 116 .SH EXAMPLES
 117 .LP
 118 \fBExample 1 \fRUsing the time command
 119 .sp
 120 .LP
 121 It is frequently desirable to apply \fBtime\fR to pipelines or lists of
 122 commands. This can be done by placing pipelines and command lists in a single
 123 file. This single file can then be invoked as a utility, and the \fBtime\fR
 124 applies to everything in the file.
 125
 126 .sp
 127 .LP
 128 Alternatively, the following command can be used to apply \fBtime\fR to a
 129 complex command:
 130
 131 .sp
 132 .in +2
 133 .nf
 134 example% \fBtime sh -c 'complex-command-line'\fR
 135 .fi
 136 .in -2
 137 .sp
 138
 139 .LP
 140 \fBExample 2 \fRUsing time in the csh shell
 141 .sp
 142 .LP
 143 The following two examples show the differences between the \fBcsh\fR version
 144 of \fBtime\fR and the version in \fB/usr/bin/time\fR. These examples assume
 145 that \fBcsh\fR is the shell in use.
 146
 147 .sp
 148 .in +2
 149 .nf
 150 example% \fBtime find / -name csh.1 -print
 151 /usr/share/man/man1/csh.1\fR
 152 95.0u 692.0s 1:17:52 16% 0+0k 0+0io 0pf+0w
 153 .fi
 154 .in -2
 155 .sp
 156
 157 .sp
 158 .LP
 159 See \fBcsh\fR(1) for an explanation of the format of \fBtime\fR output.
 160
 161 .sp
 162 .in +2
 163 .nf
 164 example% \fB/usr/bin/time find / -name csh.1 -print
 165 /usr/share/man/man1/csh.1\fR
 166 real  1:23:31.5
 167 user     1:33.2
 168 sys     11:28.2
 169 .fi
 170 .in -2
 171 .sp
 172
 173 .SH ENVIRONMENT VARIABLES
 174 .sp
 175 .LP
 176 See \fBenviron\fR(5) for descriptions of the following environment variables
 177 that affect the execution of \fBtime\fR: \fBLANG\fR, \fBLC_ALL\fR,
 178 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBLC_NUMERIC\fR,  \fBNLSPATH\fR, and
 179 \fBPATH\fR.
 180 .SH EXIT STATUS
 181 .sp
 182 .LP
 183 If \fIutility\fR is invoked, the exit status of \fBtime\fR will be the exit
 184 status of \fIutility\fR. Otherwise, the \fBtime\fR utility will exit with one
 185 of the following values:
 186 .sp
 187 .ne 2
 188 .na
 189 \fB\fB1\(mi125\fR \fR
 190 .ad
 191 .RS 13n
 192 An error occurred in the \fBtime\fR utility.
 193 .RE
 194
 195 .sp
 196 .ne 2
 197 .na
 198 \fB\fB126\fR \fR
 199 .ad
 200 .RS 13n
 201 \fIutility\fR was found but could not be invoked.
 202 .RE
 203
 204 .sp
 205 .ne 2
 206 .na
 207 \fB\fB127\fR \fR
 208 .ad
 209 .RS 13n
 210 \fIutility\fR could not be found.
 211 .RE
 212
 213 .SH ATTRIBUTES
 214 .sp
 215 .LP
 216 See \fBattributes\fR(5) for descriptions of the following attributes:
 217 .sp
 218
 219 .sp
 220 .TS
 221 box;
 222 c | c
 223 l | l .
 224 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 225 _
 226 Interface Stability     Standard
 227 .TE
 228
 229 .SH SEE ALSO
 230 .sp
 231 .LP
 232 \fBcsh\fR(1), \fBshell_builtins\fR(1), \fBtimex\fR(1), \fBtimes\fR(2),
 233 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
 234 .SH NOTES
 235 .sp
 236 .LP
 237 When the time command is run on a multiprocessor machine, the total of the
 238 values printed for \fBuser\fR and \fBsys\fR can exceed \fBreal\fR. This is
 239 because on a multiprocessor machine it is possible to divide the task between
 240 the various processors.
 241 .sp
 242 .LP
 243 When the command being timed is interrupted, the timing values displayed may
 244 not always be accurate.
 245 .SH BUGS
 246 .sp
 247 .LP
 248 Elapsed time is accurate to the second, while the \fBCPU\fR times are measured
 249 to the 100th second. Thus the sum of the \fBCPU\fR times can be up to a second
 250 larger than the elapsed time.