From d037663cae85f9c1f6b98e047f8ef2e5820d1cb2 Mon Sep 17 00:00:00 2001 From: Danny Auble <da@schedmd.com> Date: Tue, 9 Aug 2011 11:13:57 -0700 Subject: [PATCH] made it so we wouldn't get broken links if using man2html --- doc/man/man1/sacct.1 | 5 +++-- doc/man/man1/salloc.1 | 4 ++-- doc/man/man1/sattach.1 | 2 +- doc/man/man1/sbatch.1 | 4 ++-- doc/man/man1/scancel.1 | 2 +- doc/man/man1/scontrol.1 | 23 ++++++++++++----------- doc/man/man1/sinfo.1 | 11 ++++++----- doc/man/man1/smap.1 | 11 ++++++----- doc/man/man1/squeue.1 | 6 +++--- doc/man/man1/srun.1 | 6 +++--- doc/man/man1/sview.1 | 2 +- doc/man/man5/slurm.conf.5 | 12 ++++++------ doc/man/man5/slurmdbd.conf.5 | 2 +- doc/man/man8/slurmd.8 | 4 ++-- doc/man/man8/spank.8 | 12 ++++++------ 15 files changed, 55 insertions(+), 51 deletions(-) diff --git a/doc/man/man1/sacct.1 b/doc/man/man1/sacct.1 index 49bffd0a6b7..b6dc83acdf0 100644 --- a/doc/man/man1/sacct.1 +++ b/doc/man/man1/sacct.1 @@ -44,7 +44,7 @@ Much of the data reported by \f3sacct\fP has been generated by the \f2wait3()\fP and \f2getrusage()\fP system calls. Some systems gather and report incomplete information for these calls; \f3sacct\fP reports values of 0 for this missing data. See your systems -\f2getrusage(3)\fP man page for information about which data are +\f2getrusage (3)\fP man page for information about which data are actually available on your system. .IP If \-\-dump is specified, the field selection options (\-\-brief, @@ -1221,4 +1221,5 @@ designate the job accounting log file that collects system job accounting. The default job accounting log file. By default, this file is set to read and write permission for root only. .SH "SEE ALSO" -\fBsstat\fR(1), \fBps\fR(1), \fBsrun\fR(1), \fBsqueue\fR(1), \fBgetrusage\fR(2), \fBtime\fR(2) +\fBsstat\fR(1), \fBps\fR (1), \fBsrun\fR(1), \fBsqueue\fR(1), +\fBgetrusage\fR (2), \fBtime\fR (2) diff --git a/doc/man/man1/salloc.1 b/doc/man/man1/salloc.1 index 4eadd9d3984..15efbd58672 100644 --- a/doc/man/man1/salloc.1 +++ b/doc/man/man1/salloc.1 @@ -533,7 +533,7 @@ http://www.schedmd.com/slurmdocs/mc_support.html .br and .br -http://www.schedmd.com/slurmdocs/dist_plane.html. +http://www.schedmd.com/slurmdocs/dist_plane.html .TP .B arbitrary The arbitrary method of distribution will allocate processes in\-order @@ -1209,4 +1209,4 @@ details. .SH "SEE ALSO" .LP \fBsinfo\fR(1), \fBsattach\fR(1), \fBsbatch\fR(1), \fBsqueue\fR(1), \fBscancel\fR(1), \fBscontrol\fR(1), -\fBslurm.conf\fR(5), \fBsched_setaffinity\fR(2), \fBnuma\fR(3) +\fBslurm.conf\fR(5), \fBsched_setaffinity\fR (2), \fBnuma\fR (3) diff --git a/doc/man/man1/sattach.1 b/doc/man/man1/sattach.1 index c3ce9f0505f..17508a34448 100644 --- a/doc/man/man1/sattach.1 +++ b/doc/man/man1/sattach.1 @@ -112,4 +112,4 @@ details. .LP \fBsinfo\fR(1), \fBsalloc\fR(1), \fBsbatch\fR(1), \fBsqueue\fR(1), \fBscancel\fR(1), \fBscontrol\fR(1), -\fBslurm.conf\fR(5), \fBsched_setaffinity\fR(2), \fBnuma\fR(3) +\fBslurm.conf\fR(5), \fBsched_setaffinity\fR (2), \fBnuma\fR (3) diff --git a/doc/man/man1/sbatch.1 b/doc/man/man1/sbatch.1 index 6736ae29180..5ee4fd56127 100644 --- a/doc/man/man1/sbatch.1 +++ b/doc/man/man1/sbatch.1 @@ -586,7 +586,7 @@ http://www.schedmd.com/slurmdocs/mc_support.html .br and .br -http://www.schedmd.com/slurmdocs/dist_plane.html. +http://www.schedmd.com/slurmdocs/dist_plane.html .TP .B arbitrary The arbitrary method of distribution will allocate processes in\-order @@ -1379,4 +1379,4 @@ details. .SH "SEE ALSO" .LP \fBsinfo\fR(1), \fBsattach\fR(1), \fBsalloc\fR(1), \fBsqueue\fR(1), \fBscancel\fR(1), \fBscontrol\fR(1), -\fBslurm.conf\fR(5), \fBsched_setaffinity\fR(2), \fBnuma\fR(3) +\fBslurm.conf\fR(5), \fBsched_setaffinity\fR (2), \fBnuma\fR (3) diff --git a/doc/man/man1/scancel.1 b/doc/man/man1/scancel.1 index 3968848aaea..d99194564b1 100644 --- a/doc/man/man1/scancel.1 +++ b/doc/man/man1/scancel.1 @@ -238,4 +238,4 @@ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .SH "SEE ALSO" -\fBslurm_kill_job\fR(3), \fBslurm_kill_job_step\fR(3) +\fBslurm_kill_job\fR (3), \fBslurm_kill_job_step\fR (3) diff --git a/doc/man/man1/scontrol.1 b/doc/man/man1/scontrol.1 index 12d54298669..f84c64e4c67 100644 --- a/doc/man/man1/scontrol.1 +++ b/doc/man/man1/scontrol.1 @@ -1365,15 +1365,16 @@ details. /etc/slurm.conf .SH "SEE ALSO" \fBscancel\fR(1), \fBsinfo\fR(1), \fBsqueue\fR(1), -\fBslurm_checkpoint\fR(3), -\fBslurm_create_partition\fR(3), -\fBslurm_delete_partition\fR(3), -\fBslurm_load_ctl_conf\fR(3), -\fBslurm_load_jobs\fR(3), \fBslurm_load_node\fR(3), -\fBslurm_load_partitions\fR(3), -\fBslurm_reconfigure\fR(3), \fBslurm_requeue\fR(3), \fBslurm_resume\fR(3), -\fBslurm_shutdown\fR(3), \fBslurm_suspend\fR(3), -\fBslurm_takeover\fR(3), -\fBslurm_update_job\fR(3), \fBslurm_update_node\fR(3), -\fBslurm_update_partition\fR(3), +\fBslurm_checkpoint\fR (3), +\fBslurm_create_partition\fR (3), +\fBslurm_delete_partition\fR (3), +\fBslurm_load_ctl_conf\fR (3), +\fBslurm_load_jobs\fR (3), \fBslurm_load_node\fR (3), +\fBslurm_load_partitions\fR (3), +\fBslurm_reconfigure\fR (3), \fBslurm_requeue\fR (3), +\fBslurm_resume\fR (3), +\fBslurm_shutdown\fR (3), \fBslurm_suspend\fR (3), +\fBslurm_takeover\fR (3), +\fBslurm_update_job\fR (3), \fBslurm_update_node\fR (3), +\fBslurm_update_partition\fR (3), \fBslurm.conf\fR(5), \fBslurmctld\fR(8) diff --git a/doc/man/man1/sinfo.1 b/doc/man/man1/sinfo.1 index f8e762e1cb4..fd0e7654510 100644 --- a/doc/man/man1/sinfo.1 +++ b/doc/man/man1/sinfo.1 @@ -580,9 +580,10 @@ details. .SH "SEE ALSO" \fBscontrol\fR(1), \fBsmap\fR(1), \fBsqueue\fR(1), -\fBslurm_load_ctl_conf\fR(3), \fBslurm_load_jobs\fR(3), \fBslurm_load_node\fR(3), -\fBslurm_load_partitions\fR(3), -\fBslurm_reconfigure\fR(3), \fBslurm_shutdown\fR(3), -\fBslurm_update_job\fR(3), \fBslurm_update_node\fR(3), -\fBslurm_update_partition\fR(3), +\fBslurm_load_ctl_conf\fR (3), \fBslurm_load_jobs\fR (3), +\fBslurm_load_node\fR (3), +\fBslurm_load_partitions\fR (3), +\fBslurm_reconfigure\fR (3), \fBslurm_shutdown\fR (3), +\fBslurm_update_job\fR (3), \fBslurm_update_node\fR (3), +\fBslurm_update_partition\fR (3), \fBslurm.conf\fR(5) diff --git a/doc/man/man1/smap.1 b/doc/man/man1/smap.1 index 735cb93bb41..1d77b445215 100644 --- a/doc/man/man1/smap.1 +++ b/doc/man/man1/smap.1 @@ -513,9 +513,10 @@ details. .SH "SEE ALSO" \fBscontrol\fR(1), \fBsinfo\fR(1), \fBsqueue\fR(1), -\fBslurm_load_ctl_conf\fR(3), \fBslurm_load_jobs\fR(3), \fBslurm_load_node\fR(3), -\fBslurm_load_partitions\fR(3), -\fBslurm_reconfigure\fR(3), \fBslurm_shutdown\fR(3), -\fBslurm_update_job\fR(3), \fBslurm_update_node\fR(3), -\fBslurm_update_partition\fR(3), +\fBslurm_load_ctl_conf\fR (3), \fBslurm_load_jobs\fR (3), +\fBslurm_load_node\fR (3), +\fBslurm_load_partitions\fR (3), +\fBslurm_reconfigure\fR (3), \fBslurm_shutdown\fR (3), +\fBslurm_update_job\fR (3), \fBslurm_update_node\fR (3), +\fBslurm_update_partition\fR (3), \fBslurm.conf\fR(5) diff --git a/doc/man/man1/squeue.1 b/doc/man/man1/squeue.1 index 909c817b676..f2e9c888aa4 100644 --- a/doc/man/man1/squeue.1 +++ b/doc/man/man1/squeue.1 @@ -630,6 +630,6 @@ details. .SH "SEE ALSO" \fBscancel\fR(1), \fBscontrol\fR(1), \fBsinfo\fR(1), \fBsmap\fR(1), \fBsrun\fR(1), -\fBslurm_load_ctl_conf\fR(3), \fBslurm_load_jobs\fR(3), -\fBslurm_load_node\fR(3), -\fBslurm_load_partitions\fR(3) +\fBslurm_load_ctl_conf\fR (3), \fBslurm_load_jobs\fR (3), +\fBslurm_load_node\fR (3), +\fBslurm_load_partitions\fR (3) diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1 index 19666a1e646..823e500f8d1 100644 --- a/doc/man/man1/srun.1 +++ b/doc/man/man1/srun.1 @@ -589,7 +589,7 @@ http://www.schedmd.com/slurmdocs/mc_support.html .br and .br -http://www.schedmd.com/slurmdocs/dist_plane.html. +http://www.schedmd.com/slurmdocs/dist_plane.html .TP .B arbitrary The arbitrary method of distribution will allocate processes in\-order @@ -2019,5 +2019,5 @@ details. .SH "SEE ALSO" \fBsalloc\fR(1), \fBsattach\fR(1), \fBsbatch\fR(1), \fBsbcast\fR(1), \fBscancel\fR(1), \fBscontrol\fR(1), \fBsqueue\fR(1), \fBslurm.conf\fR(5), -\fBsched_setaffinity\fR(2), \fBnuma\fR(3) -\fBgetrlimit\fR(2) +\fBsched_setaffinity\fR (2), \fBnuma\fR (3) +\fBgetrlimit\fR (2) diff --git a/doc/man/man1/sview.1 b/doc/man/man1/sview.1 index a878e0d6042..cf6d408fbc9 100644 --- a/doc/man/man1/sview.1 +++ b/doc/man/man1/sview.1 @@ -65,4 +65,4 @@ details. .SH "SEE ALSO" .LP \fBsinfo\fR(1), \fBsqueue\fR(1), \fBscontrol\fR(1), \fBslurm.conf\fR(5), -\fBsched_setaffinity\fR(2), \fBnuma\fR(3) +\fBsched_setaffinity\fR (2), \fBnuma\fR (3) diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5 index 0d8dd922d7e..105d39fbf14 100644 --- a/doc/man/man5/slurm.conf.5 +++ b/doc/man/man5/slurm.conf.5 @@ -1258,7 +1258,7 @@ Related configuration options include \fBResumeTimeout\fR, \fBResumeRate\fR, \fBSuspendRate\fR, \fBSuspendTime\fR, \fBSuspendTimeout\fR, \fBSuspendProgram\fR, \fBSuspendExcNodes\fR, and \fBSuspendExcParts\fR. More information is available at the SLURM web site -(http://www.schedmd.com/slurmdocs/power_save.html). +( http://www.schedmd.com/slurmdocs/power_save.html ). .TP \fBResumeRate\fR @@ -1284,7 +1284,7 @@ Related configuration options include \fBResumeProgram\fR, \fBResumeRate\fR, \fBSuspendRate\fR, \fBSuspendTime\fR, \fBSuspendTimeout\fR, \fBSuspendProgram\fR, \fBSuspendExcNodes\fR and \fBSuspendExcParts\fR. More information is available at the SLURM web site -(http://www.schedmd.com/slurmdocs/power_save.html). +( http://www.schedmd.com/slurmdocs/power_save.html ). .TP \fBResvOverRun\fR @@ -1796,7 +1796,7 @@ Related configuration options include \fBResumeProgram\fR, \fBResumeRate\fR, \fBResumeTimeout\fR, \fBSuspendRate\fR, \fBSuspendTime\fR, \fBSuspendProgram\fR, \fBSuspendExcNodes\fR and \fBSuspendExcParts\fR. More information is available at the SLURM web site -(http://www.schedmd.com/slurmdocs/power_save.html). +( http://www.schedmd.com/slurmdocs/power_save.html ). .TP \fBSwitchType\fR @@ -3169,8 +3169,8 @@ details. .SH "SEE ALSO" .LP -\fBbluegene.conf\fR(5), \fBcgroup.conf\fR(5), \fBgethostbyname\fR(3), -\fBgetrlimit\fR(2), \fBgres.conf\fR(5), \fBgroup\fR(5), \fBhostname\fR(1), +\fBbluegene.conf\fR(5), \fBcgroup.conf\fR(5), \fBgethostbyname\fR (3), +\fBgetrlimit\fR (2), \fBgres.conf\fR(5), \fBgroup\fR (5), \fBhostname\fR (1), \fBscontrol\fR(1), \fBslurmctld\fR(8), \fBslurmd\fR(8), \fBslurmdbd\fR(8), \fBslurmdbd.conf\fR(5), \fBsrun(1)\fR, -\fBspank(8)\fR, \fBsyslog\fR(2), \fBtopology.conf\fR(5), \fBwiki.conf\fR(5) +\fBspank(8)\fR, \fBsyslog\fR (2), \fBtopology.conf\fR(5), \fBwiki.conf\fR(5) diff --git a/doc/man/man5/slurmdbd.conf.5 b/doc/man/man5/slurmdbd.conf.5 index 8c2e273298d..032fd84f345 100644 --- a/doc/man/man5/slurmdbd.conf.5 +++ b/doc/man/man5/slurmdbd.conf.5 @@ -401,4 +401,4 @@ details. .LP \fBslurm.conf\fR(5), \fBslurmctld\fR(8), \fBslurmdbd\fR(8) -\fBsyslog\fR(2) +\fBsyslog\fR (2) diff --git a/doc/man/man8/slurmd.8 b/doc/man/man8/slurmd.8 index 9b8859a0131..9852731955b 100644 --- a/doc/man/man8/slurmd.8 +++ b/doc/man/man8/slurmd.8 @@ -40,9 +40,9 @@ Help; print a brief summary of command options. Write log messages to the specified file. .TP \fB\-M\fR -Lock slurmd pages into system memory using mlockall(2) to disable +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) +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. diff --git a/doc/man/man8/spank.8 b/doc/man/man8/spank.8 index 50cb2c9b4f1..233edffc78c 100644 --- a/doc/man/man8/spank.8 +++ b/doc/man/man8/spank.8 @@ -73,12 +73,12 @@ Called for each task just after fork, but before all elevated privileges are dropped. (remote context only) .TP \fBslurm_spank_task_init\fR -Called for each task just before execve(2). (remote context only) +Called for each task just before execve (2). (remote context only) .TP \fBslurm_spank_task_post_fork\fR -Called for each task from parent process after fork(2) is complete. +Called for each task from parent process after fork (2) is complete. Due to the fact that \fBslurmd\fR does not exec any tasks until all -tasks have completed fork(2), this call is guaranteed to run before +tasks have completed fork (2), this call is guaranteed to run before the user task is executed. (remote context only) .TP \fBslurm_spank_task_exit\fR @@ -166,8 +166,8 @@ the job's environment. The prototypes are: .fi .LP These are only necessary in remote context since modifications of -the standard process environment using \fBsetenv\fR(3), \fBgetenv\fR(3), -and \fBunsetenv\fR(3) may be used in local context. +the standard process environment using \fBsetenv\fR (3), \fBgetenv\fR (3), +and \fBunsetenv\fR (3) may be used in local context. .LP Functions are also available from within the \fBSPANK\fR plugins to establish environment variables to be exported to the SLURM @@ -244,7 +244,7 @@ is a short description of the option suitable for \-\-help output. .TP .I has_arg 0 if option takes no argument, 1 if option takes an argument, and -2 if the option takes an optional argument. (See \fBgetopt_long\fR(3)). +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. -- GitLab