Sheldon Hearn
c644db6aa2
* 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
129 lines
3.5 KiB
Groff
129 lines
3.5 KiB
Groff
.\" 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.
|
|
.\" 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 8.1 (Berkeley) 6/6/93
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd June 6, 1993
|
|
.Dt TIME 1
|
|
.Os BSD 4
|
|
.Sh NAME
|
|
.Nm time
|
|
.Nd time command execution
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl alp
|
|
.Op Fl o Ar file
|
|
.Ar command
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
utility
|
|
executes and
|
|
times
|
|
.Ar command
|
|
by initiating a timer and passing the
|
|
.Ar command
|
|
to the
|
|
shell.
|
|
After the
|
|
.Ar command
|
|
finishes,
|
|
.Nm
|
|
writes to the standard error stream,
|
|
(in seconds):
|
|
the total time elapsed,
|
|
the time used to execute the
|
|
.Ar command
|
|
process and the time consumed by system overhead.
|
|
.Pp
|
|
Available options:
|
|
.Bl -tag -width Ds
|
|
.It Fl a
|
|
If the
|
|
.Fl o
|
|
flag is used, append to the specified file rather than overwriting
|
|
it. Otherwise, this option has no effect.
|
|
.It Fl l
|
|
The contents of the
|
|
.Em rusage
|
|
structure are printed as well.
|
|
.It Fl o Ar file
|
|
Write the output to
|
|
.Ar file
|
|
instead of stderr. If
|
|
.Ar file
|
|
exists and the
|
|
.Fl a
|
|
flag is not specified, the file will be overwritten.
|
|
.It Fl p
|
|
Makes
|
|
.Nm
|
|
output POSIX.2 compliant (each time is printed on its own line).
|
|
.El
|
|
.Pp
|
|
Some shells may provide a builtin
|
|
.Nm
|
|
command which is similar or identical to this utility. Consult
|
|
the
|
|
.Xr builtin 1
|
|
manual page.
|
|
.Sh DIAGNOSTICS
|
|
If
|
|
.Ar command
|
|
could be timed successfully, its exit status is returned. In case
|
|
.Ar command
|
|
terminated abnormally, a warning message is output to stderr.
|
|
If the
|
|
.Ar command
|
|
was found but could not be run, the exit status is 126.
|
|
If no
|
|
.Ar command
|
|
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.
|
|
.Sh SEE ALSO
|
|
.Xr builtin 1 ,
|
|
.Xr csh 1 ,
|
|
.Xr getrusage 2 ,
|
|
.Xr wait 2
|
|
.Sh STANDARDS
|
|
The
|
|
.Nm
|
|
utility is expected to conform to ISO/IEC 9945-2:1993 (``POSIX'').
|
|
.Sh HISTORY
|
|
A
|
|
.Nm
|
|
command appeared in
|
|
.At v6 .
|