d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ec82884e87
freebsd-dev/usr.bin/time/time.1

146 lines
3.7 KiB
Groff
Raw Normal View History

BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.\" Copyright (c) 1980, 1991, 1993
.\" The 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.
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
.\" 3. Neither the name of the University nor the names of its contributors
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.\" 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 8.1 (Berkeley) 6/6/93
$Id$ -> $FreeBSD$
1999-08-28 01:08:13 +00:00
.\" $FreeBSD$
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.\"
Markup fixes.
2006-09-29 15:20:48 +00:00
.Dd May 14, 2006
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Dt TIME 1
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 14:16:33 +00:00
.Os
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Sh NAME
.Nm time
.Nd time command execution
.Sh SYNOPSIS
Add usage() and use err(3).
1997-08-14 06:48:59 +00:00
.Nm
Add a new "-h" Human-friendly h/m/s output format. Reviewed by: bde
2000-10-28 21:48:53 +00:00
.Op Fl al
.Op Fl h | Fl p
Behave like GNU time. More cleanup. Reword man page. Pointed out by: Bruce Evans
1998-07-27 16:54:05 +00:00
.Op Fl o Ar file
Make it obvious that command line arguments may be specified for the utility that is to be invoked on the command line. Use "utility" instead of "command" in manual page and usage message for consistency with POSIX.
2002-06-20 07:07:00 +00:00
.Ar utility Op Ar argument ...
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Sh DESCRIPTION
The
Add usage() and use err(3).
1997-08-14 06:48:59 +00:00
.Nm
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
utility
executes and
time(1) does not use the shell to execute the specified utility, remove sentence stating it did.
2002-06-20 07:12:34 +00:00
times the specified
.Ar utility .
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
After the
Make it obvious that command line arguments may be specified for the utility that is to be invoked on the command line. Use "utility" instead of "command" in manual page and usage message for consistency with POSIX.
2002-06-20 07:07:00 +00:00
.Ar utility
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
finishes,
Add usage() and use err(3).
1997-08-14 06:48:59 +00:00
.Nm
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
writes to the standard error stream,
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
(in seconds):
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
the total time elapsed,
Adds the '-p' option to make time(1) output POSIX.2 compliant. Updates the manpage as well. I've rewritten the patch as it was for 2.2.7. It can probably be put into 3.1-STABLE as well. PR: bin/10515 Submitted by: Jens Schweikhardt <schweikh@noc.dfn.de>
1999-03-10 17:22:12 +00:00
the time used to execute the
Make it obvious that command line arguments may be specified for the utility that is to be invoked on the command line. Use "utility" instead of "command" in manual page and usage message for consistency with POSIX.
2002-06-20 07:07:00 +00:00
.Ar utility
Adds the '-p' option to make time(1) output POSIX.2 compliant. Updates the manpage as well. I've rewritten the patch as it was for 2.2.7. It can probably be put into 3.1-STABLE as well. PR: bin/10515 Submitted by: Jens Schweikhardt <schweikh@noc.dfn.de>
1999-03-10 17:22:12 +00:00
process and the time consumed by system overhead.
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Pp
Introduce options definition the standard way. command -> utility.
2003-06-09 19:37:45 +00:00
The following options are available:
.Bl -tag -width indent
Behave like GNU time. More cleanup. Reword man page. Pointed out by: Bruce Evans
1998-07-27 16:54:05 +00:00
.It Fl a
If the
.Fl o
flag is used, append to the specified file rather than overwriting
Correct some hard sentence breaks. Only those surrounding the previous commit and those which cause ugly nroff output have been fixed, since the purpose of the style guideline which they contravene is to reduce the sizes of deltas. Reported by: bde
1999-09-14 11:46:04 +00:00
it.
Otherwise, this option has no effect.
Add a new "-h" Human-friendly h/m/s output format. Reviewed by: bde
2000-10-28 21:48:53 +00:00
.It Fl h
Mechanically kill hard sentence breaks.
2004-07-02 22:22:35 +00:00
Print times in a human friendly format.
Times are printed in minutes, hours,
etc.\& as appropriate.
Brucifixion.
1998-07-28 10:08:16 +00:00
.It Fl l
The contents of the
.Em rusage
structure are printed as well.
Clean up the previous commit.
1998-07-27 16:08:58 +00:00
.It Fl o Ar file
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
Write the output to
By default, /usr/bin/time writes its output to stderr. Two options have been added to time(1) to write output to an alternative destination. Option "-f filename" will write to filename, and filename can be - to write to stdout. Option "-a filename" will append the output to filename. Time(1) man page has been updated to reflect the change. PR: 7368 Submitted by: Steven G. Kargl <kargl@troutmask.apl.washington.edu>
1998-07-24 07:19:29 +00:00
.Ar file
Mechanically kill hard sentence breaks.
2004-07-02 22:22:35 +00:00
instead of stderr.
If
By default, /usr/bin/time writes its output to stderr. Two options have been added to time(1) to write output to an alternative destination. Option "-f filename" will write to filename, and filename can be - to write to stdout. Option "-a filename" will append the output to filename. Time(1) man page has been updated to reflect the change. PR: 7368 Submitted by: Steven G. Kargl <kargl@troutmask.apl.washington.edu>
1998-07-24 07:19:29 +00:00
.Ar file
Behave like GNU time. More cleanup. Reword man page. Pointed out by: Bruce Evans
1998-07-27 16:54:05 +00:00
exists and the
.Fl a
flag is not specified, the file will be overwritten.
Adds the '-p' option to make time(1) output POSIX.2 compliant. Updates the manpage as well. I've rewritten the patch as it was for 2.2.7. It can probably be put into 3.1-STABLE as well. PR: bin/10515 Submitted by: Jens Schweikhardt <schweikh@noc.dfn.de>
1999-03-10 17:22:12 +00:00
.It Fl p
Makes
.Nm
output POSIX.2 compliant (each time is printed on its own line).
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.El
.Pp
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes
1999-09-08 15:40:46 +00:00
Some shells may provide a builtin
.Nm
Correct some hard sentence breaks. Only those surrounding the previous commit and those which cause ugly nroff output have been fixed, since the purpose of the style guideline which they contravene is to reduce the sizes of deltas. Reported by: bde
1999-09-14 11:46:04 +00:00
command which is similar or identical to this utility.
Consult the
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes
1999-09-08 15:40:46 +00:00
.Xr builtin 1
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
manual page.
Handle SIGINFO in time(1) by printing the time the given command is running. I find it quite handy to just hit ^T and see the time.
2006-05-14 13:16:19 +00:00
.Pp
If
.Nm
receives a
.Dv SIGINFO
(see the status argument for
.Xr stty 1 )
signal, the current time the given command is running will be written to the
standard output.
Document the fairly obvious effects of the PATH environment variable.
2002-06-28 09:31:03 +00:00
.Sh ENVIRONMENT
The
.Ev PATH
environment variable is used to locate the requested
.Ar utility
if the name contains no
.Ql /
characters.
Added the EXIT STATUS section where appropriate.
2005-01-17 07:44:44 +00:00
.Sh EXIT STATUS
Adds the '-p' option to make time(1) output POSIX.2 compliant. Updates the manpage as well. I've rewritten the patch as it was for 2.2.7. It can probably be put into 3.1-STABLE as well. PR: bin/10515 Submitted by: Jens Schweikhardt <schweikh@noc.dfn.de>
1999-03-10 17:22:12 +00:00
If
Make it obvious that command line arguments may be specified for the utility that is to be invoked on the command line. Use "utility" instead of "command" in manual page and usage message for consistency with POSIX.
2002-06-20 07:07:00 +00:00
.Ar utility
Correct some hard sentence breaks. Only those surrounding the previous commit and those which cause ugly nroff output have been fixed, since the purpose of the style guideline which they contravene is to reduce the sizes of deltas. Reported by: bde
1999-09-14 11:46:04 +00:00
could be timed successfully, its exit status is returned.
If
Make it obvious that command line arguments may be specified for the utility that is to be invoked on the command line. Use "utility" instead of "command" in manual page and usage message for consistency with POSIX.
2002-06-20 07:07:00 +00:00
.Ar utility
Adds the '-p' option to make time(1) output POSIX.2 compliant. Updates the manpage as well. I've rewritten the patch as it was for 2.2.7. It can probably be put into 3.1-STABLE as well. PR: bin/10515 Submitted by: Jens Schweikhardt <schweikh@noc.dfn.de>
1999-03-10 17:22:12 +00:00
terminated abnormally, a warning message is output to stderr.
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
If the
Make it obvious that command line arguments may be specified for the utility that is to be invoked on the command line. Use "utility" instead of "command" in manual page and usage message for consistency with POSIX.
2002-06-20 07:07:00 +00:00
.Ar utility
Adds the '-p' option to make time(1) output POSIX.2 compliant. Updates the manpage as well. I've rewritten the patch as it was for 2.2.7. It can probably be put into 3.1-STABLE as well. PR: bin/10515 Submitted by: Jens Schweikhardt <schweikh@noc.dfn.de>
1999-03-10 17:22:12 +00:00
was found but could not be run, the exit status is 126.
If no
Make it obvious that command line arguments may be specified for the utility that is to be invoked on the command line. Use "utility" instead of "command" in manual page and usage message for consistency with POSIX.
2002-06-20 07:07:00 +00:00
.Ar utility
Adds the '-p' option to make time(1) output POSIX.2 compliant. Updates the manpage as well. I've rewritten the patch as it was for 2.2.7. It can probably be put into 3.1-STABLE as well. PR: bin/10515 Submitted by: Jens Schweikhardt <schweikh@noc.dfn.de>
1999-03-10 17:22:12 +00:00
could be found at all, the exit status is 127.
If
.Nm
encounters any other error, the exit status is between 1 and 125
included.
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Sh SEE ALSO
Improve shell documentation: * Consistently misspell built-in as builtin. * Add a builtin(1) manpage and create builtin(1) MLINKS for all shell builtin commands for which no standalone utility exists. These MLINKS replace those that were created for csh(1). * Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages, as well as to the manpages of standalone utilities which are supported as shell builtin commands in at least one of the shells. In such manpages, explain that similar functionality may be provided as a shell builtin command. * Improve sh(1)'s description of the cd builtin command. Csh(1) already describes it adequately. Replace the cd(1) manpage with a builtin(1) MLINKS link. * Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use Ic instead of Xr for shell builtin commands. * Undo English contractions. Reviewed by: mpp, rgrimes
1999-09-08 15:40:46 +00:00
.Xr builtin 1 ,
Add a couple of relavant man page xrefs for more information on the structures time(1) displays, instead of refering he reading to an include file. Obtained from: NetBSD-bugs mailing list PR#3193
1997-02-06 05:21:39 +00:00
.Xr csh 1 ,
.Xr getrusage 2 ,
.Xr wait 2
Adds the '-p' option to make time(1) output POSIX.2 compliant. Updates the manpage as well. I've rewritten the patch as it was for 2.2.7. It can probably be put into 3.1-STABLE as well. PR: bin/10515 Submitted by: Jens Schweikhardt <schweikh@noc.dfn.de>
1999-03-10 17:22:12 +00:00
.Sh STANDARDS
The
.Nm
utility is expected to conform to ISO/IEC 9945-2:1993 (``POSIX'').
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Sh HISTORY
A
.Nm
Introduce options definition the standard way. command -> utility.
2003-06-09 19:37:45 +00:00
utility appeared in
Correct History: time(1) appeared at least as early as V3.
2002-06-03 14:54:04 +00:00
.At v3 .
Reference in New Issue Copy Permalink