xref: /dragonfly/usr.bin/time/time.1 (revision d4ef6694)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)time.1	8.1 (Berkeley) 6/6/93
29.\" $FreeBSD: src/usr.bin/time/time.1,v 1.13.2.5 2002/12/29 16:35:40 schweikh Exp $
30.\" $DragonFly: src/usr.bin/time/time.1,v 1.3 2004/07/16 19:04:57 hmp Exp $
31.\"
32.Dd June 6, 1993
33.Dt TIME 1
34.Os
35.Sh NAME
36.Nm time
37.Nd time command execution
38.Sh SYNOPSIS
39.Nm
40.Op Fl al
41.Op Fl h | Fl p
42.Op Fl o Ar file
43.Ar utility Op Ar argument ...
44.Sh DESCRIPTION
45The
46.Nm
47utility
48executes and
49times the specified
50.Ar utility .
51After the
52.Ar utility
53finishes,
54.Nm
55writes to the standard error stream,
56(in seconds):
57the total time elapsed,
58the time used to execute the
59.Ar utility
60process and the time consumed by system overhead.
61.Pp
62Available options:
63.Bl -tag -width Ds
64.It Fl a
65If the
66.Fl o
67flag is used, append to the specified file rather than overwriting
68it.
69Otherwise, this option has no effect.
70.It Fl h
71Print times in a human friendly format.
72Times are printed in minutes, hours,
73etc. as appropriate.
74.It Fl l
75The contents of the
76.Em rusage
77structure are printed as well.
78.It Fl o Ar file
79Write the output to
80.Ar file
81instead of stderr.
82If
83.Ar file
84exists and the
85.Fl a
86flag is not specified, the file will be overwritten.
87.It Fl p
88Makes
89.Nm
90output POSIX.2 compliant (each time is printed on its own line).
91.El
92.Pp
93Some shells may provide a builtin
94.Nm
95command which is similar or identical to this utility.
96Consult the
97.Xr builtin 1
98manual page.
99.Sh DIAGNOSTICS
100If
101.Ar utility
102could be timed successfully, its exit status is returned.
103If
104.Ar utility
105terminated abnormally, a warning message is output to stderr.
106If the
107.Ar utility
108was found but could not be run, the exit status is 126.
109If no
110.Ar utility
111could be found at all, the exit status is 127.
112If
113.Nm
114encounters any other error, the exit status is between 1 and 125
115included.
116.Sh SEE ALSO
117.Xr builtin 1 ,
118.Xr csh 1 ,
119.Xr getrusage 2 ,
120.Xr wait 2
121.Sh STANDARDS
122The
123.Nm
124utility is expected to conform to ISO/IEC 9945-2:1993 (``POSIX'').
125.Sh HISTORY
126A
127.Nm
128command appeared in
129.At v3 .
130