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