fish-shell/doc_src/cmds/bg.rst

.. _cmd-bg:

bg - send jobs to background
============================

Synopsis
--------

``bg`` [*PID* ...]

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

``bg`` sends :ref:`jobs <syntax-job-control>` to the background, resuming them if they are stopped.

A background job is executed simultaneously with fish, and does not have access to the keyboard. If no job is specified, the last job to be used is put in the background. If ``PID`` is specified, the jobs containing the specified process IDs are put in the background.

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

When at least one of the arguments isn't a valid job specifier,
``bg`` will print an error without backgrounding anything.

When all arguments are valid job specifiers, ``bg`` will background all matching jobs that exist.

Example
-------

``bg 123 456 789`` will background the jobs that contain processes 123, 456 and 789.

If only 123 and 789 exist, it will still background them and print an error about 456.

``bg 123 banana`` or ``bg banana 123`` will complain that "banana" is not a valid job specifier.

``bg %1`` will background job 1.
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 17:05:09 +08:00			`.. _cmd-bg:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`bg - send jobs to background`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`============================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
slog through documentation I did.. a and b today. 2021-12-09 19:33:33 +08:00			``bg`` [PID ...]
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Fix broken links to index.html in cmd docs 2020-01-31 11:38:56 +08:00			``bg`` sends :ref:`jobs <syntax-job-control>` to the background, resuming them if they are stopped.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: note job expansion in bg/fg/jobs arguments Discussed in #5019. 2021-02-28 20:56:23 +08:00			A background job is executed simultaneously with fish, and does not have access to the keyboard. If no job is specified, the last job to be used is put in the background. If ``PID`` is specified, the jobs containing the specified process IDs are put in the background.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: note job expansion in bg/fg/jobs arguments Discussed in #5019. 2021-02-28 20:56:23 +08:00			For compatibility with other shells, job expansion syntax is supported for ``bg``. A PID of the format ``%1`` will be interpreted as the PID of job 1. Job numbers can be seen in the output of :ref:`jobs <cmd-jobs>`.

			`When at least one of the arguments isn't a valid job specifier,`
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``bg`` will print an error without backgrounding anything.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: note job expansion in bg/fg/jobs arguments Discussed in #5019. 2021-02-28 20:56:23 +08:00			When all arguments are valid job specifiers, ``bg`` will background all matching jobs that exist.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: note job expansion in bg/fg/jobs arguments Discussed in #5019. 2021-02-28 20:56:23 +08:00			``bg 123 456 789`` will background the jobs that contain processes 123, 456 and 789.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`If only 123 and 789 exist, it will still background them and print an error about 456.`

Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``bg 123 banana`` or ``bg banana 123`` will complain that "banana" is not a valid job specifier.
docs: note job expansion in bg/fg/jobs arguments Discussed in #5019. 2021-02-28 20:56:23 +08:00
			``bg %1`` will background job 1.