mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-29 14:23:09 +00:00
414d9a1eb1
When writing scripts for other shells, it can be confusing and annoying that our `man` function shadows other manual pages, for example `exec(1p)` from [Linux man-pages]. I almost never want to see the fish variant for such contended cases (which obviuosly don't include fish-specific commands like `string`, only widely-known shell builtins). For the contented cases like `exec`, the POSIX documentation is more substantial and useful, since it describes a (sub)set of languages widely used for scripting. Because of this I think we should stop overriding the system's man pages. Nowadays we offer `exec -h` as intuitive way to show the documentation for the fish-specific command (note that `help` is not a good replacement because it uses a web browser). Looking through the contended commands, it seems like for most of them, the fish version is not substantially different from the system version. A notable exception is `read` but I don't think it's a very important one. So I think we should can sacrifice a bit of the native fish-scripting experience in exchange for playing nicer with other shells. I think the latter is more important because scripting is not our focus, the way I see it. So maybe put our manpath at the end. In lieu of that, let's at least have `exec.rst` reference the system variant. [Linux man-pages]: https://www.kernel.org/doc/man-pages/ Closes #10376
58 lines
1.4 KiB
ReStructuredText
58 lines
1.4 KiB
ReStructuredText
.. _cmd-wait:
|
|
|
|
wait - wait for jobs to complete
|
|
================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
wait [-n | --any] [PID | PROCESS_NAME] ...
|
|
|
|
Description
|
|
-----------
|
|
|
|
.. only:: builder_man
|
|
|
|
NOTE: This page documents the fish builtin ``wait``.
|
|
To see the documentation on any non-fish versions, use ``command man wait``.
|
|
|
|
``wait`` waits for child jobs to complete.
|
|
|
|
If a *PID* is specified, the command waits for the job that the process with that process ID 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** or **--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.
|
|
|
|
The **-h** or **--help** option displays help about using this command.
|
|
|
|
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 finish, and doesn't wait for ``hoge`` finishing.
|