From 3780ff6d32056ba64f3b3306aab80f1500155ad0 Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Thu, 12 Oct 2006 22:04:43 +0000
Subject: [PATCH] Explicitly change all hypens to minus signs.
---
doc/man/man1/sacct.1 | 136 +++++++++---------
doc/man/man1/salloc.1 | 16 +--
doc/man/man1/sattach.1 | 4 +-
doc/man/man1/sbatch.1 | 22 +--
doc/man/man1/sbcast.1 | 4 +-
doc/man/man1/scancel.1 | 2 +-
doc/man/man1/scontrol.1 | 38 ++---
doc/man/man1/sinfo.1 | 40 +++---
doc/man/man1/slaunch.1 | 36 ++---
doc/man/man1/slurm.1 | 8 +-
doc/man/man1/smap.1 | 4 +-
doc/man/man1/squeue.1 | 18 +--
doc/man/man1/srun.1 | 136 +++++++++---------
doc/man/man1/sview.1 | 4 +-
doc/man/man3/slurm_allocate_resources.3 | 18 +--
doc/man/man3/slurm_checkpoint_error.3 | 8 +-
doc/man/man3/slurm_complete_job.3 | 12 +-
doc/man/man3/slurm_free_ctl_conf.3 | 12 +-
doc/man/man3/slurm_free_job_info_msg.3 | 40 +++---
.../slurm_free_job_step_info_response_msg.3 | 28 ++--
doc/man/man3/slurm_free_node_info.3 | 40 +++---
doc/man/man3/slurm_free_partition_info.3 | 30 ++--
doc/man/man3/slurm_get_errno.3 | 4 +-
doc/man/man3/slurm_hostlist_create.3 | 8 +-
doc/man/man3/slurm_job_step_create.3 | 8 +-
doc/man/man3/slurm_kill_job.3 | 14 +-
doc/man/man3/slurm_reconfigure.3 | 14 +-
doc/man/man3/slurm_resume.3 | 8 +-
doc/man/man3/slurm_spawn.3 | 18 +--
doc/man/man5/bluegene.conf.5 | 12 +-
doc/man/man5/slurm.conf.5 | 80 +++++------
doc/man/man5/wiki.conf.5 | 6 +-
doc/man/man8/slurmctld.8 | 2 +-
doc/man/man8/slurmd.8 | 20 +--
doc/man/man8/slurmstepd.8 | 2 +-
doc/man/man8/spank.8 | 60 ++++----
36 files changed, 456 insertions(+), 456 deletions(-)
diff --git a/doc/man/man1/sacct.1 b/doc/man/man1/sacct.1
index 2c0bcef67bd..4c8813056c5 100644
--- a/doc/man/man1/sacct.1
+++ b/doc/man/man1/sacct.1
@@ -1,7 +1,7 @@
.\" $Header$
.TA "s"
.TH sacct 1
-.ds )H "Hewlett-Packard Company
+.ds )H "Hewlett\-Packard Company
.SH "NAME"
sacct
\- displays accounting data for all jobs and job steps in the SLURM job accounting log
@@ -23,7 +23,7 @@ The
command displays information on jobs, job steps, status, and exitcodes by
default.
You can tailor the output with the use of the
-\f3--fields=\fP
+\f3\-\-fields=\fP
option to specify the fields to be shown.
.PP
For the root user, the
@@ -32,15 +32,15 @@ command displays job accounting data for all users, although there are
options to filter the output to report only the jobs from a specified
user or group.
.PP
-For the non-root user, the
+For the non\-root user, the
.BR "sacct "
command limits the display of job accounting data to jobs that were
launched with their own user identifier (UID) by default.
Data for other users can be displayed with the
-\f3--all\fP,
-\f3--user\fP,
+\f3\-\-all\fP,
+\f3\-\-user\fP,
or
-\f3--uid\fP
+\f3\-\-uid\fP
options.
.TP "10"
\f3Note: \fP\c
@@ -52,14 +52,14 @@ gather and report incomplete information for these calls;
actually available on your system.
.SS "Options"
.TP "10"
-\f3\-a \fP\f3,\fP \f3--all\fP
+\f3\-a \fP\f3,\fP \f3\-\-all\fP
Displays the job accounting data for all jobs in the job accounting log file.
.IP
This is the default behavior when the
.BR "sacct "
command is executed by the root user.
.TP
-\f3\-b \fP\f3,\fP \f3--brief\fP
+\f3\-b \fP\f3,\fP \f3\-\-brief\fP
Displays a brief listing, which includes the following data:
.RS
.TP "3"
@@ -74,22 +74,22 @@ Displays a brief listing, which includes the following data:
.RE
.IP
This option has no effect when the
-\f3---dump\fP
+\f3\-\-\-dump\fP
option is also specified.
.TP
-\f3\-d \fP\f3,\fP \f3--dump\fP
+\f3\-d \fP\f3,\fP \f3\-\-dump\fP
Displays (dumps) the raw data records.
.IP
This option overrides the
-\f3--brief\fP
+\f3\-\-brief\fP
and
-\f3--fields=\fP
+\f3\-\-fields=\fP
options.
.IP
-The section titled "INTERPRETING THE --dump OPTION OUTPUT" describes the
+The section titled "INTERPRETING THE \-\-dump OPTION OUTPUT" describes the
data output when this option is used.
.TP
-\f3\-S \fP\f3,\fP \f3--stat\fP
+\f3\-S \fP\f3,\fP \f3\-\-stat\fP
.IP
Queries the status of a job as the job is running displaying
the following data:
@@ -117,21 +117,21 @@ the following data:
\f3status\fP
.RE
.IP
-You must also include the --jobs=job(.step) option if no (.step) is
+You must also include the \-\-jobs=job(.step) option if no (.step) is
given you will recieve the job.0 step.
.TP
-\f3-e \fP\f2time_spec\fP \f3,\fP \f3--expire=\fP\f2time_spec\fP
+\f3\-e \fP\f2time_spec\fP \f3,\fP \f3\-\-expire=\fP\f2time_spec\fP
.IP
Removes job data from SLURMs current accounting log file (or the file
-specified with \f3--file\fP) for jobs that completed more than
+specified with \f3\-\-file\fP) for jobs that completed more than
\f2time_spec\fP
ago and appends them to the expired log file.
.IP
If \f2time_spec\fP is an integer value only, it is interpreted as minutes. If
\f2time_spec\fP is an integer followed by "h", it is interpreted as
a number of hours. If \f2time_spec\fP is an integer followed by "d",
-it is interpreted as number of days. For example, "--expire=14d"
+it is interpreted as number of days. For example, "\-\-expire=14d"
purges the job accounting log of all jobs that completed
more than 14 days ago.
.IP
@@ -140,16 +140,16 @@ log file, with ".expired" appended to the file name. For example, if
the accounting log file is /var/log/slurmacct.log, the expired log
file will be /var/log/slurmacct.log.expired.
.TP
-\f3\-F \fP\f2field_list\fP \f3,\fP \f3--fields\fP\f3=\fP\f2field_list\fP
+\f3\-F \fP\f2field_list\fP \f3,\fP \f3\-\-fields\fP\f3=\fP\f2field_list\fP
Displays the job accounting data specified by the
\f2field_list\fP
-operand, which is a comma-separated list of fields.
+operand, which is a comma\-separated list of fields.
Space characters are not allowed in the
\f2field_list\fP\c
\&.
.IP
See the
-\f3--help-fields\fP
+\f3\-\-help\-fields\fP
option for a list of the available fields.
See the section titled "Job Accounting Fields" for a description of
each field.
@@ -162,9 +162,9 @@ Thus, the following two commands display the same data but in different order:
.PP
.nf
.ft 3
-# sacct --fields=jobid,status
+# sacct \-\-fields=jobid,status
Jobid Status
----------- ----------
+\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-
3 COMPLETED
3.0 COMPLETED
@@ -175,9 +175,9 @@ Jobid Status
.PP
.nf
.ft 3
-# sacct --fields=status,jobid
+# sacct \-\-fields=status,jobid
Status Jobid
----------- ----------
+\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-
COMPLETED 3
COMPLETED 3.0
@@ -192,38 +192,38 @@ operand is
\&.
.IP
This option has no effect when the
-\f3--dump\fP
+\f3\-\-dump\fP
option is also specified.
.TP
-\f3\-f \fP\f2file\fP\f3,\fP \f3--file\fP\f3=\fP\f2file\fP
+\f3\-f \fP\f2file\fP\f3,\fP \f3\-\-file\fP\f3=\fP\f2file\fP
Causes the
.BR "sacct "
command to read job accounting data from the named
\f2file\fP
instead of the current SLURM job accounting log file.
.TP
-\f3\-O \fP\f3,\fP \f3--formatted_dump\fP
-Dumps accounting records in an easy-to-read format.
+\f3\-O \fP\f3,\fP \f3\-\-formatted_dump\fP
+Dumps accounting records in an easy\-to\-read format.
.IP
This option is provided for debugging.
.TP
-\f3\-g \fP\f2gid\fP\f3,\fP \f3--gid\fP\f3=\fP\f2gid\fP
+\f3\-g \fP\f2gid\fP\f3,\fP \f3\-\-gid\fP\f3=\fP\f2gid\fP
Displays the statistics only for the jobs started with GID
\f2gid\fP\c
\&.
.TP
-\f3\-g \fP\f2group\fP\f3,\fP \f3--group\fP\f3=\fP\f2group\fP
+\f3\-g \fP\f2group\fP\f3,\fP \f3\-\-group\fP\f3=\fP\f2group\fP
Displays the statistics only for the jobs started by users in the
group
\f2group\fP\c
\&.
.TP
-\f3\-h \fP\f3,\fP \f3--help\fP
+\f3\-h \fP\f3,\fP \f3\-\-help\fP
Displays a general help message.
.TP
-\f3--help-fields\fP
+\f3\-\-help\-fields\fP
Displays a list of fields that can be specified with the
-\f3--fields\fP
+\f3\-\-fields\fP
option.
.RS
.PP
@@ -247,17 +247,17 @@ uid user usercpu vsize
.IP
The section titled "Job Accounting Fields" describes these fields.
.TP
-\f3\-j \fP\f2job(.step)\fP \f3,\fP \f3--jobs\fP\f3=\fP\f2job(.step)\fP
+\f3\-j \fP\f2job(.step)\fP \f3,\fP \f3\-\-jobs\fP\f3=\fP\f2job(.step)\fP
Displays information about the specified job(.step) or list of job(.step)s.
.IP
The
\f2job(.step)\fP
-parameter is a comma-separated list of jobs.
+parameter is a comma\-separated list of jobs.
Space characters are not permitted in this list.
.IP
The default is to display information on all jobs.
.TP
-\f3\-l\fP\f3,\fP \f3--long\fP
+\f3\-l\fP\f3,\fP \f3\-\-long\fP
Displays a long listing, which includes the following data:
.RS
.TP "3"
@@ -298,25 +298,25 @@ Displays a long listing, which includes the following data:
\f3exitcode\fP
.RE
.TP
-\f3--noheader\fP
+\f3\-\-noheader\fP
Prevents the display of the heading over the output.
The default action is to display a header.
.IP
This option has no effect when used with the
-\f3--dump\fP
+\f3\-\-dump\fP
option.
.TP
-\f3\-p \fP\f2partition_list\fP \f3,\fP \f3--partition\fP\f3=\fP\f2partition_list\fP
+\f3\-p \fP\f2partition_list\fP \f3,\fP \f3\-\-partition\fP\f3=\fP\f2partition_list\fP
Displays information about jobs and job steps specified by the
\f2partition_list\fP
-operand, which is a comma-separated list of partitions.
+operand, which is a comma\-separated list of partitions.
Space characters are not allowed in the
\f2partition_list\fP\c
\&.
.IP
The default is to display information on jobs and job steps on all partitions.
.TP
-\f3\-s \fP\f2state_list\fP \f3,\fP \f3--state\fP\f3=\fP\f2state_list\fP
+\f3\-s \fP\f2state_list\fP \f3,\fP \f3\-\-state\fP\f3=\fP\f2state_list\fP
Selects jobs based on their current state, which can be designated with
the following state designators:
.RS
@@ -348,29 +348,29 @@ node_fail
.IP
The
\f2state_list\fP
-operand is a comma-separated list of these state designators.
+operand is a comma\-separated list of these state designators.
Space characters are not allowed in the
\f2state_list\fP\c
\&.
.TP
-\f3\-t \fP\f3,\fP \f3--total\fP
+\f3\-t \fP\f3,\fP \f3\-\-total\fP
Displays only the cumulative statistics for each job.
Intermediate steps are displayed by default.
.TP
-\f3\-u \fP\f2uid\fP\f3,\fP \f3--uid\fP\f3=\fP\f2uid\fP
+\f3\-u \fP\f2uid\fP\f3,\fP \f3\-\-uid\fP\f3=\fP\f2uid\fP
Displays the statistics only for the jobs started by the user whose UID is
\f2uid\fP\c
\&.
.TP
-\f3\-u \fP\f2user\fP\f3,\fP \f3--user\fP\f3=\fP\f2user\fP
+\f3\-u \fP\f2user\fP\f3,\fP \f3\-\-user\fP\f3=\fP\f2user\fP
Displays the statistics only for the jobs started by user
\f2user\fP\c
\&.
.TP
-\f3--usage\fP
+\f3\-\-usage\fP
Displays a help message.
.TP
-\f3\-v \fP\f3,\fP \f3--verbose\fP
+\f3\-v \fP\f3,\fP \f3\-\-verbose\fP
Reports the state of certain variables during processing.
This option is primarily used for debugging.
.SS "Job Accounting Fields"
@@ -401,7 +401,7 @@ The format of this fields output is as follows:
.RS
.PD "0"
.HP
-\f2[DD-[hh:]]mm:ss\fP
+\f2[DD\-[hh:]]mm:ss\fP
.PD
.RE
.IP
@@ -427,7 +427,7 @@ Termination time of the job. Format output is as follows:
.RS
.PD "0"
.HP
-\f2MM/DD-hh:mm:ss\fP
+\f2MM/DD\-hh:mm:ss\fP
.PD
.RE
.IP
@@ -452,7 +452,7 @@ seconds
.TP
\f3exitcode\fP
-The first non-zero error code returned by any job step.
+The first non\-zero error code returned by any job step.
.TP
\f3gid\fP
@@ -622,11 +622,11 @@ Maximum Virtual Memory size of any process followed by its task id along with
the average of all processes running in the step.
.RE
-.SH "INTERPRETING THE -DUMP OPTION OUTPUT"
+.SH "INTERPRETING THE \-DUMP OPTION OUTPUT"
The
.BR "sacct "
commands
-\f3--dump\fP
+\f3\-\-dump\fP
option displays data in a horizontal list of fields depending on the
record type;
there are three record types:
@@ -662,7 +662,7 @@ formatted displays.
.SS "Output for the JOB_START Record Type"
The following describes the horizontal fields output by the
.BR "sacct "
-\f3--dump\fP
+\f3\-\-dump\fP
option for the
\f3JOB_START\fP
record type.
@@ -682,7 +682,7 @@ Field
.TP
4
The jobs start time;
-this value is the number of non-leap seconds since the Epoch (00:00:00
+this value is the number of non\-leap seconds since the Epoch (00:00:00
UTC, January 1, 1970)
.TP
5
@@ -724,7 +724,7 @@ Relative SLURM priority
.SS "Output for the JOB_STEP Record Type"
The following describes the horizontal fields output by the
.BR "sacct "
-\f3--dump\fP
+\f3\-\-dump\fP
option for the
\f3JOB_STEP\fP
record type.
@@ -744,7 +744,7 @@ Field
.TP
4
The jobs start time;
-this value is the number of non-leap seconds since the Epoch (00:00:00
+this value is the number of non\-leap seconds since the Epoch (00:00:00
UTC, January 1, 1970)
.TP
5
@@ -877,7 +877,7 @@ expressed in microseconds
.SS "Output for the JOB_TERMINATED Record Type"
The following describes the horizontal fields output by the
.BR "sacct "
-\f3--dump\fP
+\f3\-\-dump\fP
option for the
\f3JOB_TERMINATED\fP (literal string)
record type.
@@ -897,7 +897,7 @@ Field
.TP
4
The jobs start time;
-this value is the number of non-leap seconds since the Epoch (00:00:00
+this value is the number of non\-leap seconds since the Epoch (00:00:00
UTC, January 1, 1970)
.TP
5
@@ -915,7 +915,7 @@ Job Record Version (1)
9
The number of fields in the record (38)
.IP
-Although thirty-eight fields are displayed by the
+Although thirty\-eight fields are displayed by the
.BR "sacct "
command for the
\f3JOB_TERMINATED\fP
@@ -1043,7 +1043,7 @@ command:
.ft 3
# sacct
Jobid Jobname Partition Ncpus Status Exitcode
----------- ---------- ---------- ------- ---------- --------
+\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-
2 script01 srun 1 RUNNING 0
3 script02 srun 1 RUNNING 0
4 endscript srun 1 RUNNING 0
@@ -1060,9 +1060,9 @@ option.
.PP
.nf
.ft 3
-# sacct --brief
+# sacct \-\-brief
Jobid Status Exitcode
----------- ---------- --------
+\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-
2 RUNNING 0
3 RUNNING 0
4 RUNNING 0
@@ -1075,9 +1075,9 @@ Jobid Status Exitcode
.PP
.nf
.ft 3
-# sacct --total
+# sacct \-\-total
Jobid Jobname Partition Ncpus Status Exitcode
----------- ---------- ---------- ------- ---------- --------
+\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-
3 sja_init andy 1 COMPLETED 0
4 sjaload andy 2 COMPLETED 0
5 sja_scr1 andy 1 COMPLETED 0
@@ -1099,9 +1099,9 @@ The fields are displayed in the order designated on the command line.
.PP
.nf
.ft 3
-# sacct --fields=jobid,ncpus,ntasks,nsignals,status
+# sacct \-\-fields=jobid,ncpus,ntasks,nsignals,status
Jobid Ncpus Ntasks Nsignals Status
----------- ------- ------- --------- ----------
+\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\- \-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-
3 2 1 0 COMPLETED
3.0 2 1 0 COMPLETED
4 2 2 0 COMPLETED
@@ -1114,7 +1114,7 @@ Jobid Ncpus Ntasks Nsignals Status
.RE
.SH "COPYING"
-Copyright (C) 2005 Copyright Hewlett-Packard Development Company L.P.
+Copyright (C) 2005 Copyright Hewlett\-Packard Development Company L.P.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/salloc.1 b/doc/man/man1/salloc.1
index 262fd7b5c57..e0369825b06 100644
--- a/doc/man/man1/salloc.1
+++ b/doc/man/man1/salloc.1
@@ -96,7 +96,7 @@ partition as designated by the system administrator.
.TP
\fB\-\-contiguous\fR
Demand a contiguous range of nodes. The default is "yes". Specify
---contiguous=no if a contiguous range of nodes is not required.
+\-\-contiguous=no if a contiguous range of nodes is not required.
.TP
\fB\-\-mail\-type\fR=\fItype\fR
@@ -134,9 +134,9 @@ just try to allocate one processor per task.
For instance,
consider an application that has 4 tasks, each requiring 3 processors. If our
-cluster is comprised of quad-processors nodes and we simply ask for
+cluster is comprised of quad\-processors nodes and we simply ask for
12 processors, the controller might give us only 3 nodes. However, by using
-the --cpus-per-task=3 options, the controller knows that each task requires
+the \-\-cpus\-per\-task=3 options, the controller knows that each task requires
3 processors on the same node, and the controller will grant an allocation
of 4 nodes, one for each of the 4 tasks.
@@ -238,13 +238,13 @@ Time may be of the form \fIHH:MM:SS\fR to run a job at
a specific time of day (seconds are optional).
(If that time is already past, the next day is assumed.)
You may also specify \fImidnight\fR, \fInoon\fR, or
-\fIteatime\fR (4pm) and you can have a time-of-day suffixed
+\fIteatime\fR (4pm) and you can have a time\-of\-day suffixed
with \fIAM\fR or \fIPM\fR for running in the morning or the evening.
You can also say what day the job will be run, by giving
-a date in the form \fImonth-name\fR day with an optional year,
+a date in the form \fImonth\-name\fR day with an optional year,
or giving a date of the form \fIMMDDYY\fR or \fIMM/DD/YY\fR
or \fIDD.MM.YY\fR. You can also
-give times like \fInow + count time-units\fR, where the time-units
+give times like \fInow + count time\-units\fR, where the time\-units
can be \fIminutes\fR, \fIhours\fR, \fIdays\fR, or \fIweeks\fR
and you can tell SLURM to run the job today with the keyword
\fItoday\fR and to run the job tomorrow with the keyword
@@ -338,7 +338,7 @@ Same as \fB\-v\fR or \fB\-\-verbose\fR.
Same as \fB\-g\fR or \fB\-\-geometry\fR.
.TP
\fBSALLOC_IMMEDIATE\fR
-Same as \fB-I\fR or \fB\-\-immediate\fR.
+Same as \fB\-I\fR or \fB\-\-immediate\fR.
.TP
\fBSALLOC_JOBID\fR
Same as \fB\-\-jobid\fR.
@@ -379,7 +379,7 @@ salloc \-N5 slaunch \-n10 myprogram
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/sattach.1 b/doc/man/man1/sattach.1
index 2bbe76d3eac..b3a495aecb8 100644
--- a/doc/man/man1/sattach.1
+++ b/doc/man/man1/sattach.1
@@ -64,12 +64,12 @@ Display SLURM version number and exit.
.LP
sattach 15.0
-sattach --output-filter 5 65386.15
+sattach \-\-output\-filter 5 65386.15
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/sbatch.1 b/doc/man/man1/sbatch.1
index 9422fc4a86a..fcf13856ecf 100644
--- a/doc/man/man1/sbatch.1
+++ b/doc/man/man1/sbatch.1
@@ -91,7 +91,7 @@ partition as designated by the system administrator.
.TP
\fB\-\-contiguous\fR
Demand a contiguous range of nodes. The default is "yes". Specify
---contiguous=no if a contiguous range of nodes is not required.
+\-\-contiguous=no if a contiguous range of nodes is not required.
.TP
\fB\-\-mail\-type\fR=\fItype\fR
@@ -136,9 +136,9 @@ just try to allocate one processor per task.
For instance,
consider an application that has 4 tasks, each requiring 3 processors. If our
-cluster is comprised of quad-processors nodes and we simply ask for
+cluster is comprised of quad\-processors nodes and we simply ask for
12 processors, the controller might give us only 3 nodes. However, by using
-the --cpus-per-task=3 options, the controller knows that each task requires
+the \-\-cpus\-per\-task=3 options, the controller knows that each task requires
3 processors on the same node, and the controller will grant an allocation
of 4 nodes, one for each of the 4 tasks.
@@ -217,7 +217,7 @@ in the "\fIfilename pattern\fR".
By default, "/dev/null" is open on the batch script's standard input and both
standard output and standard error are directed to a file of the name
-"slurm-%j.out", where the "%j" is replaced with the job allocation number, as
+"slurm\-%j.out", where the "%j" is replaced with the job allocation number, as
described below.
The filename pattern may contain one or more replacement symbols, which are
@@ -233,7 +233,7 @@ Job allocation number.
.TP
\fB%N\fR
Node name. (Will result in a separate file per node.)
-.RS -10
+.RS \-10
.TP
\fB\-U\fR, \fB\-\-account\fR[=]<\fIaccount\fR>
@@ -251,13 +251,13 @@ Time may be of the form \fIHH:MM:SS\fR to run a job at
a specific time of day (seconds are optional).
(If that time is already past, the next day is assumed.)
You may also specify \fImidnight\fR, \fInoon\fR, or
-\fIteatime\fR (4pm) and you can have a time-of-day suffixed
+\fIteatime\fR (4pm) and you can have a time\-of\-day suffixed
with \fIAM\fR or \fIPM\fR for running in the morning or the evening.
You can also say what day the job will be run, by giving
-a date in the form \fImonth-name\fR day with an optional year,
+a date in the form \fImonth\-name\fR day with an optional year,
or giving a date of the form \fIMMDDYY\fR or \fIMM/DD/YY\fR
or \fIDD.MM.YY\fR. You can also
-give times like \fInow + count time-units\fR, where the time-units
+give times like \fInow + count time\-units\fR, where the time\-units
can be \fIminutes\fR, \fIhours\fR, \fIdays\fR, or \fIweeks\fR
and you can tell SLURM to run the job today with the keyword
\fItoday\fR and to run the job tomorrow with the keyword
@@ -352,13 +352,13 @@ Same as \fB\-v\fR or \fB\-\-verbose\fR.
Same as \fB\-g\fR or \fB\-\-geometry\fR.
.TP
\fBSBATCH_IMMEDIATE\fR
-Same as \fB-I\fR or \fB\-\-immediate\fR.
+Same as \fB\-I\fR or \fB\-\-immediate\fR.
.TP
\fBSBATCH_JOBID\fR
Same as \fB\-\-jobid\fR.
.TP
\fBSBATCH_JOB_NAME\fR
-Same as \fB-J\fR or \fB\-\-job\-name\fR.
+Same as \fB\-J\fR or \fB\-\-job\-name\fR.
.TP
\fBSBATCH_NO_REQUEUE\fR
Same as \fB\-\-no\-requeue\fR.
@@ -422,7 +422,7 @@ host4
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/sbcast.1 b/doc/man/man1/sbcast.1
index 417bd229126..55926f0c9b0 100644
--- a/doc/man/man1/sbcast.1
+++ b/doc/man/man1/sbcast.1
@@ -82,14 +82,14 @@ Using a batch script, transmit local file \fBmy.prog\fR to
sbcast my.prog /tmp/my.prog
srun /tmp/my.prog
-> srun --nodes=8 --batch my.job
+> srun \-\-nodes=8 \-\-batch my.job
srun: jobid 12345 submitted
.fi
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/scancel.1 b/doc/man/man1/scancel.1
index 6adde211abc..046b3fc4dbd 100644
--- a/doc/man/man1/scancel.1
+++ b/doc/man/man1/scancel.1
@@ -114,7 +114,7 @@ scancel \-\-state=PENDING \-\-user=bob \-\-partition=debug
.SH "COPYING"
Copyright (C) 2002 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/scontrol.1 b/doc/man/man1/scontrol.1
index 345a2596ac9..2d45138bd84 100644
--- a/doc/man/man1/scontrol.1
+++ b/doc/man/man1/scontrol.1
@@ -15,8 +15,8 @@ entered on the execute line, \fBscontrol\fR will operate in an interactive
mode and prompt for input. It will continue prompting for input and executing
commands until explicitly terminated. If a command is entered on the execute
line, \fBscontrol\fR will execute that command and terminate. All commands
-and options are case-insensitive, although node names and partition names
-are case-sensitive (node names "LX" and "lx" are distinct). Commands can
+and options are case\-insensitive, although node names and partition names
+are case\-sensitive (node names "LX" and "lx" are distinct). Commands can
be abbreviated to the extent that the specification is unique.
.TP
@@ -42,8 +42,8 @@ Print information one line per record.
\fB\-q\fR, \fB\-\-quiet\fR
Print no warning or informational messages, only fatal error messages.
.TP
-\fB-v\fR, \fB\-\-verbose\fR
-Print detailed event logging. This includes time-stamps on data structures,
+\fB\-v\fR, \fB\-\-verbose\fR
+Print detailed event logging. This includes time\-stamps on data structures,
record counts, etc.
.TP
\fB\-V\fR , \fB\-\-version\fR
@@ -112,7 +112,7 @@ Print no warning or informational messages, only fatal error messages.
Terminate the execution of scontrol.
.TP
\fIreconfigure\fP
-Instruct all Slurm daemons to re-read the configuration file.
+Instruct all Slurm daemons to re\-read the configuration file.
This command does not restart the daemons.
This mechanism would be used to modify configuration parameters (Epilog,
Prolog, SlurmctldLogFile, SlurmdLogFile, etc.) register the physical
@@ -141,7 +141,7 @@ entity: the configuration parameter name, job ID, node name, partition name,
or job step ID for entities \fIconfig\fP, \fIjob\fP, \fInode\fP, \fIpartition\fP,
and \fIstep\fP respectively.
Multiple node names may be specified using simple node range expressions
-(e.g. "lx[10-20]"). All other \fIID\fP values must identify a single
+(e.g. "lx[10\-20]"). All other \fIID\fP values must identify a single
element. The job step ID is of the form "job_id.step_id", (e.g. "1234.1").
By default, all elements of the entity type specified are printed.
.TP
@@ -162,7 +162,7 @@ Update job, node or partition configuration per the supplied specification.
\fISPECIFICATION\fP is in the same format as the Slurm configuration file
and the output of the \fIshow\fP command described above. It may be desirable
to execute the \fIshow\fP command (described above) on the specific entity
-you which to update, then use cut-and-paste tools to enter updated configuration
+you which to update, then use cut\-and\-paste tools to enter updated configuration
values to the \fIupdate\fP. Note that while most configuration values can be
changed using this command, not all can be changed using this mechanism. In
particular, the hardware configuration of a node or the physical addition or
@@ -171,7 +171,7 @@ the Slurm configuration file and executing the \fIreconfigure\fP command
(described above).
.TP
\fIverbose\fP
-Print detailed event logging. This includes time-stamps on data structures,
+Print detailed event logging. This includes time\-stamps on data structures,
record counts, etc.
.TP
\fIversion\fP
@@ -237,7 +237,7 @@ Set the job's partition to the specified value.
Set the job's priority to the specified value.
Note that a job priority of zero prevents the job from ever being scheduled.
By setting a job's priority to zero it is held.
-Set the priority to a non-zero value to permit it to run.
+Set the priority to a non\-zero value to permit it to run.
.TP
\fINice\fP[=delta]
Adjust job's priority by the specified value. Default value is 100.
@@ -247,7 +247,7 @@ Set the job's count of required processes to the specified value.
.TP
\fIReqNodeList\fP=<nodes>
Set the job's list of required node. Multiple node names may be specified using
-simple node range expressions (e.g. "lx[10-20]").
+simple node range expressions (e.g. "lx[10\-20]").
Value may be cleared with blank data value, "ReqNodeList=".
.TP
\fIReqNodes\fP=<count>
@@ -272,13 +272,13 @@ It accepts times of the form \fIHH:MM:SS\fR to run a job at
a specific time of day (seconds are optional).
(If that time is already past, the next day is assumed.)
You may also specify \fImidnight\fR, \fInoon\fR, or
-\fIteatime\fR (4pm) and you can have a time-of-day suffixed
+\fIteatime\fR (4pm) and you can have a time\-of\-day suffixed
with \fIAM\fR or \fIPM\fR for running in the morning or the evening.
You can also say what day the job will be run, by giving
-a date in the form \fImonth-name\fR day with an optional year,
+a date in the form \fImonth\-name\fR day with an optional year,
or giving a date of the form \fIMMDDYY\fR or \fIMM/DD/YY\fR
or \fIDD.MM.YY\fR. You can also
-give times like \fInow + count time-units\fR, where the time-units
+give times like \fInow + count time\-units\fR, where the time\-units
can be \fIminutes\fR, \fIhours\fR, \fIdays\fR, or \fIweeks\fR
and you can tell SLURM to run the job today with the keyword
\fItoday\fR and to run the job tomorrow with the keyword
@@ -307,7 +307,7 @@ Possible values are "YES" and "NO".
.TP
\fINodeName\fP=<name>
Identify the node(s) to be updated. Multiple node names may be specified using
-simple node range expressions (e.g. "lx[10-20]"). This specification is required.
+simple node range expressions (e.g. "lx[10\-20]"). This specification is required.
.TP
\fIReason\fP=<reason>
Identify the reason the node is in a "DOWN" or "DRAINED" or "DRAINING" state.
@@ -340,7 +340,7 @@ Possible values are"YES" and "NO".
.TP
\fINodes\fP=<name>
Identify the node(s) to be associated with this partition. Multiple node names
-may be specified using simple node range expressions (e.g. "lx[10-20]").
+may be specified using simple node range expressions (e.g. "lx[10\-20]").
Note that jobs may only be associated with one partition at any time.
Specify a blank data value to remove all nodes from a partition: "Nodes=".
.TP
@@ -349,7 +349,7 @@ Identify the partition to be updated. This specification is required.
.TP
\fIRootOnly\fP=<yes|no>
Specify if only allocation requests initiated by user root will be satisfied.
-This can be used to restrict control of the partition to some meta-scheduler.
+This can be used to restrict control of the partition to some meta\-scheduler.
Possible values are"YES" and "NO".
.TP
\fIShared\fP=<yes|no|force>
@@ -410,7 +410,7 @@ PartitionName=class TotalNodes=10 TotalCPUs=20 RootOnly=NO
.br
MinNodes=1 MaxNodes=2 AllowGroups=students
.br
- Nodes=lx[0031-0040] NodeIndices=31,40,-1
+ Nodes=lx[0031\-0040] NodeIndices=31,40,\-1
.br
scontrol: update PartitionName=class MaxTime=99 MaxNodes=4
.br
@@ -424,7 +424,7 @@ JobId=65539 UserId=1500 JobState=PENDING TimeLimit=100
.br
ReqNodes=400 Contiguous=1 MinProcs=4 MinMemory=1024
.br
- MinTmpDisk=2034ReqNodeList=lx[3000-3003]
+ MinTmpDisk=2034ReqNodeList=lx[3000\-3003]
.br
Features=(null) JobScript=/bin/hostname
.br
@@ -436,7 +436,7 @@ scontrol: quit
.SH "COPYING"
Copyright (C) 2002 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/sinfo.1 b/doc/man/man1/sinfo.1
index 8ca1ce14e50..9e296457280 100644
--- a/doc/man/man1/sinfo.1
+++ b/doc/man/man1/sinfo.1
@@ -55,11 +55,11 @@ This is ignored if the \fB\-\-format\fR option is specified.
\fB\-n <nodes>\fR, \fB\-\-nodes=<nodes>\fR
Print information only about the specified node(s).
Multiple nodes may be comma separated or expressed using a
-node range expression. For example "linux[00-07]" would
+node range expression. For example "linux[00\-07]" would
indicate eight nodes, "linux00" through "linux07."
.TP
\fB\-N\fR, \fB\-\-Node\fR
-Print information in a node-oriented format.
+Print information in a node\-oriented format.
The default is to print information in a partition\-oriented format.
This is ignored if the \fB\-\-format\fR option is specified.
.TP
@@ -396,56 +396,56 @@ Report basic node and partition configurations:
> sinfo
PARTITION AVAIL TIMELIMIT NODES STATE NODELIST
-batch up infinite 2 alloc adev[8-9]
-batch up infinite 6 idle adev[10-15]
-debug* up 30:00 8 idle adev[0-7]
+batch up infinite 2 alloc adev[8\-9]
+batch up infinite 6 idle adev[10\-15]
+debug* up 30:00 8 idle adev[0\-7]
.fi
Report partition summary information:
.nf
-> sinfo -s
+> sinfo \-s
PARTITION AVAIL TIMELIMIT NODES(A/I/O/T) NODELIST
-batch up infinite 2/6/0/8 adev[8-15]
-debug* up 30:00 0/8/0/8 adev[0-7]
+batch up infinite 2/6/0/8 adev[8\-15]
+debug* up 30:00 0/8/0/8 adev[0\-7]
.fi
Report more complete information about the partition debug:
.nf
-> sinfo --long --partition=debug
+> sinfo \-\-long \-\-partition=debug
PARTITION AVAIL TIMELIMIT JOB_SIZE ROOT SHARE GROUPS NODES STATE NODELIST
-debug* up 30:00 8 no no all 8 idle dev[0-7]
+debug* up 30:00 8 no no all 8 idle dev[0\-7]
.fi
Report only those nodes that are in state DRAINED:
.nf
-> sinfo --states=drained
+> sinfo \-\-states=drained
PARTITION AVAIL NODES TIMELIMIT STATE NODELIST
-debug* up 2 30:00 drain adev[6-7]
+debug* up 2 30:00 drain adev[6\-7]
.fi
-Report node-oriented information with details and exact matches:
+Report node\-oriented information with details and exact matches:
.nf
-> sinfo -Nel
+> sinfo \-Nel
NODELIST NODES PARTITION STATE CPUS MEMORY TMP_DISK WEIGHT FEATURES REASON
-adev[0-1] 2 debug* idle 2 3448 38536 16 (null) (null)
-adev[2,4-7] 5 debug* idle 2 3384 38536 16 (null) (null)
+adev[0\-1] 2 debug* idle 2 3448 38536 16 (null) (null)
+adev[2,4\-7] 5 debug* idle 2 3384 38536 16 (null) (null)
adev3 1 debug* idle 2 3394 38536 16 (null) (null)
-adev[8-9] 2 batch allocated 2 246 82306 16 (null) (null)
-adev[10-15] 6 batch idle 2 246 82306 16 (null) (null)
+adev[8\-9] 2 batch allocated 2 246 82306 16 (null) (null)
+adev[10\-15] 6 batch idle 2 246 82306 16 (null) (null)
.fi
Report only down, drained and draining nodes and their reason field:
.nf
-> sinfo -R
+> sinfo \-R
REASON NODELIST
Memory errors dev[0,5]
Not Responding dev8
@@ -456,7 +456,7 @@ Not Responding dev8
.SH "COPYING"
Copyright (C) 2002\-2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/slaunch.1 b/doc/man/man1/slaunch.1
index 31f7125ddec..79e83c49933 100644
--- a/doc/man/man1/slaunch.1
+++ b/doc/man/man1/slaunch.1
@@ -44,8 +44,8 @@ name of the executable which slaunch is launching.
.TP
\fB\-K\fR, \fB\-\-kill\-on\-bad\-exit\fR
-Terminate the job step if any task exits with a non-zero exit code. By default
-slaunch will not terminate a job step because of a task with a non-zero exit
+Terminate the job step if any task exits with a non\-zero exit code. By default
+slaunch will not terminate a job step because of a task with a non\-zero exit
code.
.TP
@@ -74,7 +74,7 @@ Increase the verbosity of slaunch's informational messages. Multiple \-v's
will further increase slaunch's verbosity.
.TP
-\fB\-d\fR, \fB\-\-slurmd-debug\fR[=]<\fIlevel\fR>
+\fB\-d\fR, \fB\-\-slurmd\-debug\fR[=]<\fIlevel\fR>
Specify a debug level for slurmd(8). \fIlevel\fR may be an integer value
between 0 [quiet, only errors are displayed] and 4 [verbose operation].
The slurmd debug information is copied onto the stderr of
@@ -96,12 +96,12 @@ Select a task distribution pattern. (The default is cyclic.)
.RS
.TP
.B cyclic
-The cyclic method distributes processes in a round-robin fashion across
+The cyclic method distributes processes in a round\-robin fashion across
the allocated nodes. That is, task zero will be allocated to the first
node, task one to the second, and so on.
.TP
.B block
-The block method of distribution will allocate tasks in-order to
+The block method of distribution will allocate tasks in\-order to
the cpus on a node. If the number of tasks exceeds the number of
cpus on all of the nodes in the allocation then all nodes will be
utilized. For example, consider an allocation of three nodes each with
@@ -192,7 +192,7 @@ Job allocation number.
.TP
\fB%s\fR
Job step number.
-.RS -10
+.RS \-10
.TP
\fB\-\-slaunch\-input\-filter\fR[=]<\fItask number\fR>
@@ -207,7 +207,7 @@ Only transmit standard input to a single task, or print the standard output
or standard error from a single task. These options perform the filtering
locally in slaunch. All tasks are still capable of sending or receiving
standard IO over the network, so the "sattach" command can still access the
-standard IO streams of the other tasks. (NOTE: for -output and -error,
+standard IO streams of the other tasks. (NOTE: for \-output and \-error,
the streams from all tasks WILL be transmitted to slaunch, but it will only
print the streams for the selected task. If your tasks print a great deal of
data to standard output or error, this can be performance limiting.)
@@ -265,7 +265,7 @@ Relative node index number within the job step. All nodes used by the job step
.TP
\fB%t\fR
Task rank number. (Will result in a separate file per task.)
-.RS -10
+.RS \-10
.TP
\fB\-D\fR, \fB\-\-workdir\fR[=]<\fIdirectory\fR>
@@ -337,7 +337,7 @@ for the task being spawned.
\fB\-\-task\-epilog\fR[=]<\fIexecutable\fR>
The \fBslurmd\fR daemon will run \fIexecutable\fR just after each task
terminates. This will be before after any TaskEpilog parameter
-in slurm.conf is executed. This is meant to be a very short-lived
+in slurm.conf is executed. This is meant to be a very short\-lived
program. If it fails to terminate within a few seconds, it will
be killed along with any descendant processes.
@@ -382,7 +382,7 @@ Display brief usage message and exit.
Display version information and exit.
.PP
-Affinity/Multi-core Options (when the task/affinity or task/numa
+Affinity/Multi\-core Options (when the task/affinity or task/numa
plugin is enabled):
.TP
\fB\-\-cpu_bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR
@@ -432,7 +432,7 @@ successive srun commands, first do the following in each task:
.fi
.PP
-Affinity/Multi-core Options (when the task/affinity plugin is enabled and
+Affinity/Multi\-core Options (when the task/affinity plugin is enabled and
the NUMA memory functions are available):
.TP
\fB\-\-mem_bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR
@@ -559,8 +559,8 @@ Arguments
Program arguments.
The expression "%t" will be replaced with the task's number.
The expression "%o" will be replaced with the task's offset within
-this range (e.g. a configured task rank value of "1-5" would
-have offset values of "0-4").
+this range (e.g. a configured task rank value of "1\-5" would
+have offset values of "0\-4").
Single quotes may be used to avoid having the enclosed values interpretted.
This field is optional.
.PP
@@ -569,13 +569,13 @@ For example:
###################################################################
# srun multiple program configuration file
#
-# srun -n8 -l --multi-prog silly.conf
+# srun \-n8 \-l \-\-multi\-prog silly.conf
###################################################################
-4-6 hostname
+4\-6 hostname
1,7 echo task:%t
-0,2-3 echo offset:%o
+0,2\-3 echo offset:%o
-$ srun -n8 -l --multi-prog silly.conf
+$ srun \-n8 \-l \-\-multi\-prog silly.conf
0: offset:0
1: task:1
2: offset:1
@@ -601,7 +601,7 @@ salloc \-N5 slaunch \-n10 myprogram
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/slurm.1 b/doc/man/man1/slurm.1
index 82c8fc0765e..4e27f3f9a17 100644
--- a/doc/man/man1/slurm.1
+++ b/doc/man/man1/slurm.1
@@ -5,10 +5,10 @@ slurm \- SLURM system overview.
.SH "DESCRIPTION"
The Simple Linux Utility for Resource Management (SLURM) is an open source,
-fault-tolerant, and highly scalable cluster management and job scheduling system
+fault\-tolerant, and highly scalable cluster management and job scheduling system
for large and small Linux clusters. SLURM requires no kernel modifications for
-its operation and is relatively self-contained. As a cluster resource manager,
-SLURM has three key functions. First, it allocates exclusive and/or non-exclusive
+its operation and is relatively self\-contained. As a cluster resource manager,
+SLURM has three key functions. First, it allocates exclusive and/or non\-exclusive
access to resources (compute nodes) to users for some duration of time so they
can perform work. Second, it provides a framework for starting, executing, and
monitoring work (normally a parallel job) on the set of allocated nodes. Finally,
@@ -37,7 +37,7 @@ Extensive documenation is also available on the internet at
.SH "COPYING"
Copyright (C) 2005 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/smap.1 b/doc/man/man1/smap.1
index 2fa5fd1588f..d58131293f3 100644
--- a/doc/man/man1/smap.1
+++ b/doc/man/man1/smap.1
@@ -63,7 +63,7 @@ Do not print a header on the output.
Print output to the commandline, no curses.
.TP
\fB\-p\fR, \fB\-\-parse\fR
-Used with -c commandline option. Don't format output send only single
+Used with \-c commandline option. Don't format output send only single
tab delimited output to stdout.
.TP
\fB\-i <seconds>\fR , \fB\-\-iterate=<seconds>\fR
@@ -412,7 +412,7 @@ The location of the SLURM configuration file.
.SH "COPYING"
Copyright (C) 2004\-2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/squeue.1 b/doc/man/man1/squeue.1
index 9a5acc0b382..6de63f015cd 100644
--- a/doc/man/man1/squeue.1
+++ b/doc/man/man1/squeue.1
@@ -376,7 +376,7 @@ 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 COMPLETED -o "%.6i %p"
+# squeue \-p debug \-t COMPLETED \-o "%.6i %p"
.br
JOBID PRIORITY
.br
@@ -390,25 +390,25 @@ the job id followed by the priority with an arbitrary fields size:
.eo
Print the job steps in the debug partition sorted by user:
.br
-# squeue -s -p debug -S u
+# squeue \-s \-p debug \-S u
.br
STEPID NAME PARTITION USER TIME_USED NODELIST(REASON)
.br
- 65552.1 test1 debug alice 0:23 dev[1-4]
+ 65552.1 test1 debug alice 0:23 dev[1\-4]
.br
65562.2 big_run debug bob 0:18 dev22
.br
- 65550.1 param1 debug candice 1:43:21 dev[6-12]
+ 65550.1 param1 debug candice 1:43:21 dev[6\-12]
.ec
.eo
Print information only about jobs 12345,12345, and 12348:
.br
-# squeue --jobs 12345,12346,12348
+# squeue \-\-jobs 12345,12346,12348
.br
JOBID PARTITION NAME USER ST TIME_USED NODES NODELIST(REASON)
.br
- 12345 debug job1 dave R 0:21 4 dev[9-12]
+ 12345 debug job1 dave R 0:21 4 dev[9\-12]
.br
12346 debug job2 dave PD 0:00 8 (Resources)
.br
@@ -418,17 +418,17 @@ Print information only about jobs 12345,12345, and 12348:
.eo
Print information only about job step 65552.1:
.br
-# squeue --steps 65552.1
+# squeue \-\-steps 65552.1
.br
STEPID NAME PARTITION USER TIME_USED NODELIST(REASON)
.br
- 65552.1 test2 debug alice 12:49 dev[1-4]
+ 65552.1 test2 debug alice 12:49 dev[1\-4]
.ec
.SH "COPYING"
Copyright (C) 2002\-2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1
index 86a5079aae4..9c552c32406 100644
--- a/doc/man/man1/srun.1
+++ b/doc/man/man1/srun.1
@@ -44,7 +44,7 @@ on each node. Examples of this include submitting
a hybrid MPI/OpenMP app where only one MPI "task/rank" should be
assigned to each node while allowing the OpenMP portion to utilize
all of the parallelism present in the node, or submitting a single
-setup/cleanup/monitoring job to each node of a pre-existing
+setup/cleanup/monitoring job to each node of a pre\-existing
allocation as one step in a larger job script.
.TP
\fB\-N\fR, \fB\-\-nodes\fR=\fIminnodes\fR[\-\fImaxnodes\fR]
@@ -83,12 +83,12 @@ options if desired:
When the task/affinity plugin is enabled,
specifying an allocation in this manner also instructs SLURM to use
a CPU affinity mask to guarantee the request is filled as specified.
-See the "Affinity/Multi-core options" below for more details.
+See the "Affinity/Multi\-core options" below for more details.
.TP
\fB\-r\fR, \fB\-\-relative\fR=\fIn\fR
Run a job step relative to node \fIn\fR of the current allocation.
This option may be used to spread several job steps out among the
-nodes of the current job. If \fB-r\fR is used, the current job
+nodes of the current job. If \fB\-r\fR is used, the current job
step will begin at node \fIn\fR of the allocated nodelist, where
the first node is considered node 0. The \fB\-r\fR option is not
permitted along with \fB\-w\fR or \fB\-x\fR, and will be silently
@@ -113,7 +113,7 @@ The value may be changed after job submission using the
\fB\-\-nice\fR[=\fIadjustment]\fR
Run the job with an adjusted scheduling priority.
With no adjustment value the scheduling priority is decreased
-by 100. The adjustment range is from -10000 (highest priority)
+by 100. The adjustment range is from \-10000 (highest priority)
to 10000 (lowest priority). Only privileged users can specify
a negative adjustment. NOTE: This option is presently
ignored if \fISchedulerType=sched/maui\fR.
@@ -133,13 +133,13 @@ It accepts times of the form \fIHH:MM:SS\fR to run a job at
a specific time of day (seconds are optional).
(If that time is already past, the next day is assumed.)
You may also specify \fImidnight\fR, \fInoon\fR, or
-\fIteatime\fR (4pm) and you can have a time-of-day suffixed
+\fIteatime\fR (4pm) and you can have a time\-of\-day suffixed
with \fIAM\fR or \fIPM\fR for running in the morning or the evening.
You can also say what day the job will be run, by giving
-a date in the form \fImonth-name\fR day with an optional year,
+a date in the form \fImonth\-name\fR day with an optional year,
or giving a date of the form \fIMMDDYY\fR or \fIMM/DD/YY\fR
or \fIDD.MM.YY\fR. You can also
-give times like \fInow + count time-units\fR, where the time-units
+give times like \fInow + count time\-units\fR, where the time\-units
can be \fIminutes\fR, \fIhours\fR, \fIdays\fR, or \fIweeks\fR
and you can tell SLURM to run the job today with the keyword
\fItoday\fR and to run the job tomorrow with the keyword
@@ -191,7 +191,7 @@ default action is to terminate job upon node failure. Note that
process of initiating it.
.TP
\fB\-K\fR, \fB\-\-kill\-on\-bad\-exit\fR
-Terminate a job if any task exits with a non-zero exit code.
+Terminate a job if any task exits with a non\-zero exit code.
.TP
\fB\-s\fR, \fB\-\-share\fR
The job can share nodes with other running jobs. This may result in faster job
@@ -218,12 +218,12 @@ default value is the smaller of 32 or the number of nodes allocated.
.TP
\fB\-l\fR, \fB\-\-label\fR
prepend task number to lines of stdout/err. Normally, stdout and stderr
-from remote tasks is line-buffered directly to the stdout and stderr of
+from remote tasks is line\-buffered directly to the stdout and stderr of
\fBsrun\fR.
The \fB\-\-label\fR option will prepend lines of output with the remote
task id.
.TP
-\fB-u\fR, \fB\-\-unbuffered\fR
+\fB\-u\fR, \fB\-\-unbuffered\fR
do not line buffer stdout from remote tasks. This option cannot be used
with \fI\-\-label\fR.
.TP
@@ -232,7 +232,7 @@ Specify an alternate distribution method for remote processes.
.RS
.TP
.B block
-The block method of distribution will allocate processes in-order to
+The block method of distribution will allocate processes in\-order to
the cpus on a node. If the number of processes exceeds the number of
cpus on all of the nodes in the allocation then all nodes will be
utilized. For example, consider an allocation of three nodes each with
@@ -243,13 +243,13 @@ Block distribution is the default behavior if the number of tasks
exceeds the number of nodes requested.
.TP
.B cyclic
-The cyclic method distributes processes in a round-robin fashion across
+The cyclic method distributes processes in a round\-robin fashion across
the allocated nodes. That is, process one will be allocated to the first
node, process two to the second, and so on. This is the default behavior
if the number of tasks is no larger than the number of nodes requested.
.TP
.B hostfile
-The hostfile method of distribution will allocate processes in-order as
+The hostfile method of distribution will allocate processes in\-order as
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.
@@ -342,8 +342,8 @@ job and must contain \fBsrun\fR commands to initiate parallel tasks.
stdin will be redirected from /dev/null, stdout and stderr will be
redirected to a file (default is \fIjobname\fR.out or \fIjobid\fR.out in
current working directory, see \fB\-o\fR for other IO options).
-Note that if the slurm daemons are cold-started, jobid values will be
-reused. Plan accordingly to avoid over-writing output and error files.
+Note that if the slurm daemons are cold\-started, jobid values will be
+reused. Plan accordingly to avoid over\-writing output and error files.
\fIexecutable\fR must be specified using either a fully qualified
pathname or its pathname will be relative to the current working directory.
The search path will not be used to locate the file. \fIexecutable\fR
@@ -357,7 +357,7 @@ the option with #SLURM. Multiple options can be on one line or multiple lines.
i.e.
.br
-#SLURM -N 2 -n 2
+#SLURM \-N 2 \-n 2
.br
#SLURM \-\-mpi=lam
.br
@@ -371,10 +371,10 @@ Options on the command line take precedence over options in the batch
script, which in turn take precedence over exiting environmement variables.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
-verbose operation. Multiple \fB-v\fR's will further increase the verbosity of
+verbose operation. Multiple \fB\-v\fR's will further increase the verbosity of
\fBsrun\fR. By default only errors will be displayed.
.TP
-\fB\-d\fR, \fB\-\-slurmd-debug\fR=\fIlevel\fR
+\fB\-d\fR, \fB\-\-slurmd\-debug\fR=\fIlevel\fR
Specify a debug level for slurmd(8). \fIlevel\fR may be an integer value
between 0 [quiet, only errors are displayed] and 4 [verbose operation].
The slurmd debug information is copied onto the stderr of
@@ -389,15 +389,15 @@ option can be useful to insure that a job is terminated in a timely fashion
in the event that one or more tasks terminate prematurely.
.TP
\fB\-q\fR, \fB\-\-quit\-on\-interrupt\fR
-Quit immediately on single SIGINT (Ctrl-C). Use of this option
+Quit immediately on single SIGINT (Ctrl\-C). Use of this option
disables the status feature normally available when \fBsrun\fR receives
-a single Ctrl-C and causes \fBsrun\fR to instead immediately terminate the
+a single Ctrl\-C and causes \fBsrun\fR to instead immediately terminate the
running job.
.TP
\fB\-X\fR, \fB\-\-disable\-status\fR
Disable the display of task status when srun receives a single SIGINT
-(Ctrl-C). Instead immediately forward the SIGINT to the running job.
-A second Ctrl-C in one second will forcibly terminate the job and
+(Ctrl\-C). Instead immediately forward the SIGINT to the running job.
+A second Ctrl\-C in one second will forcibly terminate the job and
\fBsrun\fR will immediately exit. May also be set via the environment
variable SLURM_DISABLE_STATUS.
.TP
@@ -468,7 +468,7 @@ for the task being spawned.
\fB\-\-task\-epilog\fR=\fIexecutable\fR
The \fBslurmd\fR daemon will run \fIexecutable\fR just after each task
terminates. This will be before after any TaskEpilog parameter
-in slurm.conf is executed. This is meant to be a very short-lived
+in slurm.conf is executed. This is meant to be a very short\-lived
program. If it fails to terminate within a few seconds, it will
be killed along with any descendant processes.
.PP
@@ -538,8 +538,8 @@ Demand a contiguous range of nodes. The default is "yes". Specify
.TP
\fB\-w\fR, \fB\-\-nodelist\fR=\fIhost1,host2,...\fR or \fIfilename\fR
Request a specific list of hosts. The job will contain \fIat least\fR
-these hosts. The list may be specified as a comma-separated list of
-hosts, a range of hosts (host[1-5,7,...] for example), or a filename.
+these hosts. The list may be specified as a comma\-separated list of
+hosts, a range of hosts (host[1\-5,7,...] for example), or a filename.
The host list will be assumed to be a filename if it contains a "/"
character.
.TP
@@ -549,7 +549,7 @@ allocated to this job. The host list will be assumed to be a filename
if it contains a "/"character.
.PP
-Affinity/Multi-core Options (when the task/affinity plugin is enabled):
+Affinity/Multi\-core Options (when the task/affinity plugin is enabled):
.TP
\fB\-\-ntasks\-per\-socket\fR=\fIntasks\fR
Request that no more than \fIntasks\fR be invoked on each socket.
@@ -594,13 +594,13 @@ CPU masks are \fBalways\fR interpreted as hexadecimal values but can be
preceded with an optional '0x'.
.TP
.B sockets
-auto-generated masks bind to sockets
+auto\-generated masks bind to sockets
.TP
.B cores
-auto-generated masks bind to cores
+auto\-generated masks bind to cores
.TP
.B threads
-auto-generated masks bind to threads
+auto\-generated masks bind to threads
.TP
.B help
show this help message
@@ -640,7 +640,7 @@ than one allowed CPU) could be used for the tasks in order to provide
multiple CPUs for the multithreaded tasks.
.PP
-Affinity/Multi-core Options (when the task/affinity plugin is enabled and
+Affinity/Multi\-core Options (when the task/affinity plugin is enabled and
the NUMA memory functions are available):
.TP
\fB\-\-mem_bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR
@@ -749,7 +749,7 @@ If NAV, or if not set, then SLURM will try to fit a TORUS else MESH.
You should not normally set this option.
SLURM will normally allocate a TORUS if possible for a given geometry.
.TP
-\fB\-R\fR, \fB\-\-no-rotate\fR
+\fB\-R\fR, \fB\-\-no\-rotate\fR
Disables rotation of the job's requested geometry in order to fit an
appropriate partition.
By default the specified geometry can rotate in three dimensions.
@@ -770,7 +770,7 @@ Other options
Display version information and exit.
.PP
-Unless the \fB\-a\fR (\fB\-\-attach\fR) or \fB-A\fR (\fB\-\-allocate\fR)
+Unless the \fB\-a\fR (\fB\-\-attach\fR) or \fB\-A\fR (\fB\-\-allocate\fR)
options are specified (see \fBAllocate mode\fR and \fBAttaching to jobs\fR
below),
.B srun
@@ -788,12 +788,12 @@ will propagate the current working directory, unless
\fB\-\-chdir\fR=\fIpath\fR is specified, in which case \fIpath\fR will
become the working directory for the remote processes.
.PP
-The \fB-n\fB, \fB-c\fR, and \fB-N\fR options control how CPUs and
+The \fB\-n\fB, \fB\-c\fR, and \fB\-N\fR options control how CPUs and
nodes will be allocated to the job. When specifying only the number
-of processes to run with \fB-n\fR, a default of one CPU per process
-is allocated. By specifying the number of CPUs required per task (\fB-c\fR),
+of processes to run with \fB\-n\fR, a default of one CPU per process
+is allocated. By specifying the number of CPUs required per task (\fB\-c\fR),
more than one CPU may be allocated per process. If the number of nodes
-is specified with \fB-N\fR,
+is specified with \fB\-N\fR,
.B srun
will attempt to allocate \fIat least\fR the number of nodes specified.
.PP
@@ -801,8 +801,8 @@ Combinations of the above three options may be used to change how
processes are distributed across nodes and cpus. For instance, by specifying
both the number of processes and number of nodes on which to run, the
number of processes per node is implied. However, if the number of CPUs
-per process is more important then number of processes (\fB-n\fR) and the
-number of CPUs per process (\fB-c\fR) should be specified.
+per process is more important then number of processes (\fB\-n\fR) and the
+number of CPUs per process (\fB\-c\fR) should be specified.
.PP
.B srun
will refuse to allocate more than one process per CPU unless
@@ -894,8 +894,8 @@ task identifier (rank) relative to current job. This will create a
separate IO file per task.
.PP
A number placed between the percent character and format specifier may be
-used to zero-pad the result in the IO filename. This number is ignored if
-the format specifier corresponds to non-numeric data (%N for example).
+used to zero\-pad the result in the IO filename. This number is ignored if
+the format specifier corresponds to non\-numeric data (%N for example).
Some examples of how the format string may be used for a 4 task job step
with a Job ID of 128 and step id of 0 are included below:
@@ -906,10 +906,10 @@ job128.0.out
job%4j.out
job0128.out
.TP
-job%j-%2t.out
-job128-00.out, job128-01.out, ...
+job%j\-%2t.out
+job128\-00.out, job128\-01.out, ...
.PP
-.RS -10
+.RS \-10
.PP
.B "Allocate Mode"
.PP
@@ -926,25 +926,25 @@ when the subshell terminates.
.PP
.B "Attaching to a running job"
.PP
-Use of the \fB-a\fR \fIjobid\fR (or \fB\-\-attach\fR) option allows
+Use of the \fB\-a\fR \fIjobid\fR (or \fB\-\-attach\fR) option allows
\fBsrun\fR to reattach to a running job, receiving stdout and stderr
from the job and forwarding signals to the job, just as if the current
session of \fBsrun\fR had started the job. (stdin, however, cannot
be forwarded to the job).
.PP
There are two ways to reattach to a running job. The default method
-is to attach to the current job read-only. In this case,
+is to attach to the current job read\-only. In this case,
stdout and stderr are duplicated to the attaching \fBsrun\fR, but
signals are not forwarded to the remote processes (A single
-Ctrl-C will detach this read-only \fBsrun\fR from the job). If
-the \fB-j\fR (\fB\-\-join\fR) option is is also specified,
+Ctrl\-C will detach this read\-only \fBsrun\fR from the job). If
+the \fB\-j\fR (\fB\-\-join\fR) option is is also specified,
\fBsrun\fR "joins" the running job, and is able to forward signals,
connects stdin, and acts for the most part much like the \fBsrun\fR
process that initiated the job.
.PP
Node and CPU selection options do not make sense when specifying
-\fB\-\-attach\fR, and it is an error to use \fB-n\fR, \fB-c\fR,
-or \fB-N\fR in attach mode.
+\fB\-\-attach\fR, and it is an error to use \fB\-n\fR, \fB\-c\fR,
+or \fB\-N\fR in attach mode.
.PP
.SH "ENVIRONMENT VARIABLES"
.PP
@@ -976,7 +976,7 @@ The location of the SLURM configuration file.
\fB\-v, \-\-verbose\fR
.TP
\fBSLURMD_DEBUG\fR
-\fB\-d, \-\-slurmd-debug\fR
+\fB\-d, \-\-slurmd\-debug\fR
.TP
\fBSLURM_DISTRIBUTION\fR
\fB\-m, \-\-distribution\fR=(\fIblock|cyclic|hostfile\fR)
@@ -994,7 +994,7 @@ The location of the SLURM configuration file.
\fB\-\-network\fR=\fItype\fR
.TP
\fBSLURM_NNODES\fR
-\fB\-N, \-\-nodes\fR=(\fIn|min-max\fR)
+\fB\-N, \-\-nodes\fR=(\fIn|min\-max\fR)
.TP
\fBSLURM_NO_REQUEUE\fR
\fB\-\-no\-requeue\fR
@@ -1039,7 +1039,7 @@ The location of the SLURM configuration file.
\fB\-W, \-\-wait\fR=\fIseconds\fR
.TP
\fBSLURM_DISABLE_STATUS\fR
-\fB\-X, \-\-disable-status\fR
+\fB\-X, \-\-disable\-status\fR
.PP
Additionally,
.B srun
@@ -1118,13 +1118,13 @@ Do not free a block on Blue Gene systems only.
.SH "SIGNALS AND ESCAPE SEQUENCES"
Signals sent to the \fBsrun\fR command are automatically forwarded to
the tasks it is controlling with a few exceptions. The escape sequence
-\fB<control-c>\fR will report the state of all tasks associated with
-the \fBsrun\fR command. If \fB<control-c>\fR is entered twice within
+\fB<control\-c>\fR will report the state of all tasks associated with
+the \fBsrun\fR command. If \fB<control\-c>\fR is entered twice within
one second, then the associated SIGINT signal will be sent to all tasks.
-If a third \fB<control-c>\fR is received, the job will be forcefully
+If a third \fB<control\-c>\fR is received, the job will be forcefully
terminated without waiting for remote tasks to exit.
-The escape sequence \fB<control-z>\fR is presently ignored. Our intent
+The escape sequence \fB<control\-z>\fR is presently ignored. Our intent
is for this put the \fBsrun\fR command into a mode where various special
actions may be invoked.
@@ -1174,8 +1174,8 @@ Arguments
Program arguments.
The expression "%t" will be replaced with the task's number.
The expression "%o" will be replaced with the task's offset within
-this range (e.g. a configured task rank value of "1-5" would
-have offset values of "0-4").
+this range (e.g. a configured task rank value of "1\-5" would
+have offset values of "0\-4").
Single quotes may be used to avoid having the enclosed values interpretted.
This field is optional.
.PP
@@ -1184,13 +1184,13 @@ For example:
###################################################################
# srun multiple program configuration file
#
-# srun \-n8 \-l \-\-multi-prog silly.conf
+# srun \-n8 \-l \-\-multi\-prog silly.conf
###################################################################
-4-6 hostname
+4\-6 hostname
1,7 echo task:%t
-0,2-3 echo offset:%o
+0,2\-3 echo offset:%o
-$ srun \-n8 -\l \-\-multi\-prog silly.conf
+$ srun \-n8 \-\l \-\-multi\-prog silly.conf
0: offset:0
1: task:1
2: offset:1
@@ -1247,7 +1247,7 @@ srun: jobid 42 submitted
The output of test.sh would be found in the default output file
"slurm\-42.out."
.PP
-The srun \fB-r\fR option is used within a job script
+The srun \fB\-r\fR option is used within a job script
to run two job steps on disjoint nodes in the following
example. The script is run using allocate mode instead
of as a batch job in this case.
@@ -1260,7 +1260,7 @@ echo $SLURM_NODELIST
srun \-lN2 \-r2 hostname
srun \-lN2 hostname
-> srun \-A -\N4 test.sh
+> srun \-A \-\N4 test.sh
dev[7\-10]
0: dev9
1: dev10
@@ -1285,11 +1285,11 @@ wait
> srun \-A \-N4 test.sh
JOBID PARTITION NAME USER ST TIME NODES NODELIST
- 65641 batch test.sh grondo R 0:01 4 dev[7-10]
+ 65641 batch test.sh grondo R 0:01 4 dev[7\-10]
STEPID PARTITION USER TIME NODELIST
-65641.0 batch grondo 0:01 dev[7-8]
-65641.1 batch grondo 0:01 dev[9-10]
+65641.0 batch grondo 0:01 dev[7\-8]
+65641.1 batch grondo 0:01 dev[9\-10]
.fi
.PP
@@ -1346,7 +1346,7 @@ dev1
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man1/sview.1 b/doc/man/man1/sview.1
index d2fb0990982..22c91f30f90 100644
--- a/doc/man/man1/sview.1
+++ b/doc/man/man1/sview.1
@@ -19,7 +19,7 @@ will show the nodes associated with each job or partition.
Left\-click on the tab of the display you would like to see.
Right\-click on the tab in order to control which fields will be displayed.
.LP
-Within the display window, left-click on the header to control the sort
+Within the display window, left\-click on the header to control the sort
order of entries (e.g. increasing or decreasing) in the diplay.
You can also left\-click and drag the headers to move them right or left in the display.
If a JobID has an arrow next to it, click on that arrow to display or hide
@@ -49,7 +49,7 @@ the sview command.
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_allocate_resources.3 b/doc/man/man3/slurm_allocate_resources.3
index 229a85e0d58..e9858a17d41 100644
--- a/doc/man/man3/slurm_allocate_resources.3
+++ b/doc/man/man3/slurm_allocate_resources.3
@@ -124,10 +124,10 @@ the job's requested node count or time allocation are outside of the partition's
longer required using the function \fBslurm_free_submit_response_msg\fR.
.SH "RETURN VALUE"
.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.
.SH "ERRORS"
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code.
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code.
.LP
\fBESLURM_DEFAULT_PARTITION_NOT_SET\fR the system lacks a valid default partition.
.LP
@@ -224,11 +224,11 @@ int main (int argc, char *argv[])
.br
printf ("Allocated nodes %s to job_id %u\\n",
.br
- slurm_alloc_msg_ptr->node_list,
+ slurm_alloc_msg_ptr\->node_list,
.br
- slurm_alloc_msg_ptr->job_id );
+ slurm_alloc_msg_ptr\->job_id );
.br
- if (slurm_job_kill(slurm_alloc_msg_ptr->
+ if (slurm_job_kill(slurm_alloc_msg_ptr\->
.br
job_id, SIGKILL)) {
.br
@@ -240,7 +240,7 @@ int main (int argc, char *argv[])
.br
printf ("canceled job_id %u\\n",
.br
- slurm_alloc_msg_ptr->job_id );
+ slurm_alloc_msg_ptr\->job_id );
.br
slurm_free_resource_allocation_response_msg(
.br
@@ -253,12 +253,12 @@ int main (int argc, char *argv[])
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
-Copyright (C) 2002-2006 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.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_checkpoint_error.3 b/doc/man/man3/slurm_checkpoint_error.3
index 5b2d387f557..467bc95b2b2 100644
--- a/doc/man/man3/slurm_checkpoint_error.3
+++ b/doc/man/man3/slurm_checkpoint_error.3
@@ -129,7 +129,7 @@ Request a checkpoint for the identified job step.
Continue its execution upon completion of the checkpoint.
.LP
\fBslurm_checkpoint_disable\fR
-Make the identified job step non-checkpointable.
+Make the identified job step non\-checkpointable.
This can be issued as needed to prevent checkpointing while
a job step is in a critical section or for other reasons.
.LP
@@ -154,7 +154,7 @@ Terminate its execution upon completion of the checkpoint.
.SH "RETURN VALUE"
.LP
Zero is returned upon success.
-On error, -1 is returned, and the Slurm error code is set appropriately.
+On error, \-1 is returned, and the Slurm error code is set appropriately.
.SH "ERRORS"
.LP
\fBESLURM_INVALID_JOB_ID\fR the requested job or job step id does not exist.
@@ -214,12 +214,12 @@ int main (int argc, char *argv[])
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
Copyright (C) 2004 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_complete_job.3 b/doc/man/man3/slurm_complete_job.3
index 89d459ffb4b..06a2f59567e 100644
--- a/doc/man/man3/slurm_complete_job.3
+++ b/doc/man/man3/slurm_complete_job.3
@@ -36,10 +36,10 @@ Slurm job id number.
Slurm job step id number.
.TP
\fIjob_return_code\fP
-Highest exit code of any task of the user's application. A non-zero value is considered as an indication of job failure.
+Highest exit code of any task of the user's application. A non\-zero value is considered as an indication of job failure.
.TP
\fIsystem_return_code\fP
-Highest exit code of any system daemon executing the user's application. A non-zero value is considered as an indication of failure, such as error setting the job's session ID, error creating a log file, etc.
+Highest exit code of any system daemon executing the user's application. A non\-zero value is considered as an indication of failure, such as error setting the job's session ID, error creating a log file, etc.
.SH "DESCRIPTION"
.LP
\fBslurm_complete_job\fR Note the termination of a job. This function may only be
@@ -49,11 +49,11 @@ successfully executed by the job's owner or user root.
may only be successfully executed by the job's owner or user root.
.SH "RETURN VALUE"
.LP
-On success, zero is returned. On error, -1 is returned, and Slurm error code
+On success, zero is returned. On error, \-1 is returned, and Slurm error code
is set appropriately.
.SH "ERRORS"
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code.
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code.
.LP
\fBESLURM_INVALID_JOB_ID\fR the requested job id does not exist.
.LP
@@ -70,12 +70,12 @@ SLURM controller.
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
Copyright (C) 2002 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_free_ctl_conf.3 b/doc/man/man3/slurm_free_ctl_conf.3
index 49411dca838..93eb4b50802 100644
--- a/doc/man/man3/slurm_free_ctl_conf.3
+++ b/doc/man/man3/slurm_free_ctl_conf.3
@@ -66,13 +66,13 @@ Slurm configuration records.
.SH "RETURN VALUE"
.LP
For \fBslurm_api_version\fR the SLURM API version number is returned.
-All other functions return zero on success and -1 on error with the
+All other functions return zero on success and \-1 on error with the
SLURM error code set appropriately.
.SH "ERRORS"
.LP
\fBSLURM_NO_CHANGE_IN_DATA\fR Data has not changed since \fBupdate_time\fR.
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code.
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code.
.LP
\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with
SLURM controller.
@@ -126,11 +126,11 @@ int main (int argc, char *argv[])
.br
printf ("control_machine = %s\\n",
.br
- slurm_ctl_conf_ptr->control_machine);
+ slurm_ctl_conf_ptr\->control_machine);
.br
printf ("server_timeout = %u\\n",
.br
- slurm_ctl_conf_ptr->server_timeout);
+ slurm_ctl_conf_ptr\->server_timeout);
.LP
slurm_free_ctl_conf (conf_info_msg_ptr);
.br
@@ -141,12 +141,12 @@ int main (int argc, char *argv[])
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
Copyright (C) 2002 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_free_job_info_msg.3 b/doc/man/man3/slurm_free_job_info_msg.3
index 465e33281a9..1f9254ad732 100644
--- a/doc/man/man3/slurm_free_job_info_msg.3
+++ b/doc/man/man3/slurm_free_job_info_msg.3
@@ -125,7 +125,7 @@ and includes: ID number, name, user ID, state, assigned or requested node
names, indexes into the node table, etc. In the case of indexes into the
node table, this is an array of integers with pairs of start and end index
number into the node information records and the data is terminated with a
-value of -1. See slurm.h for full details on the data structure's contents.
+value of \-1. See slurm.h for full details on the data structure's contents.
.TP
\fIjob_id\fP
Specifies a slurm job id. If zero, use the SLURM_JOBID environment variable
@@ -139,7 +139,7 @@ placed.
Specifies the pointer to the structure created by \fBslurm_load_jobs\fR.
.TP
\fIjobinfo\fP
-Job-specific information as constructed by Slurm's NodeSelect plugin.
+Job\-specific information as constructed by Slurm's NodeSelect plugin.
This data object is returned for each job by the \fBslurm_load_jobs\fR function.
.TP
\fIjob_pid\fP
@@ -150,7 +150,7 @@ Specifies a pointer to a single job records from the \fIjob_info_msg_ptr\fP
data structure.
.TP
\fIone_liner\fP
-Print one record per line if non-zero.
+Print one record per line if non\-zero.
.TP
\fIout_file\fP
Specifies the file to print data to.
@@ -201,16 +201,16 @@ describing all job records loaded by the \fBslurm_load_node\fR function.
.LP
For \fBslurm_get_rem_time\fR on success a number of seconds is returned.
For all other functions zero is returned on success.
-On error, -1 is returned, and Slurm error code is set appropriately.
+On error, \-1 is returned, and Slurm error code is set appropriately.
.SH "ERRORS"
.LP
\fBSLURM_NO_CHANGE_IN_DATA\fR Data has not changed since \fBupdate_time\fR.
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link
your code.
.LP
-\fBESLURM_INVALID_JOB_ID\fR Request for information about a non-existent job.
+\fBESLURM_INVALID_JOB_ID\fR Request for information about a non\-existent job.
.LP
\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with
SLURM controller.
@@ -257,9 +257,9 @@ int main (int argc, char *argv[])
.LP
/* A harder way.. */
.br
- for (i = 0; i < job_buffer_ptr->record_count; i++) {
+ for (i = 0; i < job_buffer_ptr\->record_count; i++) {
.br
- job_ptr = &job_buffer_ptr->job_array[i];
+ job_ptr = &job_buffer_ptr\->job_array[i];
.br
slurm_print_job_info(stdout, job_ptr);
.br
@@ -269,27 +269,27 @@ int main (int argc, char *argv[])
.br
printf ("Jobs updated at %lx, record count %d\\n",
.br
- job_buffer_ptr->last_update,
+ job_buffer_ptr\->last_update,
.br
- job_buffer_ptr->record_count);
+ job_buffer_ptr\->record_count);
.br
- for (i = 0; i < job_buffer_ptr->record_count; i++) {
+ for (i = 0; i < job_buffer_ptr\->record_count; i++) {
.br
printf ("JobId=%u UserId=%u\\n",
.br
- job_buffer_ptr->job_array[i].job_id,
+ job_buffer_ptr\->job_array[i].job_id,
.br
- job_buffer_ptr->job_array[i].user_id);
+ job_buffer_ptr\->job_array[i].user_id);
.br
}
.LP
- if (job_buffer_ptr->record_count >= 1) {
+ if (job_buffer_ptr\->record_count >= 1) {
.br
uint16_t rotate;
.br
if (slurm_get_select_jobinfo(
.br
- job_buffer_ptr->job_array[0].select_jobinfo,
+ job_buffer_ptr\->job_array[0].select_jobinfo,
.br
SELECT_DATA_ROTATE,
.br
@@ -297,7 +297,7 @@ int main (int argc, char *argv[])
.br
printf("JobId=%u Rotate=%u\\n",
.br
- job_buffer_ptr->job_array[0].job_id,
+ job_buffer_ptr\->job_array[0].job_id,
.br
rotate);
.br
@@ -320,9 +320,9 @@ int main (int argc, char *argv[])
.SH "NOTES"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.LP
-Some data structures contain index values to cross-reference each other.
+Some data structures contain index values to cross\-reference each other.
If the \fIshow_flags\fP argument is not set to SHOW_ALL when getting this
data, these index values will be invalid.
.LP
@@ -330,9 +330,9 @@ The \fBslurm_hostlist_\fR functions can be used to convert SLURM node list
expressions into a collection of individual node names.
.SH "COPYING"
-Copyright (C) 2002-2006 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.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_free_job_step_info_response_msg.3 b/doc/man/man3/slurm_free_job_step_info_response_msg.3
index 80d1a608b8e..992512d944b 100644
--- a/doc/man/man3/slurm_free_job_step_info_response_msg.3
+++ b/doc/man/man3/slurm_free_job_step_info_response_msg.3
@@ -72,7 +72,7 @@ Specifies a pointer to a single job step records from the \fIjob_step_info_msg_p
data structure.
.TP
\fIone_liner\fP
-Print one record per line if non-zero.
+Print one record per line if non\-zero.
.TP
\fIout_file\fP
Specifies the file to print data to.
@@ -109,13 +109,13 @@ structure describing all job step records loaded by the
\fslurm_get_job_steps\fR function.
.SH "RETURN VALUE"
.LP
-On success, zero is returned. On error, -1 is returned, and Slurm error
+On success, zero is returned. On error, \-1 is returned, and Slurm error
code is set appropriately.
.SH "ERRORS"
.LP
\fBSLURM_NO_CHANGE_IN_DATA\fR Data has not changed since \fBupdate_time\fR.
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code.
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code.
.LP
\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with
SLURM controller.
@@ -157,9 +157,9 @@ int main (int argc, char *argv[])
.LP
/* A harder way.. */
.br
- for (i = 0; i < step_info_ptr->record_count; i++) {
+ for (i = 0; i < step_info_ptr\->record_count; i++) {
.br
- step_ptr = &step_info_ptr->job_steps[i];
+ step_ptr = &step_info_ptr\->job_steps[i];
.br
slurm_print_job_step_info(stdout, step_ptr);
.br
@@ -169,17 +169,17 @@ int main (int argc, char *argv[])
.br
printf ("Steps updated at %lx, record count %d\\n",
.br
- step_info_ptr->last_update,
+ step_info_ptr\->last_update,
.br
- step_info_ptr->job_step_count);
+ step_info_ptr\->job_step_count);
.br
- for (i = 0; i < step_info_ptr->job_step_count; i++) {
+ for (i = 0; i < step_info_ptr\->job_step_count; i++) {
.br
printf ("JobId=%u StepId=%u\\n",
.br
- step_info_ptr->job_steps[i].job_id,
+ step_info_ptr\->job_steps[i].job_id,
.br
- step_info_ptr->job_steps[i].step_id);
+ step_info_ptr\->job_steps[i].step_id);
.br
}
.LP
@@ -192,9 +192,9 @@ int main (int argc, char *argv[])
.SH "NOTES"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.LP
-Some data structures contain index values to cross-reference each other.
+Some data structures contain index values to cross\-reference each other.
If the \fIshow_flags\fP argument is not set to SHOW_ALL when getting this
data, these index values will be invalid.
.LP
@@ -202,9 +202,9 @@ The \fBslurm_hostlist_\fR functions can be used to convert SLURM node list
expressions into a collection of individual node names.
.SH "COPYING"
-Copyright (C) 2002-2006 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.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_free_node_info.3 b/doc/man/man3/slurm_free_node_info.3
index a878228696d..fefb42d2268 100644
--- a/doc/man/man3/slurm_free_node_info.3
+++ b/doc/man/man3/slurm_free_node_info.3
@@ -65,7 +65,7 @@ Specifies a pointer to a single node records from the \fInode_info_msg_ptr\fP
data structure.
.TP
\fIone_liner\fP
-Print one record per line if non-zero.
+Print one record per line if non\-zero.
.TP
\fIout_file\fP
Specifies the file to print data to.
@@ -100,13 +100,13 @@ function.
describing a single node record loaded by the \fBslurm_load_node\fR function.
.SH "RETURN VALUE"
.LP
-On success, zero is returned. On error, -1 is returned, and Slurm error code
+On success, zero is returned. On error, \-1 is returned, and Slurm error code
is set appropriately.
.SH "ERRORS"
.LP
\fBSLURM_NO_CHANGE_IN_DATA\fR Data has not changed since \fBupdate_time\fR.
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link
your code.
.LP
\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with
@@ -151,9 +151,9 @@ int main (int argc, char *argv[])
.LP
/* A harder way.. */
.br
- for (i = 0; i < node_buffer_ptr->record_count; i++) {
+ for (i = 0; i < node_buffer_ptr\->record_count; i++) {
.br
- node_ptr = &node_buffer_ptr->node_array[i];
+ node_ptr = &node_buffer_ptr\->node_array[i];
.br
slurm_print_job_info(stdout, node_ptr);
.br
@@ -161,13 +161,13 @@ int main (int argc, char *argv[])
.LP
/* The hardest way. */
.br
- for (i = 0; i < node_buffer_ptr->node_count; i++) {
+ for (i = 0; i < node_buffer_ptr\->node_count; i++) {
.br
printf ("NodeName=%s CPUs=%u\\n",
.br
- node_buffer_ptr->node_array[i].name,
+ node_buffer_ptr\->node_array[i].name,
.br
- node_buffer_ptr->node_array[i].cpus);
+ node_buffer_ptr\->node_array[i].cpus);
.br
}
.LP
@@ -189,27 +189,27 @@ int main (int argc, char *argv[])
.br
}
.br
- for (i = 0; i < part_buffer_ptr->record_count; i++) {
+ for (i = 0; i < part_buffer_ptr\->record_count; i++) {
.br
- part_ptr = &part_info_ptr->partition_array[i];
+ part_ptr = &part_info_ptr\->partition_array[i];
.br
printf ("PartitionName=%s Nodes=",
.br
- part_ptr->name);
+ part_ptr\->name);
.br
- for (j = 0; part_ptr->node_inx; j+=2) {
+ for (j = 0; part_ptr\->node_inx; j+=2) {
.br
- if (part_ptr->node_inx[j] == -1)
+ if (part_ptr\->node_inx[j] == \-1)
.br
break;
.br
- for (k = part_ptr->node_inx[j];
+ for (k = part_ptr\->node_inx[j];
.br
- k <= part_ptr->node_inx[j+1];
+ k <= part_ptr\->node_inx[j+1];
.br
k++) {
.br
- printf ("%s ", node_buffer_ptr->
+ printf ("%s ", node_buffer_ptr\->
.br
node_array[k].name);
.br
@@ -232,16 +232,16 @@ int main (int argc, char *argv[])
.SH "NOTES"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.LP
-Some data structures contain index values to cross-reference each other.
+Some data structures contain index values to cross\-reference each other.
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-2006 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.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_free_partition_info.3 b/doc/man/man3/slurm_free_partition_info.3
index 25e24431af5..17e3f604795 100644
--- a/doc/man/man3/slurm_free_partition_info.3
+++ b/doc/man/man3/slurm_free_partition_info.3
@@ -48,7 +48,7 @@ void \fBslurm_print_partition_info_msg\fR (
.LP
.TP
\fIone_liner\fP
-Print one record per line if non-zero.
+Print one record per line if non\-zero.
.TP
\fIout_file\fP
Specifies the file to print data to.
@@ -60,7 +60,7 @@ partition. Detailed partition information is written to fixed sized records and
name, state, job time limit, job size limit, node names, indexes into the node table,
etc. In the case of indexes into the node table, this is an array of integers with
pairs of start and end index number into the node information records and the
-data is terminated with a value of -1. See slurm.h for full details on the data
+data is terminated with a value of \-1. See slurm.h for full details on the data
structure's contents.
.TP
\fIpartition_info_msg_ptr\fP
@@ -94,12 +94,12 @@ single partition records from the data loaded by the \fBslurm_load_partitions\fR
all partition records loaded by the \fBslurm_load_partitions\fR function.
.SH "RETURN VALUE"
.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.
.SH "ERRORS"
.LP
\fBSLURM_NO_CHANGE_IN_DATA\fR Data has not changed since \fBupdate_time\fR.
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link
your code.
.LP
\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with
@@ -142,9 +142,9 @@ int main (int argc, char *argv[])
.LP
/* A harder way.. */
.br
- for (i = 0; i < part_buffer_ptr->record_count; i++) {
+ for (i = 0; i < part_buffer_ptr\->record_count; i++) {
.br
- part_ptr = &part_info_ptr->partition_array[i];
+ part_ptr = &part_info_ptr\->partition_array[i];
.br
slurm_print_partition_info(stdout, part_ptr);
.br
@@ -154,17 +154,17 @@ int main (int argc, char *argv[])
.br
printf("Partitions updated at %lx, records=%d\\n",
.br
- part_buffer_ptr->last_update,
+ part_buffer_ptr\->last_update,
.br
- part_buffer_ptr->record_count);
+ part_buffer_ptr\->record_count);
.br
- for (i = 0; i < part_buffer_ptr->record_count; i++) {
+ for (i = 0; i < part_buffer_ptr\->record_count; i++) {
.br
printf ("PartitionName=%s Nodes=%s\\n",
.br
- part_info_ptr->partition_array[i].name,
+ part_info_ptr\->partition_array[i].name,
.br
- part_info_ptr->partition_array[i].nodes );
+ part_info_ptr\->partition_array[i].nodes );
.br
}
.LP
@@ -177,9 +177,9 @@ int main (int argc, char *argv[])
.SH "NOTES"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.LP
-Some data structures contain index values to cross-reference each other.
+Some data structures contain index values to cross\-reference each other.
If the \fIshow_flags\fP argument is not set to SHOW_ALL when getting this
data, these index values will be invalid.
.LP
@@ -187,9 +187,9 @@ The \fBslurm_hostlist_\fR functions can be used to convert SLURM node list
expressions into a collection of individual node names.
.SH "COPYING"
-Copyright (C) 2002-2006 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.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_get_errno.3 b/doc/man/man3/slurm_get_errno.3
index c9192d42b7e..1c29a961429 100644
--- a/doc/man/man3/slurm_get_errno.3
+++ b/doc/man/man3/slurm_get_errno.3
@@ -69,12 +69,12 @@ int main (int argc, char *argv[])
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
Copyright (C) 2002 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_hostlist_create.3 b/doc/man/man3/slurm_hostlist_create.3
index c7be72dc6c7..1e744b35a8f 100644
--- a/doc/man/man3/slurm_hostlist_create.3
+++ b/doc/man/man3/slurm_hostlist_create.3
@@ -32,7 +32,7 @@ void \fBslurm_hostlist_destroy\fR (
A list of nodes as returned by the
\fBslurm_job_step_create\fR functions. The returned value may include a simple
regular expression to describe numeric ranges of values and/or multiple numeric
-values (e.g. "linux[1-3,6]" represents "linux1", "linux2", "linux3", and "linux6").
+values (e.g. "linux[1\-3,6]" represents "linux1", "linux2", "linux3", and "linux6").
.TP
\fIhost_list\fP
A hostlist created by the \fBslurm_hostlist_create\fR function.
@@ -101,12 +101,12 @@ int main (int argc, char *argv[])
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
-Copyright (C) 2002-2006 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.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_job_step_create.3 b/doc/man/man3/slurm_job_step_create.3
index 8421b190994..d45133e95cc 100644
--- a/doc/man/man3/slurm_job_step_create.3
+++ b/doc/man/man3/slurm_job_step_create.3
@@ -43,10 +43,10 @@ using the functions \fBhostlist_create\fR, \fBhostlist_shift\fR, and
\fBhostlist_destroy\fR.
.SH "RETURN VALUE"
.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.
.SH "ERRORS"
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code.
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code.
.LP
\fBESLURM_INVALID_JOB_ID\fR the requested job id does not exist.
.LP
@@ -64,12 +64,12 @@ SLURM controller.
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
Copyright (C) 2002 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_kill_job.3 b/doc/man/man3/slurm_kill_job.3
index be3b3d20ea6..cd32aca3958 100644
--- a/doc/man/man3/slurm_kill_job.3
+++ b/doc/man/man3/slurm_kill_job.3
@@ -28,7 +28,7 @@ int \fBslurm_kill_job_step\fR (
.LP
.TB
\fIbatch_flag\fP
-If non-zero then signal only the batch job shell.
+If non\-zero then signal only the batch job shell.
.TP
\fIjob_id\fP
Slurm job id number.
@@ -41,7 +41,7 @@ Signal to be sent to the job or job step.
.SH "DESCRIPTION"
.LP
\fBslurm_kill_job\fR Request that a signal be sent to either the batch job shell
-(if \fIbatch_flag\fP is non-zero) or all steps of the specified job.
+(if \fIbatch_flag\fP is non\-zero) or all steps of the specified job.
If the job is pending and the signal is SIGKILL, the job will be terminated immediately.
This function may only be successfully executed by the job's owner or user root.
.LP
@@ -49,16 +49,16 @@ This function may only be successfully executed by the job's owner or user root.
This function may only be successfully executed by the job's owner or user root.
.SH "RETURN VALUE"
.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.
.SH "ERRORS"
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code.
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code.
.LP
\fBESLURM_DEFAULT_PARTITION_NOT_SET\fR the system lacks a valid default partition.
.LP
\fBESLURM_INVALID_JOB_ID\fR the requested job id does not exist.
.LP
-\fBESLURM_JOB_SCRIPT_MISSING\fR the \fIbatch_flag\fP was set for a non-batch job.
+\fBESLURM_JOB_SCRIPT_MISSING\fR the \fIbatch_flag\fP was set for a non\-batch job.
.LP
\fBESLURM_ALREADY_DONE\fR the specified job has already completed and can not be modified.
.LP
@@ -72,12 +72,12 @@ SLURM controller.
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
Copyright (C) 2002 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_reconfigure.3 b/doc/man/man3/slurm_reconfigure.3
index b27ea3f716b..e309db2b0a8 100644
--- a/doc/man/man3/slurm_reconfigure.3
+++ b/doc/man/man3/slurm_reconfigure.3
@@ -49,7 +49,7 @@ int \fBslurm_update_partition\fR (
.LP
.TP
\fIcore\fP
-Generate a core file if value is non-zero.
+Generate a core file if value is non\-zero.
.TP
\fIdelete_part_msg_ptr\fP
Specifies the pointer to a partition delete request specification. See slurm.h for
@@ -77,7 +77,7 @@ with default values. Note: \fBslurm_init_part_desc_msg\fR is not equivalent to
setting the data structure values to zero. Execute this function before executing
\fBslurm_update_part\fR.
.LP
-\fBslurm_reconfigure\fR Request that the Slurm controller re-read its configuration
+\fBslurm_reconfigure\fR Request that the Slurm controller re\-read its configuration
file. The new configuration parameters take effect immediately. This function may
only be successfully executed by user root.
.LP
@@ -121,11 +121,11 @@ already exist, a new partition is created with the supplied parameters. This
function may only be successfully executed by user root.
.SH "RETURN VALUE"
.LP
-On success, zero is returned. On error, -1 is returned, and the Slurm error
+On success, zero is returned. On error, \-1 is returned, and the Slurm error
code is set appropriately.
.SH "ERRORS"
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your
code.
.LP
\fBESLURM_INVALID_NODE_NAME\fR The requested node name(s) is/are not valid.
@@ -220,7 +220,7 @@ int main (int argc, char *argv[])
.br
}
.LP
- update_node_msg.node_names = "lx[10-12]";
+ update_node_msg.node_names = "lx[10\-12]";
.br
update_node_msg.node_state = NODE_STATE_DRAINING ;
.br
@@ -239,12 +239,12 @@ int main (int argc, char *argv[])
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
Copyright (C) 2002 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_resume.3 b/doc/man/man3/slurm_resume.3
index 052c59dc435..cfe1ca4dad1 100644
--- a/doc/man/man3/slurm_resume.3
+++ b/doc/man/man3/slurm_resume.3
@@ -48,7 +48,7 @@ ignoring any previous checkpoint.
.SH "RETURN VALUE"
.LP
Zero is returned upon success.
-On error, -1 is returned, and the Slurm error code is set appropriately.
+On error, \-1 is returned, and the Slurm error code is set appropriately.
.SH "ERRORS"
.LP
\fBESLURM_DISABLED\fR the operation is currently disabled
@@ -70,12 +70,12 @@ requested action (e.g. not user root or SlurmUser).
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
-Copyright (C) 2005-2006 The Regents of the University of California.
+Copyright (C) 2005\-2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man3/slurm_spawn.3 b/doc/man/man3/slurm_spawn.3
index 1f4ce134a6e..53168dd7c93 100644
--- a/doc/man/man3/slurm_spawn.3
+++ b/doc/man/man3/slurm_spawn.3
@@ -82,7 +82,7 @@ or set by \fBslurm_step_ctx_set\fR.
Storage location for requested data. See \fIdata_type\fP below.
.TP
\fIdata_type\fP
-Switch-specific data requested. The interpretation of this field depends
+Switch\-specific data requested. The interpretation of this field depends
upon the switch plugin in use.
.TP
\fIfd_array\fP
@@ -91,7 +91,7 @@ Tasks will be connected to these file descriptors in order of their
task id.
This socket will carry standard input, output and error for the task.
\fIjobinfo\fP
-Switch-specific job information as returned by \fBslurm_step_ctx_get\fR.
+Switch\-specific job information as returned by \fBslurm_step_ctx_get\fR.
.TP
\fIsignal\fP
Signal to be sent to the spawned tasks.
@@ -182,12 +182,12 @@ For \fB slurm_step_ctx_create\fR a context is return upon success. On error
NULL is returned and the Slurm error code is set appropriately.
.LP
For all other functions zero is returned upon success.
-On error, -1 is returned, and the Slurm error code is set appropriately.
+On error, \-1 is returned, and the Slurm error code is set appropriately.
.SH "ERRORS"
.LP
\fBEINVAL\fR Invalid argument
.LP
-\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code.
+\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code.
.LP
\fBESLURM_INVALID_JOB_ID\fR the requested job id does not exist.
.LP
@@ -273,7 +273,7 @@ int main (int argc, char *argv[])
.br
bzero(&step_req, sizeof(job_step_create_request_msg_t ));
.br
- step_req.job_id = job_resp->job_id;
+ step_req.job_id = job_resp\->job_id;
.br
step_req.user_id = getuid();
.br
@@ -309,7 +309,7 @@ int main (int argc, char *argv[])
.br
slurm_perror("slurm_spawn");
.br
- slurm_kill_job(job_resp->job_id, SIGKILL, 0);
+ slurm_kill_job(job_resp\->job_id, SIGKILL, 0);
.br
exit(1);
.br
@@ -353,7 +353,7 @@ int main (int argc, char *argv[])
.LP
/* Terminate the job killing all tasks */
.br
- slurm_kill_job(job_resp->job_id, SIGKILL, 0);
+ slurm_kill_job(job_resp\->job_id, SIGKILL, 0);
.br
slurm_step_ctx_destroy(ctx);
.br
@@ -366,12 +366,12 @@ int main (int argc, char *argv[])
.SH "NOTE"
These functions are included in the libslurm library,
which must be linked to your process for use
-(e.g. "cc -lslurm myprog.c").
+(e.g. "cc \-lslurm myprog.c").
.SH "COPYING"
Copyright (C) 2004 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man5/bluegene.conf.5 b/doc/man/man5/bluegene.conf.5
index e5661e5ec9f..f45355aea4c 100644
--- a/doc/man/man5/bluegene.conf.5
+++ b/doc/man/man5/bluegene.conf.5
@@ -18,7 +18,7 @@ The overall configuration parameters available include:
.TP
\fBBasePartitionNodeCount\fR
-The number of c-nodes per base partition.
+The number of c\-nodes per base partition.
There is no default value and this must be specified.
.TP
@@ -66,7 +66,7 @@ There is no default value and this must be specified.
Describes how SLURM should create bgblocks.
.RS
.TP
-\fBSTATIC\fR: Create and use the defined non-overlapping bgblocks.
+\fBSTATIC\fR: Create and use the defined non\-overlapping bgblocks.
.TP
\fBOVERLAP\fR: Create and use the defined bgblocks, which may overlap.
It is highly recommended that none of the bgblocks have any passthroughs
@@ -82,7 +82,7 @@ and starvation of larger jobs.
.TP
\fBNodeCardNodeCount\fR
-Number of c-nodes per node card.
+Number of c\-nodes per node card.
There is no default value and this must be specified.
.TP
@@ -148,7 +148,7 @@ BlrtsImage=/bgl/BlueLight/ppcfloor/bglsys/bin/rts_hw.rts
.br
LinuxImage=/bgl/BlueLight/ppcfloor/bglsys/bin/zImage.elf
.br
-MloaderImage=/bgl/BlueLight/ppcfloor/bglsys/bin/mmcs-mloader.rts
+MloaderImage=/bgl/BlueLight/ppcfloor/bglsys/bin/mmcs\-mloader.rts
.br
RamDiskImage=/bgl/BlueLight/ppcfloor/bglsys/bin/ramdisk.elf
.br
@@ -162,7 +162,7 @@ LayoutMode=STATIC
.br
##################################################################
.br
-# LEAVE AS COMMENT, Full-system bglblock, implicitly created
+# LEAVE AS COMMENT, Full\-system bglblock, implicitly created
.br
# BPs=[000x333] Type=TORUS # 4x4x4 = 64 midplanes
.br
@@ -185,7 +185,7 @@ BPs=[333x333] Type=SMALL NodeCards=4 Quarters=3 # 1/16 * 4 + 1/4 * 3
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5
index 649ac6f7e40..1b83de4e8e2 100644
--- a/doc/man/man5/slurm.conf.5
+++ b/doc/man/man5/slurm.conf.5
@@ -9,9 +9,9 @@ parameters associated with those partitions.
.LP
The file location can be modified at system build time using the
DEFAULT_SLURM_CONF parameter. In addition, you can use the
-\fBSLURM_CONF\fR environment variable to override the built-in
+\fBSLURM_CONF\fR environment variable to override the built\-in
location of this file. The SLURM daemons also allow you to override
-both the built-in and environment-provided location using the "-f"
+both the built\-in and environment\-provided location using the "\-f"
option on the command line.
.LP
The contents of the file are case insensitive except for the names of nodes
@@ -74,7 +74,7 @@ are used and unable to respond very quickly.
The default value is 0 to disable caching group data.
.TP
\fBCheckpointType\fR
-Define the system-initiated checkpoint method to be used for user jobs.
+Define the system\-initiated checkpoint method to be used for user jobs.
The slurmctld daemon must be restarted for a change in CheckpointType
to take effect.
Acceptable values at present include "checkpoint/none" and "checkpoint/aix"
@@ -113,14 +113,14 @@ is significantly lower than the number of nodes, setting FastSchedule to
(The scheduler can just check the values in a few configuration records
instead of possibly thousands of node records. If a job can't be initiated
immediately, the scheduler may execute these tests repeatedly.)
-Note that on systems with hyper-threading, the processor count
+Note that on systems with hyper\-threading, the processor count
reported by the node will be twice the actually processor count.
Consider which value you want to be used for scheduling purposes.
.TP
\fBFirstJobId\fR
The job id to be used for the first submitted to SLURM without a
specific requested value. Job id values generated will incremented by 1
-for each subsequent job. This may be used to provide a meta-scheduler
+for each subsequent job. This may be used to provide a meta\-scheduler
with a job id space which is disjoint from the interactive jobs.
The default value is 1.
.TP
@@ -135,12 +135,12 @@ before it is terminated. A job or job step is considered inactive if
the associated srun command is not responding to slurm daemons. This
could be due to the termination of the srun command or the program
being is a stopped state. A batch job is considered inactive if it
-has no active job steps (e.g. periods of pre- and post-processing).
+has no active job steps (e.g. periods of pre\- and post\-processing).
This limit permits defunct jobs to be purged in a timely fashion
without waiting for their time limit to be reached.
This value should reflect the possibility that the srun command may
stopped by a debugger or considerable time could be required for batch
-job pre- and post-processing.
+job pre\- and post\-processing.
This limit is ignored for jobs running in partitions with the
\fBRootOnly\fR flag set (the scheduler running as root will be
responsible for the job).
@@ -159,7 +159,7 @@ must be configured.
\fBJobAcctLogFile\fR
Define the location where job accounting logs are to be written.
For jobacct/none this parameter is ignored.
-For jobacct/linux this is the fully-qualified file name for the data file.
+For jobacct/linux this is the fully\-qualified file name for the data file.
.TP
\fBJobAcctFrequency\fR
Define the polling frequencys to pass to the job accounting plugin.
@@ -237,7 +237,7 @@ in seconds. Default value is 5 seconds.
.TP
\fBPluginDir\fR
Identifies the places in which to look for SLURM plugins.
-This is a colon-separated list of directories, like the PATH
+This is a colon\-separated list of directories, like the PATH
environment variable.
The default value is "/usr/local/lib/slurm".
.TP
@@ -314,7 +314,7 @@ will run on the compute nodes.
This parameter can be useful when system limits vary among nodes.
Any resource limits that do not appear in the list are not propagated.
However, the user can override this by specifying which resource limits
-to propagate with the srun commands "--propagate" option.
+to propagate with the srun commands "\-\-propagate" option.
If neither of the 'propagate resource limit' parameters are specified, then
the default action is to propagate all limits.
Only one of the parameters, either
@@ -326,12 +326,12 @@ A list of comma separated resource limit names.
By default, all resource limits will be propagated, (as described by
the \fBPropagateResourceLimits\fR parameter), except for the limits
appearing in this list. The user can override this by specifying which
-resource limits to propagate with the srun commands "--propagate" option.
+resource limits to propagate with the srun commands "\-\-propagate" option.
.TP
\fBReturnToService\fR
-If set to 1, then a non-responding (DOWN) node will become available
+If set to 1, then a non\-responding (DOWN) node will become available
for use upon registration. Note that DOWN node's state will be changed
-only if it was set DOWN due to being non-responsive. If the node was
+only if it was set DOWN due to being non\-responsive. If the node was
set DOWN for any other reason (low memory, prolog failure, epilog
failure, etc.), its state will not automatically be changed. The
default value is 0, which means that a node will remain in the
@@ -354,19 +354,19 @@ Identifies whether or not \fBRootOnly\fR partitions should be filtered from
any external scheduling activities. If set to 0, then \fBRootOnly\fR partitions
are treated like any other partition. If set to 1, then \fBRootOnly\fR
partitions are exempt from any external scheduling activities. The
-default value is 1. Currently only used by the built-in backfill
+default value is 1. Currently only used by the built\-in backfill
scheduling module "sched/backfill" (see \fBSchedulerType\fR).
.TP
\fBSchedulerType\fR
Identifies the type of scheduler to be used. Acceptable values include
-"sched/builtin" for the built-in FIFO scheduler,
+"sched/builtin" for the built\-in FIFO scheduler,
"sched/backfill" for a backfill scheduling module to augment
the default FIFO scheduling,
"sched/hold" to hold all newly arriving jobs if a file "/etc/slurm.hold"
-exists otherwise use the built-in FIFO scheduler, and
+exists otherwise use the built\-in FIFO scheduler, and
"sched/wiki" for the Wiki interface to the Maui Scheduler.
The default value is "sched/builtin".
-Backfill scheduling will initiate lower-priority jobs if doing
+Backfill scheduling will initiate lower\-priority jobs if doing
so does not delay the expected initiation time of any higher
priority job.
Note that this backfill scheduler implementation is relatively
@@ -385,11 +385,11 @@ scheduler type to become effective.
Identifies the type of resource selection algorithm to be used.
Acceptable values include
"select/linear" for allocation of entire nodes assuming a
-one-dimentional array of nodes in which sequentially ordered
+one\-dimentional array of nodes in which sequentially ordered
nodes are preferable,
"select/cons_res" for allocation of individual processors
within the available nodes, and
-"select/bluegene" for a three-dimentional Blue Gene system.
+"select/bluegene" for a three\-dimentional Blue Gene system.
The default value is "select/bluegene" for Blue Gene systems
and "select/linear" for all other systems.
.TP
@@ -472,7 +472,7 @@ to respond before configuring that node's state to DOWN.
The default value is 300 seconds.
A value of zero indicates the node will not be tested by \fBslurmctld\fR to
confirm the state of \fBslurmd\fR, the node will not be automatically set to
-a DOWN state indicating a non-responsive \fBslurmd\fR, and some other tool
+a DOWN state indicating a non\-responsive \fBslurmd\fR, and some other tool
will take responsibility for monitoring the state of each compute node
and its \fBslurmd\fR daemon.
The value may not exceed 65533.
@@ -589,8 +589,8 @@ the new limits.
The default value is 0 (not to enable PAM support).
Remember that PAM also needs to be configured to support SLURM as a service.
For sites using PAM's directory based configuration option, a configuration
-file named \fBslurm\fR should be created. The module-type, control-flags, and
-module-path names that should be included in the file are:
+file named \fBslurm\fR should be created. The module\-type, control\-flags, and
+module\-path names that should be included in the file are:
.br
auth required pam_localuser.so
.br
@@ -603,12 +603,12 @@ account required pam_access.so
session required pam_unix.so
.br
For sites configuring PAM with a general configuration file, the appropriate
-lines (see above), where \fBslurm\fR is the service-name, should be added.
+lines (see above), where \fBslurm\fR is the service\-name, should be added.
.TP
\fBWaitTime\fR
Specifies how many seconds the srun command should by default wait after
the first task terminates before terminating all remaining tasks. The
-"--wait" option on the srun command line overrides this value.
+"\-\-wait" option on the srun command line overrides this value.
If set to 0, this feature is disabled.
May not exceed 65533.
.LP
@@ -663,7 +663,7 @@ specify numeric ranges of nodes to avoid building a configuration
file with large numbers of entries.
The node range expression can contain one pair of square brackets
with a sequence of comma separated numbers and/or ranges of numbers
-separated by a "-" (e.g. "linux[0\-64,128]", or "lx[15,18,32\-33]").
+separated by a "\-" (e.g. "linux[0\-64,128]", or "lx[15,18,32\-33]").
Note that the numeric ranges can include one or more leading
zeros to indicate the numeric portion has a fixed number of digits
(e.g. "linux[0000\-1023]").
@@ -674,13 +674,13 @@ These numbers indicate the boundaries of a rectangular prism
(e.g. "bgl[000x144,400x544]").
See BlueGene documentation for more details.
Presently the numeric range must be the last characters in the
-node name (e.g. "unit[0-31]rack1" is invalid).
+node name (e.g. "unit[0\-31]rack1" is invalid).
The node configuration specified the following information:
.TP
\fBNodeName\fR
Name that SLURM uses to refer to a node (or base partition for
BlueGene systems).
-Typically this would be the string that "/bin/hostname -s"
+Typically this would be the string that "/bin/hostname \-s"
returns, however it may be an arbitary string if
\fBNodeHostname\fR is specified.
If the \fBNodeName\fR is "DEFAULT", the values specified
@@ -694,7 +694,7 @@ follows the configuration for "NodeName=baker" they will be
considered adjacent in the computer.
.TP
\fBNodeHostname\fR
-The string that "/bin/hostname -s" returns.
+The string that "/bin/hostname \-s" returns.
A node range expression can be used to specify a set of nodes.
If an expression is used, the number of nodes identified by
\fBNodeHostname\fR on a line in the configuration file must
@@ -709,7 +709,7 @@ This name will be used as an
argument to the gethostbyname() function for identification.
If a node range expression is used to designate multiple nodes,
they must exactly match the entries in the \fBNodeName\fR
-(e.g. "NodeName=lx[0-7] NodeAddr="elx[0-7]").
+(e.g. "NodeName=lx[0\-7] NodeAddr="elx[0\-7]").
\fBNodeAddr\fR may also contain IP addresses.
By default, the \fBNodeAddr\fR will be identical in value to
\fBNodeName\fR.
@@ -876,12 +876,12 @@ The default value is "/bin/mail".
\fBMaxNodes\fR
Maximum count of nodes (or base partitions for BlueGene systems) which
may be allocated to any single job.
-The default value is "UNLIMITED", which is represented internally as -1.
+The default value is "UNLIMITED", which is represented internally as \-1.
This limit does not apply to jobs executed by SlurmUser or user root.
.TP
\fBMaxTime\fR
-Maximum wall-time limit for any job in minutes. The default
-value is "UNLIMITED", which is represented internally as -1.
+Maximum wall\-time limit for any job in minutes. The default
+value is "UNLIMITED", which is represented internally as \-1.
This limit does not apply to jobs executed by SlurmUser or user root.
.TP
\fBMinNodes\fR
@@ -912,7 +912,7 @@ Possible values are "FORCE", "YES", and "NO".
without user means of disabling it.
"YES" makes nodes in the partition available for sharing if and
only if the individual jobs permit sharing (see the srun
-"--shared" option).
+"\-\-shared" option).
"NO" makes nodes unavailable for sharing under all circumstances.
The default value is "NO".
.TP
@@ -950,7 +950,7 @@ unusable, but no other harm will result.
.LP
#
.br
-# Sample /etc/slurm.conf for dev[0-25].llnl.gov
+# Sample /etc/slurm.conf for dev[0\-25].llnl.gov
.br
# Author: John Doe
.br
@@ -1038,7 +1038,7 @@ NodeName=DEFAULT Procs=2 RealMemory=2000 TmpDisk=64000
.br
NodeName=DEFAULT State=UNKNOWN
.br
-NodeName=dev[0-25] NodeAddr=edev[0-25] Weight=16
+NodeName=dev[0\-25] NodeAddr=edev[0\-25] Weight=16
.br
# Update records for specific DOWN nodes
.br
@@ -1052,16 +1052,16 @@ DownNodes=dev20 State=DOWN Reason="power,ETA=Dec25"
.br
PartitionName=DEFAULT MaxTime=30 MaxNodes=10 State=UP
.br
-PartitionName=debug Nodes=dev[0-8,18-25] Default=YES
+PartitionName=debug Nodes=dev[0\-8,18\-25] Default=YES
.br
-PartitionName=batch Nodes=dev[9-17] MinNodes=4
+PartitionName=batch Nodes=dev[9\-17] MinNodes=4
.br
-PartitionName=long Nodes=dev[9-17] MaxTime=120 AllowGroups=admin
+PartitionName=long Nodes=dev[9\-17] MaxTime=120 AllowGroups=admin
.SH "COPYING"
-Copyright (C) 2002-2006 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.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man5/wiki.conf.5 b/doc/man/man5/wiki.conf.5
index 21f010f9dc3..56d49ff5510 100644
--- a/doc/man/man5/wiki.conf.5
+++ b/doc/man/man5/wiki.conf.5
@@ -19,7 +19,7 @@ The overall configuration parameters available include:
\fBAuthKey\fR
Authentication key for communications.
This numeric value should match KEY configured in the
-\fBmoab-private.cnf\fR file.
+\fBmoab\-private.cnf\fR file.
.TP
\fBEPort\fR
@@ -67,7 +67,7 @@ JobPriority=hold
.br
#
.br
-# Moab encryption key, matches KEY in moab-private.cfg
+# Moab encryption key, matches KEY in moab\-private.cfg
.br
AuthKey=1234
.br
@@ -86,7 +86,7 @@ JobAggregationTime=15
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man8/slurmctld.8 b/doc/man/man8/slurmctld.8
index 05fc71a47cd..6e258407abf 100644
--- a/doc/man/man8/slurmctld.8
+++ b/doc/man/man8/slurmctld.8
@@ -57,7 +57,7 @@ configuration file, \fBslurm.conf\fR.
.SH "COPYING"
Copyright (C) 2002\-2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man8/slurmd.8 b/doc/man/man8/slurmd.8
index 93df9f17512..c1e03973492 100644
--- a/doc/man/man8/slurmd.8
+++ b/doc/man/man8/slurmd.8
@@ -10,33 +10,33 @@ running tasks upon request.
.TP
OPTIONS
.TP
-\fB-c\fR
+\fB\-c\fR
Clear system locks as needed. This may be required if \fBslurmd\fR terminated
abnormally.
.TP
-\fB-D\fR
+\fB\-D\fR
Run slurmd in the foreground. Error and debug messages will be copied to stderr.
.TP
-\fB-M\fR
+\fB\-M\fR
Lock slurmd pages into system memory using mlockall(2) to disable
paging of the slurmd process. This may help in cases where nodes are
marked DOWN during periods of heavy swap activity. If the mlockall(2)
system call is not available, an error will be printed to the log
and slurmd will continue as normal.
.TP
-\fB-h\fR
+\fB\-h\fR
Help; print a brief summary of command options.
.TP
-\fB-f <file>\fR
+\fB\-f <file>\fR
Read configuration from the specified file. See \fBNOTES\fR below.
.TP
-\fB-L <file>\fR
+\fB\-L <file>\fR
Write log messages to the specified file.
.TP
-\fB-v\fR
-Verbose operation. Multiple -v's increase verbosity.
+\fB\-v\fR
+Verbose operation. Multiple \-v's increase verbosity.
.TP
-\fB-V\fR
+\fB\-V\fR
Print version information and exit.
.SH "ENVIRONMENT VARIABLES"
@@ -60,7 +60,7 @@ configuration file, \fBslurm.conf\fR.
.SH "COPYING"
Copyright (C) 2002\-2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man8/slurmstepd.8 b/doc/man/man8/slurmstepd.8
index da86462de82..2467a47709b 100644
--- a/doc/man/man8/slurmstepd.8
+++ b/doc/man/man8/slurmstepd.8
@@ -13,7 +13,7 @@ for the job step along with its accounting and signal processing.
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
diff --git a/doc/man/man8/spank.8 b/doc/man/man8/spank.8
index 2c29c89ddd7..4f35417b62c 100644
--- a/doc/man/man8/spank.8
+++ b/doc/man/man8/spank.8
@@ -1,12 +1,12 @@
-.TH "SPANK" "8" "May 2006" "SPANK" "SLURM plug-in architecture for Node and job (K)control"
+.TH "SPANK" "8" "May 2006" "SPANK" "SLURM plug\-in architecture for Node and job (K)control"
.SH "NAME"
-\fBSPANK\fR \- SLURM Plug-in Architecture for Node and job (K)control
+\fBSPANK\fR \- SLURM Plug\-in Architecture for Node and job (K)control
.SH "DESCRIPTION"
-This manual briefly describes the capabilities of the SLURM Plug-in
+This manual briefly describes the capabilities of the SLURM Plug\-in
architecture for Node and job Kontrol (\fBSPANK\fR) as well as the \fBSPANK\fR
configuration file: (By default: \fBplugstack.conf\fP.)
.LP
-\fBSPANK\fR provides a very generic interface for stackable plug-ins
+\fBSPANK\fR provides a very generic interface for stackable plug\-ins
which may be used to dynamically modify the job launch code in
SLURM. \fBSPANK\fR plugins may be built without access to SLURM source
code. They need only be compiled against SLURM's \fBspank.h\fR header file,
@@ -164,7 +164,7 @@ is a short description of the option suitable for \-\-help output.
2 if the option takes an optional argument. (See \fBgetopt_long\fR(3)).
.TP
.I val
-A plugin-local value to return to the option callback function.
+A plugin\-local value to return to the option callback function.
.TP
.I cb
A callback function that is invoked when the plugin option is
@@ -190,17 +190,17 @@ immediately invoke the option's callback with \fIremote\fR=0. This
is meant for the plugin to do local sanity checking of the option before
the value is sent to the remote side during job launch. If the argument
the user specified is invalid, the plugin should issue an error and
-issue a non-zero return code from the callback.
+issue a non\-zero return code from the callback.
.LP
On the remote side, options and their arguments are registered just
after \fBSPANK\fR plugins are loaded and before the \fBspank_init\fR
handler is called. This allows plugins to modify behavior of all plugin
-functionality based on the value of user-provided options.
+functionality based on the value of user\-provided options.
(See EXAMPLES below for a plugin that registers an option with \fBSLURM\fR).
.SH "CONFIGURATION"
.LP
-The default \fBSPANK\fR plug-in stack configuration file is
+The default \fBSPANK\fR plug\-in stack configuration file is
\fBplugstack.conf\fR in the same directory as \fBslurm.conf\fR(5),
though this may be changed via the SLURM config parameter
\fIPlugStackConfig\fR. The config file lists \fBSPANK\fR plugins,
@@ -210,7 +210,7 @@ the plugin for runtime configuration. Comments are preceded with '#'
and extend to the end of the line. If the configuration file
is missing or empty, it will simply be ignored.
.LP
-The format of each non-comment line in the configuration file is:
+The format of each non\-comment line in the configuration file is:
\fB
.nf
@@ -228,7 +228,7 @@ If a \fBSPANK\fR plugin is \fIrequired\fR, then failure of any of the
plugin's functions will cause \fBslurmd\fR to terminate the job, while
\fIoptional\fR plugins only cause a warning.
.LP
-If a fully-qualified path is not specified for a plugin, then the
+If a fully\-qualified path is not specified for a plugin, then the
currently configure \fIPluginDir\fR in \fBslurm.conf\fR(5) is searched.
.LP
\fBSPANK\fR plugins are stackable, meaning that more than one plugin may
@@ -236,7 +236,7 @@ be placed into the config file. The plugins will simply be called
in order, one after the other, and appropriate action taken on
failure given that state of the plugin's \fIoptional\fR flag.
.LP
-The \fBSPANK\fR config file is re-read on each job launch, so editing
+The \fBSPANK\fR config file is re\-read on each job launch, so editing
the config file will not affect running jobs. However care should
be taken so that a partially edited config file is not read by a
launching job.
@@ -250,13 +250,13 @@ Simple \fBSPANK\fR config file:
#
# required? plugin args
#
-optional renice.so min_prio=-10
+optional renice.so min_prio=\-10
required /usr/lib/slurm/test.so
.fi
.LP
The following is a simple \fBSPANK\fR plugin to modify the nice value
-of job tasks. This plugin adds a --renice=[prio] option to srun which
+of job tasks. This plugin adds a \-\-renice=[prio] option to srun which
users can use to set the priority of all remote tasks. Priority may
also be specified via a SLURM_RENICE environment variable. A minimum
priority may be established via a "min_prio" parameter in \fBplugstack.conf\fR
@@ -265,7 +265,7 @@ priority may be established via a "min_prio" parameter in \fBplugstack.conf\fR
/*
* To compile:
- * gcc -shared -o renice.so renice.c
+ * gcc \-shared \-o renice.so renice.c
*
*/
#include <sys/types.h>
@@ -289,7 +289,7 @@ SPANK_PLUGIN(renice, 1);
* Minimum allowable value for priority. May be set globally
* via plugin option min_prio=<prio>
*/
-static int min_prio = -20;
+static int min_prio = \-20;
static int prio = PRIO_NOT_SET;
@@ -297,11 +297,11 @@ static int _renice_opt_process (int val, const char *optarg, int remote);
static int _str2prio (const char *str, int *p2int);
/*
- * Provide a --renice=[prio] option to srun:
+ * Provide a \-\-renice=[prio] option to srun:
*/
struct spank_option spank_options[] =
{
- { "renice", "[prio]", "Re-nice job tasks to priority [prio].", 1, 0,
+ { "renice", "[prio]", "Re\-nice job tasks to priority [prio].", 1, 0,
(spank_opt_cb_f) _renice_opt_process
},
SPANK_OPTIONS_TABLE_END
@@ -348,7 +348,7 @@ int slurm_spank_task_post_fork (spank_t sp, int ac, char **av)
if (_str2prio (val, &prio) < 0) {
slurm_error ("Bad value for %s: %s", PRIO_ENV_VAR, optarg);
- return (-1);
+ return (\-1);
}
if (prio < min_prio)
@@ -362,11 +362,11 @@ int slurm_spank_task_post_fork (spank_t sp, int ac, char **av)
spank_get_item (sp, S_TASK_GLOBAL_ID, &taskid);
spank_get_item (sp, S_TASK_PID, &pid);
- slurm_info ("re-nicing task%d pid %ld to %ld", taskid, pid, prio);
+ slurm_info ("re\-nicing task%d pid %ld to %ld", taskid, pid, prio);
if (setpriority (PRIO_PROCESS, (int) pid, (int) prio) < 0) {
slurm_error ("setpriority: %m");
- return (-1);
+ return (\-1);
}
return (0);
@@ -378,8 +378,8 @@ static int _str2prio (const char *str, int *p2int)
char *p;
l = strtol (str, &p, 10);
- if ((*p != '\0') || (l < -20) || (l > 20))
- return (-1);
+ if ((*p != '\0') || (l < \-20) || (l > 20))
+ return (\-1);
*p2int = (int) l;
@@ -390,16 +390,16 @@ static int _renice_opt_process (int val, const char *optarg, int remote)
{
if (optarg == NULL) {
slurm_error ("renice: invalid argument!");
- return (-1);
+ return (\-1);
}
if (_str2prio (optarg, &prio) < 0) {
- slurm_error ("Bad value for --renice: %s", optarg);
- return (-1);
+ slurm_error ("Bad value for \-\-renice: %s", optarg);
+ return (\-1);
}
if (prio < min_prio)
- slurm_error ("--renice=%d not allowed, will use min=%d",
+ slurm_error ("\-\-renice=%d not allowed, will use min=%d",
prio, min_prio);
return (0);
@@ -410,7 +410,7 @@ static int _renice_opt_process (int val, const char *optarg, int remote)
.SH "COPYING"
Copyright (C) 2006 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
-UCRL-CODE-217948.
+UCRL\-CODE\-217948.
.LP
This file is part of SLURM, a resource management program.
For details, see <http://www.llnl.gov/linux/slurm/>.
@@ -425,11 +425,11 @@ 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"
-\fB/etc/slurm/slurm.conf\fR - SLURM configuration file.
+\fB/etc/slurm/slurm.conf\fR \- SLURM configuration file.
.br
-\fB/etc/slurm/plugstack.conf\fR - SPANK configuration file.
+\fB/etc/slurm/plugstack.conf\fR \- SPANK configuration file.
.br
-\fB/usr/include/slurm/spank.h\fR - SPANK header file.
+\fB/usr/include/slurm/spank.h\fR \- SPANK header file.
.SH "SEE ALSO"
.LP
\fBslurm.conf\fR(5)
--
GitLab