1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>time - measure how long a command or block takes — fish-shell 4.2.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4da8bbd6" />
<link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=f89b4716" />
<script src="../_static/documentation_options.js?v=6fb65176"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="trap - perform an action when the shell receives a signal" href="trap.html" />
<link rel="prev" title="test - perform tests on files and text" href="test.html" />
<link rel="shortcut icon" type="image/png" href="../_static/fish.png" />
</head><body><div id="fmain">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li><img src="../_static/fish.png" alt=""
style="width: 80px; height: 80px; vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://fishshell.com/">fish-shell</a> »</li>
<a href="../index.html">fish-shell 4.2.1 documentation</a> »
<li class="nav-item nav-item-1"><a href="../commands.html" accesskey="U">Commands</a> »</li>
<li class="nav-item nav-item-this"><a href="">time - measure how long a command or block takes</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</li>
<div id="old-docs-notice" style="display: none">
This documents an old version of fish.
<a href="../../current/">See the latest release.</a>
</div>
</ul>
</div>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="../index.html">Documents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently asked questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../interactive.html">Interactive use</a></li>
<li class="toctree-l1"><a class="reference internal" href="../language.html">The fish language</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../commands.html">Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="../fish_for_bash_users.html">Fish for bash users</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../completions.html">Writing your own completions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../prompt.html">Writing your own prompt</a></li>
<li class="toctree-l1"><a class="reference internal" href="../design.html">Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../relnotes.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../terminal-compatibility.html">Terminal Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing To Fish</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h4><a href="../index.html">Sections</a></h4>
<ul>
<li><a class="reference internal" href="#">time - measure how long a command or block takes</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#how-to-interpret-the-output">How to interpret the output</a></li>
<li><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="time-measure-how-long-a-command-or-block-takes">
<h1>time - measure how long a command or block takes<a class="headerlink" href="#time-measure-how-long-a-command-or-block-takes" title="Link to this heading">¶</a></h1>
<section id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Link to this heading">¶</a></h2>
<div class="highlight-fish-synopsis notranslate"><div class="highlight"><pre><span></span><span class="o">time</span><span class="w"> </span><span class="nf">COMMAND</span>
</pre></div>
</div>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">time</span></code> causes fish to measure how long a command takes and print the results afterwards. The command can be a simple fish command or a block. The results can not currently be redirected.</p>
<p>For checking timing after a command has completed, check <a class="reference internal" href="../language.html#variables-special"><span class="std std-ref">$CMD_DURATION</span></a>.</p>
<p>Your system most likely also has a <code class="docutils literal notranslate"><span class="pre">time</span></code> command. To use that use something like <code class="docutils literal notranslate"><span class="pre">command</span> <span class="pre">time</span></code>, as in <code class="docutils literal notranslate"><span class="pre">command</span> <span class="pre">time</span> <span class="pre">sleep</span> <span class="pre">10</span></code>. Because it’s not inside fish, it won’t have access to fish functions and won’t be able to time blocks and such.</p>
</section>
<section id="how-to-interpret-the-output">
<h2>How to interpret the output<a class="headerlink" href="#how-to-interpret-the-output" title="Link to this heading">¶</a></h2>
<p>Time outputs a few different values. Let’s look at an example:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="gp">> </span><span class="o">time</span><span class="w"> </span><span class="nf">string</span><span class="w"> </span><span class="no">repeat</span><span class="w"> </span><span class="no">-n</span><span class="w"> </span><span class="no">10000000</span><span class="w"> </span><span class="no">y</span><span class="se">\n</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">command</span><span class="w"> </span><span class="nf">grep</span><span class="w"> </span><span class="no">y</span><span class="w"> </span><span class="p">>/dev/null</span>
<span class="go">________________________________________________________</span>
<span class="go">Executed in 805.98 millis fish external</span>
<span class="go"> usr time 798.88 millis 763.88 millis 34.99 millis</span>
<span class="go"> sys time 141.22 millis 40.20 millis 101.02 millis</span>
</pre></div>
</div>
<p>The time after “Executed in” is what is known as the “wall-clock time”. It is simply a measure of how long it took from the start of the command until it finished. Typically it is reasonably close to <span class="target" id="index-0"></span><a class="reference internal" href="../language.html#envvar-CMD_DURATION"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">CMD_DURATION</span></code></a>, except for a slight skew because the two are taken at slightly different times.</p>
<p>The other times are all measures of CPU time. That means they measure how long the CPU was used in this part, and they count multiple cores separately. So a program with four threads using all CPU for a second will have a time of 4 seconds.</p>
<p>The “usr” time is how much CPU time was spent inside the program itself, the “sys” time is how long was spent in the kernel on behalf of that program.</p>
<p>The “fish” time is how much CPU was spent in fish, the “external” time how much was spent in external commands.</p>
<p>So in this example, since <code class="docutils literal notranslate"><span class="pre">string</span></code> is a builtin, everything that <code class="docutils literal notranslate"><span class="pre">string</span> <span class="pre">repeat</span></code> did is accounted to fish. Any time it spends doing syscalls like <code class="docutils literal notranslate"><span class="pre">write()</span></code> is accounted for in the fish/sys time.</p>
<p>And <code class="docutils literal notranslate"><span class="pre">grep</span></code> here is explicitly invoked as an external command, so its times will be counted in the “external” column.</p>
<p>Note that, as in this example, the CPU times can add up to more than the execution time. This is because things can be done in parallel - <code class="docutils literal notranslate"><span class="pre">grep</span></code> can match while <code class="docutils literal notranslate"><span class="pre">string</span> <span class="pre">repeat</span></code> writes.</p>
</section>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
<p>(for obvious reasons exact results will vary on your system)</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="gp">>_ </span><span class="o">time</span><span class="w"> </span><span class="nf">sleep</span><span class="w"> </span><span class="no">1s</span>
<span class="go">________________________________________________________</span>
<span class="go">Executed in 1,01 secs fish external</span>
<span class="go"> usr time 2,32 millis 0,00 micros 2,32 millis</span>
<span class="go"> sys time 0,88 millis 877,00 micros 0,00 millis</span>
<span class="gp">>_ </span><span class="o">time</span><span class="w"> </span><span class="nf">for</span><span class="w"> </span><span class="no">i</span><span class="w"> </span><span class="nf">in</span><span class="w"> </span><span class="no">1</span><span class="w"> </span><span class="no">2</span><span class="w"> </span><span class="no">3</span><span class="p">;</span><span class="w"> </span><span class="nf">sleep</span><span class="w"> </span><span class="no">1s</span><span class="p">;</span><span class="w"> </span><span class="nf">end</span>
<span class="go">________________________________________________________</span>
<span class="go">Executed in 3,01 secs fish external</span>
<span class="go"> usr time 9,16 millis 2,94 millis 6,23 millis</span>
<span class="go"> sys time 0,23 millis 0,00 millis 0,23 millis</span>
</pre></div>
</div>
<p>Inline variable assignments need to follow the <code class="docutils literal notranslate"><span class="pre">time</span></code> keyword:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="gp">>_ </span><span class="o">time</span><span class="w"> </span><span class="no">a_moment</span><span class="o">=</span><span class="no">1.5m</span><span class="w"> </span><span class="nf">sleep</span><span class="w"> </span><span class="o">$a_moment</span>
<span class="go">________________________________________________________</span>
<span class="go">Executed in 90.00 secs fish external</span>
<span class="go"> usr time 4.62 millis 4.62 millis 0.00 millis</span>
<span class="go"> sys time 2.35 millis 0.41 millis 1.95 millis</span>
</pre></div>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li><img src="../_static/fish.png" alt=""
style="width: 80px; height: 80px; vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://fishshell.com/">fish-shell</a> »</li>
<a href="../index.html">fish-shell 4.2.1 documentation</a> »
<li class="nav-item nav-item-1"><a href="../commands.html" >Commands</a> »</li>
<li class="nav-item nav-item-this"><a href="">time - measure how long a command or block takes</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</li>
<div id="old-docs-notice" style="display: none">
This documents an old version of fish.
<a href="../../current/">See the latest release.</a>
</div>
</ul>
</div>
<div class="footer">
© Copyright fish-shell developers.
<br />
<a href="https://github.com/fish-shell/fish-shell/issues">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</div>
<script type="text/javascript">
FISH_DOCS_VERSION = "4.2";
function copy_to_clipboard(it) {
// Find the pre tag we're interested in.
var pre = it.target;
while (pre.tagName != "PRE") pre = pre.parentNode;
var txt = "";
// Cheesy: If we have a prompt,
// we only copy prompted lines,
// by splitting and matching and stuff
if (pre.querySelector('span.gp')) {
var texts= [];
for (var line of pre.innerText.split('\n')) {
if (line.match(/^>_?.*/)) {
texts.push(line.replace(/^>_?/, ""));
}
}
txt = texts.join("\n");
} else {
// Even cheesier: If we don't have a prompt, we remove the button text from the end.
var txt = pre.innerText.substring(0, pre.innerText.length - it.target.innerText.length).trim();
}
navigator.clipboard.writeText(txt).then(function() {
// Success - set the text to indicate it,
// then set it back after 2 seconds.
var span = pre.querySelector("button span");
if (span) {
var oldText = span.innerText;
span.innerText = "COPIED!";
setTimeout(function() {
span.innerText = oldText;
}, 2000);
}
}, function() {
});
}
(function () {
// Add copy buttons to all the codeblocks.
var codeblocks = document.querySelectorAll('div > pre');
var button = document.createElement('button');
var span = document.createElement('span');
span.innerText = "COPY";
button.appendChild(span);
for (var i of codeblocks) {
var newButton = button.cloneNode(true);
newButton.addEventListener('click', copy_to_clipboard);
i.appendChild(newButton);
}
})();
</script>
</body>
</html>
|
