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$
  34 .\"
  35 .Dd June 6, 1993
  36 .Dt TIME 1
  37 .Os
  38 .Sh NAME
  39 .Nm time
  40 .Nd time command execution
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl al
  44 .Op Fl h | Fl p
  45 .Op Fl o Ar file
  46 .Ar utility Op Ar argument ...
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility
  51 executes and
  52 times the specified
  53 .Ar utility .
  54 After the
  55 .Ar utility
  56 finishes,
  57 .Nm
  58 writes to the standard error stream,
  59 (in seconds):
  60 the total time elapsed,
  61 the time used to execute the
  62 .Ar utility
  63 process and the time consumed by system overhead.
  64 .Pp
  65 The following options are available:
  66 .Bl -tag -width indent
  67 .It Fl a
  68 If the
  69 .Fl o
  70 flag is used, append to the specified file rather than overwriting
  71 it.
  72 Otherwise, this option has no effect.
  73 .It Fl h
  74 Print times in a human friendly format.
  75 Times are printed in minutes, hours,
  76 etc.\& as appropriate.
  77 .It Fl l
  78 The contents of the
  79 .Em rusage
  80 structure are printed as well.
  81 .It Fl o Ar file
  82 Write the output to
  83 .Ar file
  84 instead of stderr.
  85 If
  86 .Ar file
  87 exists and the
  88 .Fl a
  89 flag is not specified, the file will be overwritten.
  90 .It Fl p
  91 Makes
  92 .Nm
  93 output POSIX.2 compliant (each time is printed on its own line).
  94 .El
  95 .Pp
  96 Some shells may provide a builtin
  97 .Nm
  98 command which is similar or identical to this utility.
  99 Consult the
 100 .Xr builtin 1
 101 manual page.
 102 .Sh ENVIRONMENT
 103 The
 104 .Ev PATH
 105 environment variable is used to locate the requested
 106 .Ar utility
 107 if the name contains no
 108 .Ql /
 109 characters.
 110 .Sh EXIT STATUS
 111 If
 112 .Ar utility
 113 could be timed successfully, its exit status is returned.
 114 If
 115 .Ar utility
 116 terminated abnormally, a warning message is output to stderr.
 117 If the
 118 .Ar utility
 119 was found but could not be run, the exit status is 126.
 120 If no
 121 .Ar utility
 122 could be found at all, the exit status is 127.
 123 If
 124 .Nm
 125 encounters any other error, the exit status is between 1 and 125
 126 included.
 127 .Sh SEE ALSO
 128 .Xr builtin 1 ,
 129 .Xr csh 1 ,
 130 .Xr getrusage 2 ,
 131 .Xr wait 2
 132 .Sh STANDARDS
 133 The
 134 .Nm
 135 utility is expected to conform to ISO/IEC 9945-2:1993 (``POSIX'').
 136 .Sh HISTORY
 137 A
 138 .Nm
 139 utility appeared in
 140 .At v3 .