fish-shell/sphinx_doc_src/cmds/wait.rst

.. _cmd-wait:

wait - wait for jobs to complete
================================

Synopsis
--------

wait [-n | --any] [PID | PROCESS_NAME] ...


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

``wait`` waits for child jobs to complete.

- If a pid is specified, the command waits for the job that the process with the pid belongs to.
- If a process name is specified, the command waits for the jobs that the matched processes belong to.
- If neither a pid nor a process name is specified, the command waits for all background jobs.
- If the ``-n`` / ``--any`` flag is provided, the command returns as soon as the first job completes. If it is not provided, it returns after all jobs complete.

Example
-------


::

    sleep 10 &
    wait $last_pid

spawns ``sleep`` in the background, and then waits until it finishes.


::

    for i in (seq 1 5); sleep 10 &; end
    wait

spawns five jobs in the background, and then waits until all of them finishes.


::

    for i in (seq 1 5); sleep 10 &; end
    hoge &
    wait sleep

spawns five jobs and ``hoge`` in the background, and then waits until all ``sleep``s finishes, and doesn't wait for ``hoge`` finishing.
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 09:05:09 +00:00			`.. _cmd-wait:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`wait - wait for jobs to complete`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`================================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
			`wait [-n \| --any] [PID \| PROCESS_NAME] ...`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``wait`` waits for child jobs to complete.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
			`- If a pid is specified, the command waits for the job that the process with the pid belongs to.`
			`- If a process name is specified, the command waits for the jobs that the matched processes belong to.`
			`- If neither a pid nor a process name is specified, the command waits for all background jobs.`
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- If the ``-n`` / ``--any`` flag is provided, the command returns as soon as the first job completes. If it is not provided, it returns after all jobs complete.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Example`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00

			`::`

			`sleep 10 &`
			`wait $last_pid`

Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			spawns ``sleep`` in the background, and then waits until it finishes.
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00

			`::`

			`for i in (seq 1 5); sleep 10 &; end`
			`wait`

Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00			`spawns five jobs in the background, and then waits until all of them finishes.`
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00

			`::`

			`for i in (seq 1 5); sleep 10 &; end`
			`hoge &`
			`wait sleep`

Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			spawns five jobs and ``hoge`` in the background, and then waits until all ``sleep``s finishes, and doesn't wait for ``hoge`` finishing.