fish-shell/doc_src/cmds/fg.rst

.. _cmd-fg:

fg - bring job to foreground
============================

Synopsis
--------

``fg`` [*PID*]

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

The **fg** builtin brings the specified :ref:`job <syntax-job-control>` to the foreground, resuming it if it is stopped.
While a foreground job is executed, fish is suspended.
If no job is specified, the last job to be used is put in the foreground.
If ``PID`` is specified, the job containing a process with the specified process ID is put in the foreground.

For compatibility with other shells, job expansion syntax is supported for ``fg``. A *PID* of the format **%1** will foreground job 1.
Job numbers can be seen in the output of :ref:`jobs <cmd-jobs>`.

Example
-------

``fg`` will put the last job in the foreground.

``fg %3`` will put job 3 into the foreground.
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-fg:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`fg - bring job to foreground`
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
doc_src: Continue the slog through the letter F. We are using only :: in a synopsis for fishscript examples given of the command being documented. 2021-12-17 23:16:47 +00:00			``fg`` [PID]
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
Commit doc_src progress. This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages. 2021-12-17 21:58:38 +00:00			The fg builtin brings the specified :ref:`job <syntax-job-control>` to the foreground, resuming it if it is stopped.
			`While a foreground job is executed, fish is suspended.`
			`If no job is specified, the last job to be used is put in the foreground.`
			If ``PID`` is specified, the job containing a process with the specified process ID is put in the foreground.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
doc_src: Continue the slog through the letter F. We are using only :: in a synopsis for fishscript examples given of the command being documented. 2021-12-17 23:16:47 +00:00			For compatibility with other shells, job expansion syntax is supported for ``fg``. A PID of the format %1 will foreground job 1.
Commit doc_src progress. This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages. 2021-12-17 21:58:38 +00:00			Job numbers can be seen in the output of :ref:`jobs <cmd-jobs>`.
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 backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``fg`` will put the last job in the foreground.
docs: note job expansion in bg/fg/jobs arguments Discussed in #5019. 2021-02-28 12:56:23 +00:00
			``fg %3`` will put job 3 into the foreground.