xref: /openbsd/usr.bin/time/time.1 (revision cca36db2)
1.\"	$OpenBSD: time.1,v 1.20 2010/09/29 07:44:56 jmc Exp $
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.
15.\" 3. Neither the name of the University nor the names of its contributors
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 $Mdocdate: September 29 2010 $
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.Op Ar argument ...
44.Sh DESCRIPTION
45.Nm
46executes and times
47.Ar utility
48with optional
49.Ar arguments .
50After the
51.Ar utility
52finishes,
53.Nm
54writes the total time elapsed,
55the time consumed by system overhead,
56and the time used to execute
57.Ar utility
58to the standard error stream.
59Times are reported in seconds.
60.Pp
61The options are as follows:
62.Bl -tag -width Ds
63.It Fl l
64The contents of the
65.Em rusage
66structure are printed.
67.It Fl p
68The output is formatted as specified by
69.St -p1003.2-92 .
70.El
71.Sh FILES
72.Bl -tag -width /usr/include/sys/resource.h -compact
73.It Pa /usr/include/sys/resource.h
74.El
75.Sh EXIT STATUS
76The
77.Nm
78utility exits with one of the following values:
79.Pp
80.Bl -tag -width indent -compact
81.It 1\-125
82An error occurred in the
83.Nm
84utility.
85.It 126
86The
87.Ar utility
88was found but could not be invoked.
89.It 127
90The
91.Ar utility
92could not be found.
93.El
94.Pp
95Otherwise, the exit status of
96.Nm
97shall be that of
98.Ar utility .
99.Sh SEE ALSO
100.Xr csh 1 ,
101.Xr ksh 1 ,
102.Xr getrusage 2
103.Sh STANDARDS
104The
105.Nm
106utility is compliant with the
107.St -p1003.1-2008
108specification.
109.Pp
110The flag
111.Op Fl l
112is an extension to that specification.
113.Pp
114.Nm
115also exists as a built-in to
116.Xr csh 1
117and
118.Xr ksh 1 ,
119though with a different syntax.
120.Sh HISTORY
121A
122.Nm
123command appeared in
124.At v3 .
125.Sh BUGS
126The granularity of seconds on microprocessors is crude and
127can result in times being reported for CPU usage which are too large by
128a second.
129