From 4b174b7bdbf06762429415a683e4ee999ffd6eca Mon Sep 17 00:00:00 2001 From: Moe Jette <jette1@llnl.gov> Date: Tue, 22 Oct 2002 22:48:42 +0000 Subject: [PATCH] Add examples and otherwise refine man1 pages. --- doc/man/man1/scontrol.1 | 24 +++++++++---- doc/man/man1/sinfo.1 | 73 ++++++++++++++++++++++++++++++++++++++-- doc/man/man1/slurmctld.1 | 10 ++++-- doc/man/man1/slurmd.1 | 7 +++- doc/man/man1/squeue.1 | 20 +++++------ 5 files changed, 111 insertions(+), 23 deletions(-) diff --git a/doc/man/man1/scontrol.1 b/doc/man/man1/scontrol.1 index 0d3461e7247..13316507a01 100644 --- a/doc/man/man1/scontrol.1 +++ b/doc/man/man1/scontrol.1 @@ -100,21 +100,27 @@ Repeat the last command executed. .br scontrol: show part class .br -PartitionName=class MaxTime=30 MaxNodes=2 TotalNodes=10 TotalCPUs=160 RootOnly=NO +PartitionName=class MaxTime=30 MaxNodes=2 TotalNodes=10 .br - Default=NO Shared=NO State=UP Nodes=lx[0031-0040] AllowGroups=students + TotalCPUs=160 RootOnly=NO Default=NO Shared=NO State=UP +.br + Nodes=lx[0031-0040] AllowGroups=students .br -scontrol: update PartitionName=class MaxTime=300 MaxNodes=4 +scontrol: update PartitionName=class MaxTime=99 MaxNodes=4 .br scontrol: show job 65539 .br -JobId=65539 UserId=1500 JobState=PENDING TimeLimit=100 Priority=100 Partition=batch +JobId=65539 UserId=1500 JobState=PENDING TimeLimit=100 .br - Name=job01 NodeList=(null) StartTime=0 EndTime=0 Shared=0 + Priority=100 Partition=batch Name=job01 NodeList=(null) .br - ReqProcs=1000 ReqNodes=400 Contiguous=1 MinProcs=4 MinMemory=1024 MinTmpDisk=2034 + StartTime=0 EndTime=0 Shared=0 ReqProcs=1000 +.br + ReqNodes=400 Contiguous=1 MinProcs=4 MinMemory=1024 .br - ReqNodeList=lx[3000-3003] Features=(null) JobScript=/bin/hostname + MinTmpDisk=2034ReqNodeList=lx[3000-3003] +.br + Features=(null) JobScript=/bin/hostname .br scontrol: update JobId=65539 TimeLimit=200 Priority=500 .br @@ -138,8 +144,12 @@ SLURM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.SH "FILES" +.LP +/etc/slurm.conf .SH "SEE ALSO" \fBslurm_load_ctl_conf\fR(3), \fBslurm_load_jobs\fR(3), \fBslurm_load_node\fR(3), \fBslurm_load_partitions\fR(3), \fBslurm_reconfigure\fR(3), \fBslurm_shutdown\fR(3), \fBslurm_update_job\fR(3), \fBslurm_update_node\fR(3), \fBslurm_update_partition\fR(3) +\fBslurm.conf\fR(5) diff --git a/doc/man/man1/sinfo.1 b/doc/man/man1/sinfo.1 index 3c68accfc9f..b91ab896eb8 100644 --- a/doc/man/man1/sinfo.1 +++ b/doc/man/man1/sinfo.1 @@ -53,10 +53,77 @@ A valid node state. Possible values include: DOWN, UNKNOWN, IDLE, ALLOCATED, DRA .TP \fBtime\fR Number of seconds to wait between each iteration. -.SH "EXAMPLE" +.SH "EXAMPLES" .eo -PUT THE EXAMPLE HERE... -.br +Report basic system configuration: +.br +# ./sinfo +.br +PARTITION NODES STATE CPUS MEM DISK NODES +.br +----------------------------------------------------------------- +.br +debug 18 IDLE 2 128 512 dev[1-18] +.br +debug 2 DRAINED 2 128 512 dev[19-20] +.br +pbatch 60 ALLOCATED 2 128 512 dev[21-80] +.br +pbatch 19 IDLE 2 128 512 dev[81-99] +.br + +.br +Report more complete information about the partition debug: +.br +# ./sinfo --long --partition debug +.br +PARTITION INFORMATION +.br +================================================================= +.br +debug +.br + current state = UP +.br + default partition = YES +.br + total nodes = 20 +.br + total cpus = 40 +.br + max jobtime = 30 +.br + max nodes/job = 10 +.br + root only = NO +.br + share nodes = NO +.br + +.br + NODES STATE CPUS MEM DISK NODES +.br + ----------------------------------------------------------- +.br + 18 IDLE 2 128 512 dev[1-18] +.br + 2 DRAINED 2 128 512 dev[19-20] +.br + +.br +================================================================= +.br + +.br +Report only those nodes that are in state DRAINED: +.br +# ./sinfo --state DRAINED +.br +PARTITION NODES STATE CPUS MEM DISK NODES +.br +----------------------------------------------------------------- +.br +debug 2 DRAINED 2 128 512 dev[19-20] .ec .SH "COPYING" diff --git a/doc/man/man1/slurmctld.1 b/doc/man/man1/slurmctld.1 index a7fe221ad5b..90226cbc7b4 100644 --- a/doc/man/man1/slurmctld.1 +++ b/doc/man/man1/slurmctld.1 @@ -1,4 +1,4 @@ -.TH SLURMCTLD "1" "August 2002" "slurmctld 0.1" "Slurm components" +.TH SLURMCTLD "1" "October 2002" "slurmctld 0.1" "Slurm components" .SH "NAME" slurmctld \- The central management daemon of Slurm. .SH "SYNOPSIS" @@ -73,7 +73,8 @@ configuration parameters using a distinct configuration file. However, this special configuration file will not be recognized by \fBslurmd\fR or the Slurm programs. If you desire changing communication ports, the location of the temporary file system, or other parameters used -by other Slurm components, change the common configuration file. +by other Slurm components, change the common configuration file, +\fB/etc/slurm.conf\fR. .SH "COPYING" Copyright (C) 2002 The Regents of the University of California. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). @@ -91,3 +92,8 @@ SLURM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.SH "FILES" +.LP +/etc/slurm.conf +.SH "SEE ALSO" +\fBslurm.conf\fR(5) diff --git a/doc/man/man1/slurmd.1 b/doc/man/man1/slurmd.1 index d8a456695db..3ad026c387c 100644 --- a/doc/man/man1/slurmd.1 +++ b/doc/man/man1/slurmd.1 @@ -1,4 +1,4 @@ -.TH SLURMD "1" "August 2002" "slurmctld 0.1" "Slurm components" +.TH SLURMD "1" "October 2002" "slurmctld 0.1" "Slurm components" .SH "NAME" slurmd \- The compute node daemon of Slurm. .SH "SYNOPSIS" @@ -81,3 +81,8 @@ SLURM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.SH "FILES" +.LP +/etc/slurm.conf +.SH "SEE ALSO" +\fBslurm.conf\fR(5) diff --git a/doc/man/man1/squeue.1 b/doc/man/man1/squeue.1 index abcddad26be..feb18c5e556 100644 --- a/doc/man/man1/squeue.1 +++ b/doc/man/man1/squeue.1 @@ -113,13 +113,13 @@ Specifies a comma separated list of users whose jobs or job steps are to be repo Report details of squeues actions. -.SH "EXAMPLE" +.SH "EXAMPLES" .eo -squeue -p debug -t C -o "%.6i%p" -.br -would print the jobs scheduled in the debug partition and in the +Print the jobs scheduled in the debug partition and in the completed state in the format with six right justified digits for the job id followed by the priority with an arbitrary fields size: +.br +# squeue -p debug -t C -o "%.6i%p" .br JobId Prio .br @@ -131,17 +131,17 @@ the job id followed by the priority with an arbitrary fields size: .ec .eo -squeue -s -p debug -S u +Print the job steps in the debug partition sorted by user: .br -would print the job steps in the debug partition sorted by user: +# squeue -s -p debug -S u .br -StepId Partition User StartTime Nodes + StepId Partition User StartTime Nodes .br -65552.1 debug alice 10/14-11:02 dev[1-4] + 65552.1 debug alice 10/14-11:02 dev[1-4] .br -65562.2 debug bob 10/14-11:54 dev22 + 65562.2 debug bob 10/14-11:54 dev22 .br -65550.1 debug candice 10/14-11:18 dev[10-12] + 65550.1 debug candice 10/14-11:18 dev[6-12] .ec .SH "COPYING" -- GitLab