From 5b1764a84a9d91b904444bd00c0d4d7d23143117 Mon Sep 17 00:00:00 2001 From: Moe Jette <jette1@llnl.gov> Date: Fri, 3 Mar 2006 21:32:59 +0000 Subject: [PATCH] Update man pages for new bgl code --- doc/man/man1/sinfo.1 | 22 +++++++++++----------- doc/man/man1/smap.1 | 4 ++-- doc/man/man1/squeue.1 | 39 ++++++++++++++++++++------------------- 3 files changed, 33 insertions(+), 32 deletions(-) diff --git a/doc/man/man1/sinfo.1 b/doc/man/man1/sinfo.1 index 93e8e721508..03f880be3dc 100644 --- a/doc/man/man1/sinfo.1 +++ b/doc/man/man1/sinfo.1 @@ -1,4 +1,4 @@ -.TH SINFO "1" "February 2006" "sinfo 1.0" "Slurm components" +.TH SINFO "1" "March 2006" "sinfo 1.1" "Slurm components" .SH "NAME" sinfo \- view information about SLURM nodes and partitions. @@ -249,7 +249,7 @@ partitions without a job time limit. \fBMEMORY\fR Size of real memory in megabytes on these nodes. .TP -\fBNODELIST\fR +\fBNODELIST\fR or \fBBP_LIST\fR (BlueGene systems only) Names of nodes associated with this configuration/partition. .TP \fBNODES\fR @@ -297,14 +297,14 @@ any new work. If the node remains non\-responsive, it will be placed in the \fBDOWN\fR state (except in the case of \fBDRAINED\fR, \fBDRAINING\fR, or \fBCOMPLETING\fR nodes). .TP 12 -ALLOCATED +\fBALLOCATED\fR The node has been allocated to one or more jobs. .TP -ALLOCATED+ +\fBALLOCATED+\fR The node is allocated to one or more active jobs plus one or more jobs are in the process of COMPLETING. .TP -COMPLETING +\fBCOMPLETING\fR All jobs associated with this node are in the process of COMPLETING. This node state will be removed when all of the job's processes have terminated and the SLURM @@ -312,7 +312,7 @@ epilog program (if any) has terminated. See the \fBEpilog\fR parameter description in the \fBslurm.conf\fR man page for more information. .TP -DOWN +\fBDOWN\fR The node is unavailable for use. SLURM can automatically place nodes in this state if some failure occurs. System administrators may also explicitly place nodes in this state. If @@ -321,13 +321,13 @@ return it to service. See the \fBReturnToService\fR and \fBSlurmdTimeout\fR parameter descriptions in the \fBslurm.conf\fR(5) man page for more information. .TP -DRAINED +\fBDRAINED\fR The node is unavailable for use per system administrator request. See the \fBupdate node\fR command in the \fBscontrol\fR(1) man page or the \fBslurm.conf\fR(5) man page for more information. .TP -DRAINING +\fBDRAINING\fR The node is currently executing a job, but will not be allocated to additional jobs. The node state will be changed to state \fBDRAINED\fR when the last job on it completes. Nodes enter @@ -335,10 +335,10 @@ this state per system administrator request. See the \fBupdate node\fR command in the \fBscontrol\fR(1) man page or the \fBslurm.conf\fR(5) man page for more information. .TP -IDLE +\fBIDLE\fR The node is not allocated to any jobs and is available for use. .TP -UNKNOWN +\fBUNKNOWN\fR The SLURM controller has just started and the node's state has not yet been determined. @@ -430,7 +430,7 @@ Not Responding dev8 .ec .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 diff --git a/doc/man/man1/smap.1 b/doc/man/man1/smap.1 index 9bd184fd061..2fa5fd1588f 100644 --- a/doc/man/man1/smap.1 +++ b/doc/man/man1/smap.1 @@ -1,4 +1,4 @@ -.TH SMAP "1" "December 2005" "smap 1.0" "Slurm components" +.TH SMAP "1" "March 2006" "smap 1.1" "Slurm components" .SH "NAME" smap \- graphically view information about SLURM jobs, partitions, and set @@ -410,7 +410,7 @@ compiled into smap. The location of the SLURM configuration file. .SH "COPYING" -Copyright (C) 2004 The Regents of the University of California. +Copyright (C) 2004\-2006 The Regents of the University of California. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). UCRL-CODE-217948. .LP diff --git a/doc/man/man1/squeue.1 b/doc/man/man1/squeue.1 index 4e8cd658773..8f322150a0d 100644 --- a/doc/man/man1/squeue.1 +++ b/doc/man/man1/squeue.1 @@ -1,4 +1,4 @@ -.TH SQUEUE "1" "December 2005" "squeue 1.0" "Slurm components" +.TH SQUEUE "1" "March 2006" "squeue 1.1" "Slurm components" .SH "NAME" squeue \- view information about jobs located in the SLURM scheduling queue. @@ -140,7 +140,8 @@ For job steps this field shows the elapsed time since execution began and thus will be inaccurate for job steps which have been suspended. .TP \fB%n\fR -List of node names explicitly requested by the job +List of node names (or base partitions on BlueGene systems) explicitly +requested by the job .TP \fB%N\fR List of nodes allocated to the job or job step. In the case of a @@ -262,26 +263,26 @@ These codes identify the reason that a job is waiting for execution. A job may be waiting for more than one reason, in which case only one of those reasons is displayed. .TP 20 -Dependency +\fBDependency\fR This job is waiting for a dependent job to complete. .TP -None +\fBNone\fR No reason is set for this job. .TP -PartitionDown +\fBPartitionDown\fR The partition required by this job is in a DOWN state. .TP -PartitionNodeLimit +\fBPartitionNodeLimit\fR The number of nodes required by this job is outside of it's partitions current limits. .TP -PartitionTimeLimit +\fBPartitionTimeLimit\fR The job's time limit exceeds it's partition's current time limit. .TP -Priority +\fBPriority\fR One or more higher priority jobs exist for this partition. .TP -Resources +\fBResources\fR The job is waiting for resources to become availble. .SH "JOB STATE CODES" @@ -290,32 +291,32 @@ execution. The typical states are PENDING, RUNNING, SUSPENDED, COMPLETING, and COMPLETED. An explanation of each state follows. .TP 20 -CA CANCELLED +\fBCA CANCELLED\fR Job was explicitly cancelled by the user or system administrator. The job may or may not have been initiated. .TP -CD COMPLETED +\fBCD COMPLETED\fR Job has terminated all processes on all nodes. .TP -CG COMPLETING +\fBCG COMPLETING\fR Job is in the process of completing. Some processes on some nodes may still be active. .TP -F FAILED +\fBF FAILED\fR Job terminated with non\-zero exit code or other failure condition. .TP -NF NODE_FAIL +\fBNF NODE_FAIL\fR Job terminated due to failure of one or more allocated nodes. .TP -PD PENDING +\fBPD PENDING\fR Job is awaiting resource allocation. .TP -R RUNNING +\fBR RUNNING\fR Job currently has an allocation. .TP -S SUSPENDED +\fBS SUSPENDED\fR Job has an allocation, but execution has been suspended. .TP -TO TIMEOUT +\fBTO TIMEOUT\fR Job terminated upon reaching its time limit. .SH "ENVIRONMENT VARIABLES" @@ -401,7 +402,7 @@ Print information only about job step 65552.1: .ec .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 -- GitLab