Next: Resource Measurement [Contents][Index]
This file documents the the GNU time
command for running programs
and summarizing the system resources they use.
Version UNKNOWN, updated 15 January 2021
• Resource Measurement | Measuring program resource use. | |
• Reporting bugs | Sending bug reports and feature suggestions. | |
• GNU Free Documentation License | Copying and sharing this documentation. | |
• Concept index | Index of concepts. |
Next: Reporting bugs, Previous: Top, Up: Top [Contents][Index]
The time
command runs another program, then displays information
about the resources used by that program, collected by the system while
the program was running. You can select which information is reported
and the format in which it is shown (see Setting Format), or have
time
save the information in a file instead of displaying it on the
screen (see Redirecting).
The resources that time
can report on fall into the general
categories of time, memory, and I/O and IPC calls. Some systems do not
provide much information about program resource use; time
reports unavailable information as zero values (see Accuracy).
The format of the time
command is:
time [option…] command [arg…]
time
runs the program command, with any given arguments
arg…. When command finishes, time
displays
information about resources used by command.
Here is an example of using time
to measure the time and other
resources used by running the program grep
:
eg$ time grep nobody /etc/aliases nobody:/dev/null etc-files:nobody misc-group:nobody 0.07user 0.50system 0:06.69elapsed 8%CPU (0avgtext+489avgdata 324maxresident)k 46inputs+7outputs (43major+251minor)pagefaults 0swaps
Mail suggestions and bug reports for GNU time
to
bug-time@gnu.org
. Please include the version of
time
, which you can get by running ‘time --version’, and the
operating system and C compiler you used.
• Setting Format | Selecting the information reported by time .
| |
• Format String | The information time can report.
| |
• Redirecting | Writing the information to a file. | |
• Examples | Examples of using time .
| |
• Accuracy | Limitations on the accuracy of time output.
| |
• Invoking time | Summary of the options to the time command.
|
Next: Format String, Up: Resource Measurement [Contents][Index]
time
uses a format string to determine which information to
display about the resources used by the command it runs. See Format String, for the interpretation of the format string contents.
You can specify a format string with the command line options listed
below. If no format is specified on the command line, but the
TIME
environment variable is set, its value is used as the format
string. Otherwise, the default format built into time
is used:
%Uuser %Ssystem %Eelapsed %PCPU (%Xtext+%Ddata %Mmax)k %Iinputs+%Ooutputs (%Fmajor+%Rminor)pagefaults %Wswaps
The command line options to set the format are:
-f format
--format=format
Use format as the format string.
-p
--portability
Use the following format string:
real %e user %U sys %S
The default output format of time differs widely between implementations. This option (in its short form -p) is supported by all POSIX-compliant ’time’ implementations to retrieve basic information in the described format.
-v
--verbose
Use the built-in verbose format, which displays each available piece of information on the program’s resource use on its own line, with an English description of its meaning.
Next: Redirecting, Previous: Setting Format, Up: Resource Measurement [Contents][Index]
The format string controls the contents of the time
output.
It consists of resource specifiers and escapes, interspersed
with plain text.
A backslash introduces an escape, which is translated into a single printing character upon output. The valid escapes are listed below. An invalid escape is output as a question mark followed by a backslash.
\t
a tab character
\n
a newline
\\
a literal backslash
time
always prints a newline after printing the resource use
information, so normally format strings do not end with a newline
character (or ‘\n’).
A resource specifier consists of a percent sign followed by another character. An invalid resource specifier is output as a question mark followed by the invalid character. Use ‘%%’ to output a literal percent sign.
The resource specifiers, which are a superset of those recognized by the
tcsh
builtin time
command, are listed below. Not all
resources are measured by all versions of Unix, so some of the values
might be reported as zero (see Accuracy).
• Time Resources | ||
• Memory Resources | ||
• I/O Resources | ||
• Command Info |
Next: Memory Resources, Up: Format String [Contents][Index]
E
Elapsed real (wall clock) time used by the process, in [hours:]minutes:seconds.
e
Elapsed real (wall clock) time used by the process, in seconds.
S
Total number of CPU-seconds used by the system on behalf of the process (in kernel mode), in seconds.
U
Total number of CPU-seconds that the process used directly (in user mode), in seconds.
P
Percentage of the CPU that this job got. This is just user + system times divied by the total running time.
Next: I/O Resources, Previous: Time Resources, Up: Format String [Contents][Index]
M
Maximum resident set size of the process during its lifetime, in Kilobytes.
t
Average resident set size of the process, in Kilobytes.
K
Average total (data+stack+text) memory use of the process, in Kilobytes.
D
Average size of the process’s unshared data area, in Kilobytes.
p
Average size of the process’s unshared stack, in Kilobytes.
X
Average size of the process’s shared text, in Kilobytes.
Z
System’s page size, in bytes. This is a per-system constant, but varies between systems.
Next: Command Info, Previous: Memory Resources, Up: Format String [Contents][Index]
F
Number of major, or I/O-requiring, page faults that occurred while the process was running. These are faults where the page has actually migrated out of primary memory.
R
Number of minor, or recoverable, page faults. These are pages that are not valid (so they fault) but which have not yet been claimed by other virtual pages. Thus the data in the page is still valid but the system tables must be updated.
W
Number of times the process was swapped out of main memory.
c
Number of times the process was context-switched involuntarily (because the time slice expired).
w
Number of times that the program was context-switched voluntarily, for instance while waiting for an I/O operation to complete.
I
Number of file system inputs by the process.
O
Number of file system outputs by the process.
r
Number of socket messages received by the process.
s
Number of socket messages sent by the process.
k
Number of signals delivered to the process.
Previous: I/O Resources, Up: Format String [Contents][Index]
C
Name and command line arguments of the command being timed.
x
Exit status of the command.
Next: Examples, Previous: Format String, Up: Resource Measurement [Contents][Index]
By default, time
writes the resource use statistics to the
standard error stream. The options below make it write the statistics
to a file instead. Doing this can be useful if the program you’re
running writes to the standard error or you’re running time
noninteractively or in the background.
-o file
--output=file
Write the resource use statistics to file. By default, this overwrites the file, destroying the file’s previous contents.
-a
--append
Append the resource use information to the output file instead of overwriting it. This option is only useful with the ‘-o’ or ‘--output’ option.
Next: Accuracy, Previous: Redirecting, Up: Resource Measurement [Contents][Index]
Run the command ‘wc /etc/hosts’ and show the default information:
eg$ time wc /etc/hosts 35 111 1134 /etc/hosts 0.00user 0.01system 0:00.04elapsed 25%CPU (0avgtext+0avgdata 0maxresident)k 1inputs+1outputs (0major+0minor)pagefaults 0swaps
Run the command ‘ls -Fs’ and show just the user, system, and wall-clock time:
eg$ time -f "\t%E real,\t%U user,\t%S sys" ls -Fs total 16 1 account/ 1 db/ 1 mail/ 1 run/ 1 backups/ 1 emacs/ 1 msgs/ 1 rwho/ 1 crash/ 1 games/ 1 preserve/ 1 spool/ 1 cron/ 1 log/ 1 quotas/ 1 tmp/ 0:00.03 real, 0.00 user, 0.01 sys
Edit the file .bashrc and have time
append the elapsed time
and number of signals to the file log, reading the format string
from the environment variable TIME
:
eg$ export TIME="\t%E,\t%k" # If using bash or ksh eg$ setenv TIME "\t%E,\t%k" # If using csh or tcsh eg$ time -a -o log emacs .bashrc eg$ cat log 0:16.55, 726
Run the command ‘sleep 4’ and show all of the information about it verbosely:
eg$ time -v sleep 4 Command being timed: "sleep 4" User time (seconds): 0.00 System time (seconds): 0.05 Percent of CPU this job got: 1% Elapsed (wall clock) time (h:mm:ss or m:ss): 0:04.26 Average shared text size (kbytes): 36 Average unshared data size (kbytes): 24 Average stack size (kbytes): 0 Average total size (kbytes): 60 Maximum resident set size (kbytes): 32 Average resident set size (kbytes): 24 Major (requiring I/O) page faults: 3 Minor (reclaiming a frame) page faults: 0 Voluntary context switches: 11 Involuntary context switches: 0 Swaps: 0 File system inputs: 3 File system outputs: 1 Socket messages sent: 0 Socket messages received: 0 Signals delivered: 1 Page size (bytes): 4096 Exit status: 0
Next: Invoking time, Previous: Examples, Up: Resource Measurement [Contents][Index]
The elapsed time is not collected atomically with the execution of the
program; as a result, in bizarre circumstances (if the time
command gets stopped or swapped out in between when the program being
timed exits and when time
calculates how long it took to run), it
could be much larger than the actual execution time.
When the running time of a command is very nearly zero, some values (e.g., the percentage of CPU used) may be reported as either zero (which is wrong) or a question mark.
Most information shown by time
is derived from the wait3
system call. The numbers are only as good as those returned by
wait3
. Many systems do not measure all of the resources that
time
can report on; those resources are reported as zero. The
systems that measure most or all of the resources are based on 4.2 or
4.3BSD. Later BSD releases use different memory management code that
measures fewer resources.
On systems that do not have a wait3
call that returns status
information, the times
system call is used instead. It provides
much less information than wait3
, so on those systems time
reports most of the resources as zero.
The ‘%I’ and ‘%O’ values are allegedly only “real” input and output and do not include those supplied by caching devices. The meaning of “real” I/O reported by ‘%I’ and ‘%O’ may be muddled for workstations, especially diskless ones.
Previous: Accuracy, Up: Resource Measurement [Contents][Index]
time
CommandThe format of the time
command is:
time [option…] command [arg…]
time
runs the program command, with any given arguments
arg…. When command finishes, time
displays
information about resources used by command (on the standard error
output, by default). If command exits with non-zero status or is
terminated by a signal, time
displays a warning message and the
exit status or signal number.
Options to time
must appear on the command line before
command. Anything on the command line after command is
passed as arguments to command.
-o file
--output=file
Write the resource use statistics to file.
-a
--append
Append the resource use information to the output file instead of overwriting it.
-f format
--format=format
Use format as the format string.
--help
Print a summary of the command line options to time
and exit.
-p
--portability
Use the POSIX format.
-v
--verbose
Use the built-in verbose format.
-V
--version
Print the version number of time
and exit.
Next: GNU Free Documentation License, Previous: Resource Measurement, Up: Top [Contents][Index]
To report bugs, suggest enhancements or otherwise discuss GNU Datamash, please send electronic mail to bug-time.org.
For bug reports, please include enough information for the maintainers to reproduce the problem. Generally speaking, that means:
configure
other than specifying
installation directories.
When in doubt whether something is needed or not, include it. It’s better to include too much than to leave out something important.
Patches are welcome; if possible, please make them with ‘diff -c’ (see Overview in Comparing and Merging Files) and include ChangeLog entries (see Change Log in The GNU Emacs Manual). Please follow the existing coding style.
Next: Concept index, Previous: Reporting bugs, Up: Top [Contents][Index]
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
with the Invariant Sections being list their titles, with the Front-Cover Texts being list, and with the Back-Cover Texts being list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
Previous: GNU Free Documentation License, Up: Top [Contents][Index]
Jump to: | B C F P R V |
---|
Jump to: | B C F P R V |
---|