From e2171f2221d109fcd0bc67b32f46fabf331a9a53 Mon Sep 17 00:00:00 2001 From: Moe Jette <jette1@llnl.gov> Date: Mon, 31 Mar 2008 15:47:06 +0000 Subject: [PATCH] Man page pages from Gennaro Oliva --- doc/man/man1/salloc.1 | 8 ++++++-- doc/man/man1/sbatch.1 | 6 +++++- doc/man/man1/srun.1 | 2 +- doc/man/man5/slurm.conf.5 | 6 ++++-- 4 files changed, 16 insertions(+), 6 deletions(-) diff --git a/doc/man/man1/salloc.1 b/doc/man/man1/salloc.1 index 97336593825..618bbdc4226 100644 --- a/doc/man/man1/salloc.1 +++ b/doc/man/man1/salloc.1 @@ -178,7 +178,7 @@ will be sorted my SLURM. This option will load login environment variables for the user specified in the \fB\-\-uid\fR option. The environment variables are retrieved by running something of this sort -"su - <username> -c /usr/bin/env" and parsing the output. +"su \- <username> \-c /usr/bin/env" and parsing the output. Be aware that any environment variables already set in salloc's environment will take precedence over any environment variables in the user's login environment. @@ -294,8 +294,12 @@ The options include a number representing the size of the task block. This is followed by an optional specification of the task distribution scheme within a block of tasks and between the blocks of tasks. For more details (including examples and diagrams), please see +.ad l +.nh https://computing.llnl.gov/linux/slurm/mc_support.html and https://computing.llnl.gov/linux/slurm/dist_plane.html. +.hy +.ad .TP .B arbitrary The arbitrary method of distribution will allocate processes in\-order as @@ -303,7 +307,7 @@ listed in file designated by the environment variable SLURM_HOSTFILE. If this variable is listed it will over ride any other method specified. If not set the method will default to block. Inside the hostfile must contain at minimum the number of hosts requested. If requesting tasks -(-n) your tasks will be laid out on the nodes in the order of the file. +(\-n) your tasks will be laid out on the nodes in the order of the file. .RE .TP diff --git a/doc/man/man1/sbatch.1 b/doc/man/man1/sbatch.1 index 601b4afc863..3c4b5960aab 100644 --- a/doc/man/man1/sbatch.1 +++ b/doc/man/man1/sbatch.1 @@ -318,8 +318,12 @@ The options include a number representing the size of the task block. This is followed by an optional specification of the task distribution scheme within a block of tasks and between the blocks of tasks. For more details (including examples and diagrams), please see +.ad l +.nh https://computing.llnl.gov/linux/slurm/mc_support.html and https://computing.llnl.gov/linux/slurm/dist_plane.html. +.hy +.ad .TP .B arbitrary The arbitrary method of distribution will allocate processes in\-order as @@ -327,7 +331,7 @@ listed in file designated by the environment variable SLURM_HOSTFILE. If this variable is listed it will over ride any other method specified. If not set the method will default to block. Inside the hostfile must contain at minimum the number of hosts requested. If requesting tasks -(-n) your tasks will be laid out on the nodes in the order of the file. +(\-n) your tasks will be laid out on the nodes in the order of the file. .RE .TP diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1 index c0cbe072ab2..b94d390df4d 100644 --- a/doc/man/man1/srun.1 +++ b/doc/man/man1/srun.1 @@ -1552,7 +1552,7 @@ mpirun \-np $SLURM_NPROCS \-machinefile $MACHINEFILE mpi\-app rm $MACHINEFILE -> salloc -N2 \-n4 test.sh +> salloc \-N2 \-n4 test.sh .fi .PP diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5 index fab1cf655a7..542af8b0add 100644 --- a/doc/man/man5/slurm.conf.5 +++ b/doc/man/man5/slurm.conf.5 @@ -234,12 +234,13 @@ Also see \fBAccountingStoragePort\fR and \fBJobCompPort\fR. .TP \fBDefaultStorageType\fR +.ad l Define the accounting and job completion storage mechanism type. Acceptable values at present include "filetxt", "gold", "mysql", "none", "pgsql", and "slurmdbd". The value "filetxt" indicates that records will be written to a the file. The value "gold" indicates that records will be written to Gold -(http://www.clusterresources.com/pages/products/gold-allocation-manager.ph), +(http://www.clusterresources.com/pages/products/gold-allocation-manager.php), which maintains its own database. The value "mysql" indicates that accounting records will be written to a mysql database. @@ -249,6 +250,7 @@ database. The value "slurmdbd" indicates that records will be written to SlurmDbd, which maintains its own database. See "man slurmdbd for more information". Also see \fBAccountingStorageType\fR and \fBJobCompType\fR. +.ad .TP \fBDefaultStorageUser\fR @@ -986,7 +988,7 @@ Related configuration options include \fBResumeProgram\fR, \fBResumeRate\fR, \fBSuspendTime\fR Nodes which remain idle for this number of seconds will be placed into power save mode by \fBSuspendProgram\fR, -A value of -1 disables power save mode and is the default. +A value of \-1 disables power save mode and is the default. Related configuration options include \fBResumeProgram\fR, \fBResumeRate\fR, \fBSuspendProgram\fR, \fBSuspendRate\fR, \fBSuspendExcNodes\fR, and \fBSuspendExcParts\fR. -- GitLab