Skip to content
Snippets Groups Projects
Commit a4bbfb0d authored by Moe Jette's avatar Moe Jette
Browse files

Clarify how job signal function presently works given no step_id (it

signals all job steps, but not the job script itself).
parent e77648c1
No related branches found
No related tags found
No related merge requests found
.TH SCANCEL "1" "October 2003" "scancel 0.3" "Slurm components"
.TH SCANCEL "1" "November 2003" "scancel 0.3" "Slurm components"
.SH "NAME"
scancel \- Used to signal jobs or job steps that are under the control of Slurm.
.SH "SYNOPSIS"
......@@ -52,7 +52,7 @@ Print the version number of the scontrol command.
ARGUMENTS
.TP
\fIjob_id\fP
The Slurm job ID of the job to have one of its steps or the entire job signaled.
The Slurm job ID of the job to have one or more of its steps signaled.
.TP
\fIstep_id\fP
The step ID of the job step to be signaled. If none is provided, then
......
.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm job signal calls"
.TH "Slurm API" "3" "November 2003" "Morris Jette" "Slurm job signal calls"
.SH "NAME"
slurm_kill_job, slurm_kill_job_step \- Slurm job signal calls
.SH "SYNTAX"
......@@ -35,10 +35,12 @@ Slurm job step id number.
Signal to be sent to the job or job step.
.SH "DESCRIPTION"
.LP
\fBslurm_kill_job\fR Request that a signal be sent to a job and all of its job steps. If the job is pending, it will be terminated immediately.This function
may only be successfully executed by the job's owner or user root.
\fBslurm_kill_job\fR Request that a signal be sent to all steps of the specified job.
If the job is pending and the signal is SIGKILL, the job will be terminated immediately.
This function may only be successfully executed by the job's owner or user root.
.LP
\fBslurm_kill_job_step\fR Request that a signal be sent to a specific job step. This function may only be successfully executed by the job's owner or user root.
\fBslurm_kill_job_step\fR Request that a signal be sent to a specific job step.
This function may only be successfully executed by the job's owner or user root.
.SH "RETURN VALUE"
.LP
On success, zero is returned. On error, -1 is returned, and Slurm error code is set appropriately.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment