fish-shell/doc_src/cmds/jobs.rst

.. _cmd-jobs:

jobs - print currently running jobs
===================================

Synopsis
--------

::

    jobs [OPTIONS] [PID]


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

``jobs`` prints a list of the currently running :ref:`jobs <syntax-job-control>` and their status.

jobs accepts the following switches:

- ``-c`` or ``--command`` prints the command name for each process in jobs.

- ``-g`` or ``--group`` only prints the group ID of each job.

- ``-l`` or ``--last`` prints only the last job to be started.

- ``-p`` or ``--pid`` prints the process ID for each process in all jobs.

- ``-q`` or ``--quiet`` prints no output for evaluation of jobs by exit status only.

On systems that supports this feature, jobs will print the CPU usage of each job since the last command was executed. The CPU usage is expressed as a percentage of full CPU activity. Note that on multiprocessor systems, the total activity may be more than 100\%.

If the output of ``jobs`` is redirected or if it is part of a command substitution, the column header that is usually printed is omitted, making it easier to parse.

The exit status of ``jobs`` is ``0`` if there are running background jobs and ``1`` otherwise.

Example
-------

``jobs`` outputs a summary of the current jobs, such as two long-running tasks in this example:

.. code-block:: none

   Job Group   State   Command
   2   26012   running nc -l 55232 < /dev/random &
   1   26011   running python tests/test_11.py &
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-jobs:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`jobs - print currently running jobs`
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			`::`

			`jobs [OPTIONS] [PID]`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
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			``jobs`` prints a list of the currently running :ref:`jobs <syntax-job-control>` and their status.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`jobs accepts the following switches:`

Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-c`` or ``--command`` prints the command name for each process in jobs.
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			- ``-g`` or ``--group`` only prints the group ID of each job.
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			- ``-l`` or ``--last`` prints only the last job to be started.
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			- ``-p`` or ``--pid`` prints the process ID for each process in all jobs.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: standardise on exit status terminology Exit status is used in the POSIX specification and is preferred over return code/return status/exit code. [ci skip] 2019-09-17 16:31:39 +08:00			- ``-q`` or ``--quiet`` prints no output for evaluation of jobs by exit status only.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`On systems that supports this feature, jobs will print the CPU usage of each job since the last command was executed. The CPU usage is expressed as a percentage of full CPU activity. Note that on multiprocessor systems, the total activity may be more than 100\%.`

docs/jobs: Header is stripped in command substitution 2020-07-03 05:46:54 +08:00			If the output of ``jobs`` is redirected or if it is part of a command substitution, the column header that is usually printed is omitted, making it easier to parse.

docs: Link builtins When we say "the XYZ command/builtin", we should typically include a link. The exceptions are - In the documentation for that command - no need to link to ulimit in the ulimit page - When we've already linked before - not every thing needs to be clickable, or clicking it will cause the browser to mark fifty words as visited. This is roughly what wikipedia does for crosslinks. [ci skip] 2020-03-21 22:31:25 +08:00			The exit status of ``jobs`` is ``0`` if there are running background jobs and ``1`` otherwise.
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/jobs: add example output and remove spurious header 2020-07-06 20:48:13 +08:00			``jobs`` outputs a summary of the current jobs, such as two long-running tasks in this example:

			`.. code-block:: none`

			`Job Group State Command`
			`2 26012 running nc -l 55232 < /dev/random &`
			`1 26011 running python tests/test_11.py &`