From 8f9e5e7e829efe7a490f5b83bcc6fe51d4dc96bc Mon Sep 17 00:00:00 2001 From: Gennaro Oliva <oliva.g@na.icar.cnr.it> Date: Mon, 11 Jan 2016 10:04:05 -0500 Subject: [PATCH] doc patch: properly escape hyphens in man pages --- doc/man/man1/srun.1 | 4 ++-- doc/man/man5/slurm.conf.5 | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1 index 47456e06c01..b724ca407a6 100644 --- a/doc/man/man1/srun.1 +++ b/doc/man/man1/srun.1 @@ -1,4 +1,4 @@ -.TH srun "1" "Slurm Commands" "November 2015" "Slurm Commands" +.TH srun "1" "Slurm Commands" "January 2016" "Slurm Commands" .SH "NAME" srun \- Run parallel jobs @@ -145,7 +145,7 @@ Copy executable file to allocated compute nodes. If a file name is specified, copy the executable to the specified destination file path. If no path is specified, copy the file to a file named "slurm_bcast_<job_id>.<step_id>" in the current working. -For example, "srun \-\-bcast=/tmp/mine -N3 a.out" will copy the file "a.out" +For example, "srun \-\-bcast=/tmp/mine \-N3 a.out" will copy the file "a.out" from your current directory to the file "/tmp/mine" on each of the three allocated compute nodes and execute that file. diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5 index cc752269b96..02d85c8786c 100644 --- a/doc/man/man5/slurm.conf.5 +++ b/doc/man/man5/slurm.conf.5 @@ -1,4 +1,4 @@ -.TH "slurm.conf" "5" "Slurm Configuration File" "November 2015" "Slurm Configuration File" +.TH "slurm.conf" "5" "Slurm Configuration File" "January 2016" "Slurm Configuration File" .SH "NAME" slurm.conf \- Slurm configuration file @@ -1666,7 +1666,7 @@ not recommended. .TP \fBREQUEUE\fR preempts jobs by requeuing them (if possible) or canceling them. -For jobs to be requeued they must have the --requeue sbatch option set +For jobs to be requeued they must have the \-\-requeue sbatch option set or the cluster wide JobRequeue parameter in slurm.conf must be set to one. .TP \fBSUSPEND\fR -- GitLab