aboutsummaryrefslogtreecommitdiff
path: root/pkg/language/doc/jobs.hlp
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
commitfa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch)
treebdda434976bc09c864f2e4fa6f16ba1952b1e555 /pkg/language/doc/jobs.hlp
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'pkg/language/doc/jobs.hlp')
-rw-r--r--pkg/language/doc/jobs.hlp50
1 files changed, 50 insertions, 0 deletions
diff --git a/pkg/language/doc/jobs.hlp b/pkg/language/doc/jobs.hlp
new file mode 100644
index 00000000..b23b6563
--- /dev/null
+++ b/pkg/language/doc/jobs.hlp
@@ -0,0 +1,50 @@
+.help jobs Feb86 language
+.ih
+NAME
+jobs -- display the status of background jobs
+.ih
+USAGE
+jobs
+.ih
+PARAMETERS
+None.
+.ih
+DESCRIPTION
+\fIJobs\fR is used to display the status of background jobs.
+If no job number is specified then all the status of all background
+jobs is displayed. For each job there is one line of output, e.g.
+
+ [2] 0:14 +Running copy file1 file2 &
+
+Here 2 is the job number of the job; 0:14 is the clock time in minutes and
+seconds since the job was submitted; `Running' indicates that the task is
+currently running while the `+' indicates that this was the last background
+job started. The remainder of the line is a copy of the actual command
+used to start the job.
+
+The possible states for a background job are:
+
+.nf
+ Done -- the job has finished normally
+ Exit N -- the job terminated with exit code N
+ Stopped -- the job is waiting for input from the user
+ (see the \fIservice\fR command)
+ Running -- the job is currently executing
+.fi
+.ih
+EXAMPLES
+.nf
+cl> jobs
+ [1] 21:13 Done mkhelp >& dev$null &
+ [2] 0:05 +Running count *.hlp > _junk &
+.fi
+.ih
+BUGS
+Exit codes are rarely displayed when jobs terminate abnormally.
+The CL checks for background job termination only when a command is
+entered, hence the elapsed time shown will often be greater than it
+should be.
+.ih
+SEE ALSO
+kill, service
+.endhelp