fish-shell/doc_src/cmds/time.rst

.. _cmd-time:

time - measure how long a command or block takes
================================================

Synopsis
--------

::

   time COMMAND

Description
-----------

.. only:: builder_man

          NOTE: This page documents the fish keyword ``time``.
          To see the documentation on the ``time`` command you might have,
          use ``command man time``.

``time`` 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.

For checking timing after a command has completed, check :ref:`$CMD_DURATION <variables-special>`.

Your system most likely also has a ``time`` command. To use that use something like ``command time``, as in ``command time sleep 10``. Because it's not inside fish, it won't have access to fish functions and won't be able to time blocks and such.

Example
-------

(for obvious reasons exact results will vary on your system)

::

   >_ time sleep 1s
   
   ________________________________________________________
   Executed in    1,01 secs   fish           external
      usr time    2,32 millis    0,00 micros    2,32 millis
      sys time    0,88 millis  877,00 micros    0,00 millis

   >_ time for i in 1 2 3; sleep 1s; end

   ________________________________________________________
   Executed in    3,01 secs   fish           external
      usr time    9,16 millis    2,94 millis    6,23 millis
      sys time    0,23 millis    0,00 millis    0,23 millis

Inline variable assignments need to follow the ``time`` keyword::

   >_ time a_moment=1.5m sleep $a_moment

   ________________________________________________________
   Executed in   90.00 secs      fish           external
      usr time    4.62 millis    4.62 millis    0.00 millis
      sys time    2.35 millis    0.41 millis    1.95 millis
Document time This is a bit barebones, but `time` isn't super complicated to use and it should explain the basics. Fixes #6442 [ci skip] 2020-01-05 21:50:54 +08:00			`.. _cmd-time:`

			`time - measure how long a command or block takes`
			`================================================`

			`Synopsis`
			`--------`

			`::`

			`time COMMAND`

			`Description`
			`-----------`

docs: Document that the man pages are for our builtins For builtins that have the same name as common commands, it might not be entirely obvious that there is another page. So, for those builtins, we add a note, but only in the man pages. (exception is true and false because the note would be longer than the page, and it's fridging true and false) Fixes #8077. 2021-07-17 00:21:41 +08:00			`.. only:: builder_man`

			NOTE: This page documents the fish keyword ``time``.
			To see the documentation on the ``time`` command you might have,
			use ``command man time``.

Document time This is a bit barebones, but `time` isn't super complicated to use and it should explain the basics. Fixes #6442 [ci skip] 2020-01-05 21:50:54 +08:00			``time`` 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.

			For checking timing after a command has completed, check :ref:`$CMD_DURATION <variables-special>`.

docs: use monospace for inline code snippets more consistently 2020-10-27 02:19:05 +08:00			Your system most likely also has a ``time`` command. To use that use something like ``command time``, as in ``command time sleep 10``. Because it's not inside fish, it won't have access to fish functions and won't be able to time blocks and such.
docs/time: Add a note about time command [ci skip] 2020-01-06 05:28:20 +08:00
Document time This is a bit barebones, but `time` isn't super complicated to use and it should explain the basics. Fixes #6442 [ci skip] 2020-01-05 21:50:54 +08:00			`Example`
			`-------`

			`(for obvious reasons exact results will vary on your system)`

			`::`

			`>_ time sleep 1s`

			`________________________________________________________`
			`Executed in 1,01 secs fish external`
			`usr time 2,32 millis 0,00 micros 2,32 millis`
			`sys time 0,88 millis 877,00 micros 0,00 millis`

			`>_ time for i in 1 2 3; sleep 1s; end`

			`________________________________________________________`
			`Executed in 3,01 secs fish external`
			`usr time 9,16 millis 2,94 millis 6,23 millis`
			`sys time 0,23 millis 0,00 millis 0,23 millis`
builtin time: print help on invalid syntax I always mix up the order with variable assignments. 2020-10-27 02:13:34 +08:00
			Inline variable assignments need to follow the ``time`` keyword::

			`>_ time a_moment=1.5m sleep $a_moment`

			`________________________________________________________`
			`Executed in 90.00 secs fish external`
			`usr time 4.62 millis 4.62 millis 0.00 millis`
			`sys time 2.35 millis 0.41 millis 1.95 millis`