aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/jobs.txt
diff options
context:
space:
mode:
authorGravatar Mark Griffiths <mark@thebespokepixel.com>2014-08-01 03:37:32 +0100
committerGravatar Mark Griffiths <mark@thebespokepixel.com>2014-09-03 14:43:24 +0100
commitd282bc462578a6e47747c78d2d42883530f0d11e (patch)
treea6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/jobs.txt
parent1c4223889bd729ee83aa21a3450dc28f92ade641 (diff)
Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
Diffstat (limited to 'doc_src/jobs.txt')
-rw-r--r--doc_src/jobs.txt18
1 files changed, 10 insertions, 8 deletions
diff --git a/doc_src/jobs.txt b/doc_src/jobs.txt
index 8b96d127..f47e618e 100644
--- a/doc_src/jobs.txt
+++ b/doc_src/jobs.txt
@@ -1,19 +1,21 @@
\section jobs jobs - print currently running jobs
\subsection jobs-synopsis Synopsis
-<code>jobs [OPTIONS] [PID]</code>
+\fish{syn}
+jobs [OPTIONS] [PID]
+\endfish
\subsection jobs-description Description
-<code>jobs</code> prints a list of the currently
+`jobs` prints a list of the currently
running <a href="index.html#syntax-job-control">jobs</a> and their status.
jobs accepts the following switches:
-- <code>-c</code> or <code>--command</code> prints the command name for each process in jobs.
-- <code>-g</code> or <code>--group</code> only prints the group ID of each job.
-- <code>-h</code> or <code>--help</code> displays a help message and exits.
-- <code>-l</code> or <code>--last</code> prints only the last job to be started.
-- <code>-p</code> or <code>--pid</code> prints the process ID for each process in all jobs.
+- `-c` or `--command` prints the command name for each process in jobs.
+- `-g` or `--group` only prints the group ID of each job.
+- `-h` or `--help` displays a help message and exits.
+- `-l` or `--last` prints only the last job to be started.
+- `-p` or `--pid` prints the process ID for each process in all jobs.
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
@@ -22,4 +24,4 @@ multiprocessor systems, the total activity may be more than 100\%.
\subsection jobs-example Example
-<code>jobs</code> outputs a summary of the current jobs.
+`jobs` outputs a summary of the current jobs.