Add man page for slurm_allocation_lookup.

doc/man/Makefile.am

@@ -17,6 +17,7 @@ man3_MANS = man3/slurm_hostlist_create.3 \
 	man3/slurm_hostlist_shift.3 \
 	man3/slurm_allocate_resources.3 \
 	man3/slurm_allocate_resources_and_run.3 \
+	man3/slurm_allocation_lookup.3 \
 	man3/slurm_api_version.3 \
 	man3/slurm_checkpoint_able.3 \
 	man3/slurm_checkpoint_complete.3 \

doc/man/man3/slurm_allocate_resources.3

-.TH "Slurm API" "3" "February 2005" "Morris Jette" "Slurm job initiation functions"
+.TH "Slurm API" "3" "January 2006" "Morris Jette" "Slurm job initiation functions"
 .SH "NAME"
 slurm_allocate_resources, slurm_allocate_resources_and_run,
-slurm_confirm_allocation, 
+slurm_allocation_lookup, slurm_confirm_allocation, 
 slurm_free_resource_allocation_and_run_response_msg, 
 slurm_free_submit_response_response_msg, slurm_init_job_desc_msg, 
 slurm_job_will_run, slurm_submit_batch_job
@@ -25,6 +25,14 @@ int \fBslurm_allocate_resources_and_run\fR (
 	resource_allocation_and_run_response_msg_t **\fIslurm_alloc_run_msg_pptr\fP
 .br 
 );
+.LP
+int \fBslurm_allocation_lookup\fR {
+.br
+	uint32_t \fIjobid\fP,
+.br
+	resource_allocation_response_msg_t **\fIslurm_alloc_msg_pptr\fP
+.br
+);
 .LP 
 int \fBslurm_confirm_allocation\fR (
 .br 
@@ -90,7 +98,8 @@ structure's contents.
 .TP 
 \fIslurm_alloc_msg_ptr\fP
 Specifies the pointer to the structure to be created and filled in by the function 
-\fIslurm_allocate_resources\fP, \fIslurm_confirm_allocation\fP or \fIslurm_job_will_run\fP.
+\fIslurm_allocate_resources\fP, \fIslurm_allocation_lookup\fP, 
+\fIslurm_confirm_allocation\fP or \fIslurm_job_will_run\fP.
 .TP 
 \fIslurm_alloc_run_msg_pptr\fP
 Specifies the double pointer to the structure to be created and filled with a 
@@ -123,17 +132,22 @@ including the initiation of a job step to span the full allocation. If resources
 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 
-\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 
-root.
+.LP
+\fBslurm_allocation_lookup\fR Return detailed information on a specific
+existing job allocation. This function may only be sucessfully executed
+by the job's owner or user root. 
+.LP
+\fBslurm_confirm_allocation\fR Return detailed information on a specific 
+existing job allocation. \fBOBSOLETE FUNCTION: Use slurm_allocation_lookup
+instead.\fR This function may only be successfully executed by the job's 
+owner or user root.
 .LP 
 \fBslurm_free_resource_allocation_and_run_response_msg\fR Release the storage generated 
 in response to a call of the function \fBslurm_allocate_resources_and_run\fR.
 .LP 
 \fBslurm_free_resource_allocation_response_msg\fR Release the storage generated in response 
 to a call of the function \fBslurm_allocate_resources\fR, or
-\fBslurm_confirm_allocation\fR.
+\fBslurm_allocation_lookup\fR.
 .LP 
 \fBslurm_free_submit_response_msg\fR Release the storage generated in response 
 to a call of the function \fBslurm_submit_batch_job\fR.
@@ -275,7 +289,7 @@ int main (int argc, char *argv[])
 }
 
 .SH "COPYING"
-Copyright (C) 2002 The Regents of the University of California.
+Copyright (C) 2002-2006 The Regents of the University of California.
 Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
 UCRL-CODE-217948.
 .LP

doc/man/man3/slurm_allocation_lookup.3

+.so man3/slurm_allocate_resources.3

doc/man/man3/slurm_free_job_info_msg.3

-.TH "Slurm API" "3" "September 2004" "Morris Jette" "Slurm job information reporting functions"
+.TH "Slurm API" "3" "January 2006" "Morris Jette" "Slurm job information reporting functions"
 .SH "NAME"
 slurm_free_job_info_msg, slurm_get_end_time,
 slurm_get_select_jobinfo,
@@ -284,7 +284,7 @@ If the \fIshow_flags\fP argument is not set to SHOW_ALL when getting this
 data, these index values will be invalid.
 
 .SH "COPYING"
-Copyright (C) 2002 The Regents of the University of California.
+Copyright (C) 2002-2006 The Regents of the University of California.
 Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
 UCRL-CODE-217948.
 .LP
@@ -302,6 +302,6 @@ FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 details.
 .SH "SEE ALSO"
 .LP 
-\fBscontrol\fR(1), \fBsqueue\fR(1), \fBslurm_confirm_allocation\fR(3), 
+\fBscontrol\fR(1), \fBsqueue\fR(1), \fBslurm_allocation_lookup\fR(3), 
 \fBslurm_get_errno\fR(3), \fBslurm_perror\fR(3), \fBslurm_strerror\fR(3)
 

doc/man/man3/slurm_free_node_info.3

-.TH "Slurm API" "3" "June 2004" "Morris Jette" "Slurm node informational calls"
+.TH "Slurm API" "3" "January 2006" "Morris Jette" "Slurm node informational calls"
 .SH "NAME"
 slurm_free_node_info, slurm_load_node, 
 slurm_print_node_info_msg, slurm_print_node_table
@@ -235,7 +235,7 @@ If the \fIshow_flags\fP argument is not set to SHOW_ALL when getting this
 data, these index values will be invalid.
 
 .SH "COPYING"
-Copyright (C) 2002 The Regents of the University of California.
+Copyright (C) 2002-2006 The Regents of the University of California.
 Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
 UCRL-CODE-217948.
 .LP
@@ -253,7 +253,7 @@ FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 details.
 .SH "SEE ALSO"
 .LP 
-\fBscontrol\fR(1), \fBsqueue\fR(1), \fBslurm_confirm_allocation\fR(3), 
+\fBscontrol\fR(1), \fBsqueue\fR(1), \fBslurm_allocation_lookup\fR(3), 
 \fBslurm_get_errno\fR(3), \fBslurm_load_partitions\fR(3),
 \fBslurm_perror\fR(3), \fBslurm_strerror\fR(3)
 

doc/man/man3/slurm_get_errno.3

-.TH "Slurm API" "3" "July 2003" "Morris Jette" "Slurm error handling functions"
+.TH "Slurm API" "3" "January 2006" "Morris Jette" "Slurm error handling functions"
 .SH "NAME"
 slurm_get_errno, slurm_perror, slurm_strerror \- Slurm error handling functions
 .SH "SYNTAX"
@@ -87,7 +87,7 @@ details.
 .LP 
 \fBslurm_allocate_resources\fR(3), \fBslurm_allocate_resources_and_run\fR(3), 
 \fBslurm_complete_job\fR(3), \fBslurm_complete_job_step\fR(3), 
-\fBslurm_confirm_allocation\fR(3), 
+\fBslurm_allocation_lookup\fR(3), 
 \fBslurm_free_ctl_conf\fR(3), \fBslurm_free_job_info_msg\fR(3), 
 \fBslurm_free_job_step_create_response_msg\fR(3), 
 \fBslurm_free_node_info\fR(3), \fBslurm_free_partition_info\fR(3),