usr.bin/time/time.1

   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. 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      8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD: src/usr.bin/time/time.1,v 1.13.2.5 2002/12/29 16:35:40 schweikh Exp $
  34 .\" $DragonFly: src/usr.bin/time/time.1,v 1.3 2004/07/16 19:04:57 hmp Exp $
  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 al
  45 .Op Fl h | Fl p
  46 .Op Fl o Ar file
  47 .Ar utility Op Ar argument ...
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility
  52 executes and
  53 times the specified
  54 .Ar utility .
  55 After the
  56 .Ar utility
  57 finishes,
  58 .Nm
  59 writes to the standard error stream,
  60 (in seconds):
  61 the total time elapsed,
  62 the time used to execute the
  63 .Ar utility
  64 process and the time consumed by system overhead.
  65 .Pp
  66 Available options:
  67 .Bl -tag -width Ds
  68 .It Fl a
  69 If the
  70 .Fl o
  71 flag is used, append to the specified file rather than overwriting
  72 it.
  73 Otherwise, this option has no effect.
  74 .It Fl h
  75 Print times in a human friendly format.
  76 Times are printed in minutes, hours,
  77 etc. as appropriate.
  78 .It Fl l
  79 The contents of the
  80 .Em rusage
  81 structure are printed as well.
  82 .It Fl o Ar file
  83 Write the output to
  84 .Ar file
  85 instead of stderr.
  86 If
  87 .Ar file
  88 exists and the
  89 .Fl a
  90 flag is not specified, the file will be overwritten.
  91 .It Fl p
  92 Makes
  93 .Nm
  94 output POSIX.2 compliant (each time is printed on its own line).
  95 .El
  96 .Pp
  97 Some shells may provide a builtin
  98 .Nm
  99 command which is similar or identical to this utility.
 100 Consult the
 101 .Xr builtin 1
 102 manual page.
 103 .Sh DIAGNOSTICS
 104 If
 105 .Ar utility
 106 could be timed successfully, its exit status is returned.
 107 If
 108 .Ar utility
 109 terminated abnormally, a warning message is output to stderr.
 110 If the
 111 .Ar utility
 112 was found but could not be run, the exit status is 126.
 113 If no
 114 .Ar utility
 115 could be found at all, the exit status is 127.
 116 If
 117 .Nm
 118 encounters any other error, the exit status is between 1 and 125
 119 included.
 120 .Sh SEE ALSO
 121 .Xr builtin 1 ,
 122 .Xr csh 1 ,
 123 .Xr getrusage 2 ,
 124 .Xr wait 2
 125 .Sh STANDARDS
 126 The
 127 .Nm
 128 utility is expected to conform to ISO/IEC 9945-2:1993 (``POSIX'').
 129 .Sh HISTORY
 130 A
 131 .Nm
 132 command appeared in
 133 .At v3 .