Annotation of src/usr.bin/time/time.1, Revision 1.12
1.12 ! millert 1: .\" $OpenBSD: time.1,v 1.11 2002/01/24 20:33:46 mickey Exp $
1.1 deraadt 2: .\" $NetBSD: time.1,v 1.5 1994/12/08 09:36:57 jtc Exp $
3: .\"
4: .\" Copyright (c) 1980, 1991, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
1.12 ! millert 15: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 16: .\" may be used to endorse or promote products derived from this software
17: .\" without specific prior written permission.
18: .\"
19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29: .\" SUCH DAMAGE.
30: .\"
31: .\" @(#)time.1 8.1 (Berkeley) 6/6/93
32: .\"
33: .Dd June 6, 1993
34: .Dt TIME 1
35: .Os
36: .Sh NAME
37: .Nm time
38: .Nd time command execution
39: .Sh SYNOPSIS
40: .Nm time
41: .Op Fl lp
42: .Ar utility
43: .Sh DESCRIPTION
1.7 aaron 44: .Nm
1.1 deraadt 45: executes and
46: times
47: .Ar utility .
48: After the
49: .Ar utility
50: finishes,
1.7 aaron 51: .Nm
1.1 deraadt 52: writes the total time elapsed,
53: the time consumed by system overhead,
1.7 aaron 54: and the time used to execute
55: .Ar utility
1.1 deraadt 56: to the standard error stream.
57: Times are reported in seconds.
58: .Pp
1.8 aaron 59: The options are as follows:
1.1 deraadt 60: .Bl -tag -width Ds
61: .It Fl l
62: The contents of the
63: .Em rusage
64: structure are printed.
65: .It Fl p
66: The output is formatted as specified by
67: .St -p1003.2-92 .
68: .El
69: .Pp
70: .Xr csh 1
1.5 aaron 71: has its own and syntactically different built-in version of
1.6 aaron 72: .Nm time .
1.1 deraadt 73: The utility described here
74: is available as
75: .Pa /usr/bin/time
76: to
77: .Xr csh
78: users.
1.10 aaron 79: .Pp
1.1 deraadt 80: The
1.7 aaron 81: .Nm
1.1 deraadt 82: utility shall exit with one of the following values:
1.10 aaron 83: .Pp
84: .Bl -tag -width indent -compact
1.7 aaron 85: .It 1\-125
86: An error occurred in the
87: .Nm
1.1 deraadt 88: utility.
89: .It 126
1.7 aaron 90: The
1.1 deraadt 91: .Ar utility
92: was found but could not be invoked.
93: .It 127
1.7 aaron 94: The
1.1 deraadt 95: .Ar utility
96: could not be found.
97: .El
98: .Pp
1.7 aaron 99: Otherwise, the exit status of
100: .Nm
101: shall be that of
1.1 deraadt 102: .Ar utility .
103: .Sh FILES
1.3 deraadt 104: .Bl -tag -width /usr/include/sys/resource.h -compact
105: .It Pa /usr/include/sys/resource.h
1.1 deraadt 106: .El
1.9 aaron 107: .Sh SEE ALSO
108: .Xr csh 1 ,
109: .Xr getrusage 2
1.1 deraadt 110: .Sh STANDARDS
111: The
112: .Nm
1.7 aaron 113: utility conforms to
1.1 deraadt 114: .St -p1003.2-92 .
1.9 aaron 115: .Sh HISTORY
116: A
117: .Nm
118: command appeared in
1.11 mickey 119: .At v3 .
1.1 deraadt 120: .Sh BUGS
121: The granularity of seconds on microprocessors is crude and
122: can result in times being reported for CPU usage which are too large by
123: a second.