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

Include information on the hostlist function use.

parent 233d0a47
No related branches found
No related tags found
No related merge requests found
.TH "Slurm API" "3" "October 2002" "Morris Jette" "Slurm job initiation functions" .TH "Slurm API" "3" "November 2002" "Morris Jette" "Slurm job initiation functions"
.SH "NAME" .SH "NAME"
slurm_allocate_resources, slurm_allocate_resources_and_run, slurm_allocate_resources, slurm_allocate_resources_and_run,
slurm_confirm_allocation, slurm_confirm_allocation,
...@@ -126,6 +126,9 @@ the function \fBslurm_free_resource_allocation_response_msg\fR. ...@@ -126,6 +126,9 @@ the function \fBslurm_free_resource_allocation_response_msg\fR.
including the initiation of a job step to span the full allocation. If successful, including the initiation of a job step to span the full allocation. If successful,
job and job step records are created. Always release the response message when no job and job step records are created. Always release the response message when no
longer required using the function \fBslurm_free_resource_allocation_and_run_response_msg\fR. longer required using the function \fBslurm_free_resource_allocation_and_run_response_msg\fR.
The list of host names returned may be matched to their data in the proper order by
using the functions \fBhostlist_create\fR, \fBhostlist_shift\fR, and
\fBhostlist_destroy\fR.
.LP .LP
\fBslurm_confirm_allocation\fR Return detailed information on a specific existing job \fBslurm_confirm_allocation\fR Return detailed information on a specific existing job
allocation. This function may only be successfully executed by the job's owner or user allocation. This function may only be successfully executed by the job's owner or user
...@@ -284,6 +287,7 @@ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more ...@@ -284,6 +287,7 @@ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details. details.
.SH "SEE ALSO" .SH "SEE ALSO"
.LP .LP
\fBhostlist_create\fR(3), \fBhostlist_shift\fR(3), \fBhostlist_destroy\fR(3),
\fBscancel\fR(1), \fBsrun\fR(1), \fBslurm_free_job_info\fR(3), \fBscancel\fR(1), \fBsrun\fR(1), \fBslurm_free_job_info\fR(3),
\fBslurm_get_errno\fR(3), \fBslurm_load_jobs\fR(3), \fBslurm_get_errno\fR(3), \fBslurm_load_jobs\fR(3),
\fBslurm_perror\fR(3), \fBslurm_strerror\fR(3) \fBslurm_perror\fR(3), \fBslurm_strerror\fR(3)
...@@ -37,7 +37,10 @@ to a call of the function \fBslurm_job_step_create\fR. ...@@ -37,7 +37,10 @@ to a call of the function \fBslurm_job_step_create\fR.
.LP .LP
\fBslurm_job_step_create\fR Initialize a job step including the allocation of nodes to \fBslurm_job_step_create\fR Initialize a job step including the allocation of nodes to
it from those already allocate to that job. Always release the response message when no it from those already allocate to that job. Always release the response message when no
longer required using the function \fBslurm_free_job_step_create_response_msg\fR. longer required using the function \fBslurm_free_job_step_create_response_msg\fR.
The list of host names returned may be matched to their data in the proper order by
using the functions \fBhostlist_create\fR, \fBhostlist_shift\fR, and
\fBhostlist_destroy\fR.
.SH "RETURN VALUE" .SH "RETURN VALUE"
.LP .LP
On success, zero is returned. On error, -1 is returned, and Slurm error code is set appropriately. On success, zero is returned. On error, -1 is returned, and Slurm error code is set appropriately.
...@@ -73,6 +76,7 @@ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more ...@@ -73,6 +76,7 @@ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details. details.
.SH "SEE ALSO" .SH "SEE ALSO"
.LP .LP
\fBhostlist_create\fR(3), \fBhostlist_shift\fR(3), \fBhostlist_destroy\fR(3),
\fBsrun\fR(1), \fBsrun\fR(1),
\fBslurm_allocate_resources_and_run\fR(3), \fBslurm_allocate_resources_and_run\fR(3),
\fBslurm_get_errno\fR(3), \fBslurm_perror\fR(3), \fBslurm_strerror\fR(3) \fBslurm_get_errno\fR(3), \fBslurm_perror\fR(3), \fBslurm_strerror\fR(3)
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