[unix-history] / .ref-BSD-4_3_Net_2 / usr / src / usr.bin / time / time.1

.\" Copyright (c) 1980, 1991 Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)time.1	6.4 (Berkeley) 4/23/91
.\"
.Dd April 23, 1991
.Dt TIME 1
.Os BSD 4
.Sh NAME
.Nm time
.Nd time command execution
.Sh SYNOPSIS
.Nm time
.Op Fl l
.Ar command
.Sh DESCRIPTION
The
.Nm time
utility
executes and
times
.Ar command
by initiating a timer and passing the
.Ar command
to the
shell.
After the
.Ar command
finishes,
.Nm time
writes to the standard error stream,
(in seconds): 
the total time elapsed,
time consumed by system overhead,
and the time used to execute the
.Ar command
process.
.Pp
Available options:
.Bl -tag -width Ds
.It Fl l
The contents of the
.Em rusage
structure are printed as well.
.El
.Pp
The
.Xr csh 1
has its own and syntactically different builtin version of
.Nm time.
The command described here
is available as
.Pa /bin/time
to
.Xr csh
users.
.Sh BUGS
The granularity of seconds on micro processors is crude and
can result in times being reported for CPU usage which are too large by
a second.
.Sh SEE ALSO
.Xr csh 1
.Sh FILES
.Bl -tag -width /usr/include/sys/h/resource.h -compact
.It Pa /usr/include/sys/h/resource.h
.El
.Sh HISTORY
A
.Nm
command appeared in
.At v6 .
Commit	Line	Data
66f66453 WJ	1	.\" Copyright (c) 1980, 1991 Regents of the University of California.
	2	.\" 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. All advertising materials mentioning features or use of this software
	13	.\" must display the following acknowledgement:
	14	.\" This product includes software developed by the University of
	15	.\" California, Berkeley and its contributors.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
	32	.\" @(#)time.1 6.4 (Berkeley) 4/23/91
	33	.\"
	34	.Dd April 23, 1991
	35	.Dt TIME 1
	36	.Os BSD 4
	37	.Sh NAME
	38	.Nm time
	39	.Nd time command execution
	40	.Sh SYNOPSIS
	41	.Nm time
	42	.Op Fl l
	43	.Ar command
	44	.Sh DESCRIPTION
	45	The
	46	.Nm time
	47	utility
	48	executes and
	49	times
	50	.Ar command
	51	by initiating a timer and passing the
	52	.Ar command
	53	to the
	54	shell.
	55	After the
	56	.Ar command
	57	finishes,
	58	.Nm time
	59	writes to the standard error stream,
	60	(in seconds):
	61	the total time elapsed,
	62	time consumed by system overhead,
	63	and the time used to execute the
	64	.Ar command
65	process.
66	.Pp
67	Available options:
68	.Bl -tag -width Ds
69	.It Fl l
70	The contents of the
71	.Em rusage
72	structure are printed as well.
73	.El
74	.Pp
75	The
76	.Xr csh 1
77	has its own and syntactically different builtin version of
78	.Nm time.
79	The command described here
80	is available as
81	.Pa /bin/time
82	to
83	.Xr csh
84	users.
85	.Sh BUGS
86	The granularity of seconds on micro processors is crude and
87	can result in times being reported for CPU usage which are too large by
88	a second.
89	.Sh SEE ALSO
90	.Xr csh 1
91	.Sh FILES
92	.Bl -tag -width /usr/include/sys/h/resource.h -compact
93	.It Pa /usr/include/sys/h/resource.h
94	.El
95	.Sh HISTORY
96	A
97	.Nm
98	command appeared in
99	.At v6 .