fish-shell/sphinx_doc_src/cmds/bg.rst

.. _cmd-bg:

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

Synopsis
--------

::

    bg [PID...]

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

``bg`` sends `jobs <index.html#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 with the specified process group IDs are put in the background.

When at least one of the arguments isn't a valid job specifier (i.e. PID),
``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 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.
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
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +08:00			`::`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +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
docs: Fix moar reference syntax 2019-03-31 03:44:07 +08:00			``bg`` sends `jobs <index.html#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
			`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 with the specified process group IDs are put in the background.`

			`When at least one of the arguments isn't a valid job specifier (i.e. PID),`
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
			`When all arguments are valid job specifiers, bg will background all matching jobs that exist.`

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
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``bg 123 456 789`` will background 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.