-- Added man pages to html pages and the new cpu_management.html page.

   Submitted by Martin Perry / Rod Schultz, Bull.

NEWS

@@ -24,6 +24,8 @@ documents those changes that are of interest to users and admins.
     event triggers.
  -- Fix logic in BackupController to properly recover front-end node state and
     avoid purging active jobs.
+ -- Added man pages to html pages and the new cpu_management.html page.
+    Submitted by Martin Perry / Rod Schultz, Bull.
 
 * Changes in SLURM 2.3.0.pre4
 =============================

doc/html/Makefile.am

@@ -2,6 +2,38 @@
 htmldir = ${prefix}/share/doc/@PACKAGE@-@VERSION@/html
 
 generated_html = \
+	../man/man1/sacct.html \
+	../man/man1/sacctmgr.html \
+	../man/man1/salloc.html \
+	../man/man1/sattach.html \
+	../man/man1/sbatch.html \
+	../man/man1/sbcast.html \
+	../man/man1/scancel.html \
+	../man/man1/scontrol.html \
+	../man/man1/sinfo.html \
+	../man/man1/slurm.html \
+	../man/man1/smap.html \
+	../man/man1/sprio.html \
+	../man/man1/squeue.html \
+	../man/man1/sreport.html \
+	../man/man1/srun.html \
+	../man/man1/srun_cr.html \
+	../man/man1/sshare.html \
+	../man/man1/sstat.html \
+	../man/man1/strigger.html \
+	../man/man1/sview.html \
+	../man/man5/bluegene.conf.html \
+	../man/man5/cgroup.conf.html \
+	../man/man5/gres.conf.html \
+	../man/man5/slurm.conf.html \
+	../man/man5/slurmdbd.conf.html \
+	../man/man5/topology.conf.html \
+	../man/man5/wiki.conf.html \
+	../man/man8/slurmctld.html \
+	../man/man8/slurmd.html \
+	../man/man8/slurmdbd.html \
+	../man/man8/slurmstepd.html \
+	../man/man8/spank.html \
 	accounting.html \
 	accounting_storageplugins.html \
 	api.html \
@@ -13,6 +45,7 @@ generated_html = \
 	checkpoint_plugins.html \
 	cons_res.html \
 	cons_res_share.html \
+	cpu_management.html \
 	cray.html \
 	crypto_plugins.html \
 	dist_plane.html \
@@ -30,6 +63,7 @@ generated_html = \
 	job_submit_plugins.html \
 	jobcompplugins.html \
 	mail.html \
+	man_index.html \
 	maui.html \
 	mc_support.html \
 	meetings.html \
@@ -101,3 +135,10 @@ SUFFIXES = .html
 
 .shtml.html:
 	`dirname $<`/shtml2html.py $<
+
+.1.html:
+	$(top_srcdir)/doc/html/man2html.py $<
+.5.html:
+	$(top_srcdir)/doc/html/man2html.py $<
+.8.html:
+	$(top_srcdir)/doc/html/man2html.py $<

doc/html/Makefile.in

@@ -301,6 +301,38 @@ top_build_prefix = @top_build_prefix@
 top_builddir = @top_builddir@
 top_srcdir = @top_srcdir@
 generated_html = \
+	../man/man1/sacct.html \
+	../man/man1/sacctmgr.html \
+	../man/man1/salloc.html \
+	../man/man1/sattach.html \
+	../man/man1/sbatch.html \
+	../man/man1/sbcast.html \
+	../man/man1/scancel.html \
+	../man/man1/scontrol.html \
+	../man/man1/sinfo.html \
+	../man/man1/slurm.html \
+	../man/man1/smap.html \
+	../man/man1/sprio.html \
+	../man/man1/squeue.html \
+	../man/man1/sreport.html \
+	../man/man1/srun.html \
+	../man/man1/srun_cr.html \
+	../man/man1/sshare.html \
+	../man/man1/sstat.html \
+	../man/man1/strigger.html \
+	../man/man1/sview.html \
+	../man/man5/bluegene.conf.html \
+	../man/man5/cgroup.conf.html \
+	../man/man5/gres.conf.html \
+	../man/man5/slurm.conf.html \
+	../man/man5/slurmdbd.conf.html \
+	../man/man5/topology.conf.html \
+	../man/man5/wiki.conf.html \
+	../man/man8/slurmctld.html \
+	../man/man8/slurmd.html \
+	../man/man8/slurmdbd.html \
+	../man/man8/slurmstepd.html \
+	../man/man8/spank.html \
 	accounting.html \
 	accounting_storageplugins.html \
 	api.html \
@@ -312,6 +344,7 @@ generated_html = \
 	checkpoint_plugins.html \
 	cons_res.html \
 	cons_res_share.html \
+	cpu_management.html \
 	cray.html \
 	crypto_plugins.html \
 	dist_plane.html \
@@ -329,6 +362,7 @@ generated_html = \
 	job_submit_plugins.html \
 	jobcompplugins.html \
 	mail.html \
+	man_index.html \
 	maui.html \
 	mc_support.html \
 	meetings.html \
@@ -398,7 +432,7 @@ SUFFIXES = .html
 all: all-am
 
 .SUFFIXES:
-.SUFFIXES: .html .shtml
+.SUFFIXES: .html .1 .5 .8 .shtml
 $(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am  $(am__configure_deps)
 	@for dep in $?; do \
 	  case '$(am__configure_deps)' in \
@@ -611,6 +645,13 @@ uninstall-am: uninstall-htmlDATA
 .shtml.html:
 	`dirname $<`/shtml2html.py $<
 
+.1.html:
+	$(top_srcdir)/doc/html/man2html.py $<
+.5.html:
+	$(top_srcdir)/doc/html/man2html.py $<
+.8.html:
+	$(top_srcdir)/doc/html/man2html.py $<
+
 # Tell versions [3.59,3.63) of GNU make to not export all variables.
 # Otherwise a system limit (for SysV at least) may be exceeded.
 .NOEXPORT:

doc/html/documentation.shtml

@@ -7,6 +7,8 @@ Also see <a href="publications.html">Publications and Presentations</a>.
 <h2>SLURM Users</h2>
 <ul>
 <li><a href="quickstart.html">Quick Start User Guide</a></li>
+<li><a href="man_index.html">Man Pages</a></li>
+<li><a href="cpu_management.html">CPU Management User and Administrator Guide</a></li>
 <li><a href="mpi_guide.html">MPI Use Guide</a></li>
 <li><a href="mc_support.html">Support for Multi-core/Multi-threaded Architectures</a></li>
 <li><a href="multi_cluster.html">Multi-Cluster Operation</a></li>
@@ -23,6 +25,7 @@ Also see <a href="publications.html">Publications and Presentations</a>.
 <h2>SLURM Administrators</h2>
 <ul>
 <li><a href="quickstart_admin.html">Quick Start Administrator Guide</a></li>
+<li><a href="cpu_management.html">CPU Management User and Administrator Guide</a></li>
 <li><a href="configurator.html">Configuration Tool</a></li>
 <li><a href="troubleshoot.html">Troubleshooting Guide</a></li>
 <li><a href="big_sys.html">Large Cluster Administration Guide</a></li>
@@ -84,6 +87,6 @@ Also see <a href="publications.html">Publications and Presentations</a>.
 </li>
 </ul>
 
-<p style="text-align:center;">Last modified 27 August 2010</p>
+<p style="text-align:center;">Last modified 30 March 2011</p>
 
 <!--#include virtual="footer.txt"-->

doc/html/man2html.py

+#!/usr/bin/env python
+
+import re
+import sys
+import os
+include_pat = r'(<!--\s*#include\s*virtual\s*=\s*"([^"]+)"\s*-->)'
+include_regex = re.compile(include_pat)
+
+url_pat = r'(\s+href\s*=\s*")([^"#]+)(#[^"]+)?(")'
+url_regex = re.compile(url_pat)
+
+dirname = ''
+
+# Instert tags for options
+#   Two styles are processed.
+#       <DT><B>pppppp</B><DD> 
+#           has tag <a id="OPT_pppppp"></a>
+#       <DT><B>--pppppp</B> or <DT><B>-P</B>, <B>--pppppp</B>
+#           has tag <a id="OPT_pppppp"></a>
+#   <H2>hhhh</h2> also has tag has tag <a id="SECTION_hhhh"></a> inserted
+def insert_tag(html, lineIn):
+    if lineIn[0:4] == "<H2>":
+        posEnd = lineIn.find("</H2>")
+        if posEnd != -1:
+            html.write('<a id="SECTION_' + lineIn[4:posEnd] + '"></a>\n')
+            return
+        
+    if lineIn[0:7] != "<DT><B>":
+        return
+    posBgn = lineIn.find("--")
+    if posBgn == -1:
+        # 1st form
+        posBgn = 5
+    posBgn = posBgn + 2
+    posEnd = lineIn.find("</B>",posBgn)
+    if posEnd == -1:
+        # poorly constructed
+        return
+    html.write('<a id="OPT_' + lineIn[posBgn:posEnd] + '"></a>\n')
+    return
+
+            
+def llnl_references(line):
+        manStr = "Refer to the mc_support.html document"
+        htmlStr = 'Refer to the <a href="mc_support.html">mc_support</a> document'
+        lineFix = line.replace(manStr,htmlStr)
+        if lineFix != line:
+            return lineFix
+        manStr = '<A HREF="https://computing.llnl.gov/linux/slurm/mc_support.html">https://computing.llnl.gov/linux/slurm/mc_support.html</A>'
+        htmlStr = 'the <a href="mc_support.html">mc_support</a> document'
+        lineFix = line.replace(manStr,htmlStr)
+        if lineFix != line:
+            return lineFix
+        manStr = '<A HREF="https://computing.llnl.gov/linux/slurm/dist_plane.html.">https://computing.llnl.gov/linux/slurm/dist_plane.html.</A>'
+        htmlStr = 'the <a href="dist_plane.html">dist_plane</a> document'
+        lineFix = line.replace(manStr,htmlStr)
+        if lineFix != line:
+            return lineFix
+        manStr = '&lt;<A HREF="https://computing.llnl.gov/linux/slurm/mpi_guide.html">https://computing.llnl.gov/linux/slurm/mpi_guide.html</A>&gt;'
+        htmlStr = '<a href="mpi_guide.html">mpi_guide</a>'
+        lineFix = line.replace(manStr,htmlStr)
+        if lineFix != line:
+            return lineFix
+        manStr = '(<A HREF="https://computing.llnl.gov/linux/slurm/power_save.html).">https://computing.llnl.gov/linux/slurm/power_save.html).</A>'
+        htmlStr = '<a href="power_save.html">power_save</a>'
+        lineFix = line.replace(manStr,htmlStr)
+        if lineFix != line:
+            return lineFix
+        manStr = '<A HREF="https://computing.llnl.gov/linux/slurm/cons_res.html">https://computing.llnl.gov/linux/slurm/cons_res.html</A>'
+        htmlStr = '<a href="cons_res.html">cons_res</a>'
+        lineFix = line.replace(manStr,htmlStr)
+        if lineFix != line:
+            return lineFix
+        manStr = '<A HREF="https://computing.llnl.gov/linux/slurm/cons_res_share.html">https://computing.llnl.gov/linux/slurm/cons_res_share.html</A>'
+        htmlStr = '<a href="cons_res_share.html">cons_res_share</a>'
+        lineFix = line.replace(manStr,htmlStr)
+        if lineFix != line:
+            return lineFix
+        manStr = '<A HREF="https://computing.llnl.gov/linux/slurm/gang_scheduling.html">https://computing.llnl.gov/linux/slurm/gang_scheduling.html</A>'
+        htmlStr = '<a href="gang_scheduling.html">gang_scheduling</a>'
+        lineFix = line.replace(manStr,htmlStr)
+        if lineFix != line:
+            return lineFix
+        manStr = '<A HREF="https://computing.llnl.gov/linux/slurm/preempt.html">https://computing.llnl.gov/linux/slurm/preempt.html</A>'
+        htmlStr = '<a href="preempt.html">preempt</a>'
+        lineFix = line.replace(manStr,htmlStr)
+        if lineFix != line:
+            return lineFix
+        return line
+
+def relative_reference(lineIn, fullRef):
+    lineOt = ""
+    cursor = 0
+    
+    posHREF = lineIn.find(fullRef,cursor)
+    while posHREF != -1:
+        lineOt = lineOt + lineIn[cursor:posHREF-1]
+        cursor = posHREF + len(fullRef) + 2
+        lineOt = lineOt + '"'
+        posQuote = lineIn.find('"',cursor)
+        lineOt = lineOt + lineIn[cursor:posQuote] + ".html" 
+        cursor = posQuote
+        posHREF = lineIn.find(fullRef,cursor)
+    lineOt = lineOt + lineIn[cursor:]
+    return lineOt
+
+
+def include_virtual(matchobj):
+    global dirname
+    if dirname:
+        filename = dirname + '/' + matchobj.group(2)
+    else:
+        filename = matchobj.group(2)
+
+    if os.access(filename, os.F_OK):
+        #print 'Including file', filename
+        lines = file(filename, 'r').read()
+        return lines
+    else:
+        return matchobj.group(0)
+
+def url_rewrite(matchobj):
+    global dirname
+    if dirname:
+        localpath = dirname + '/' + matchobj.group(2)
+    else:
+        localpath = matchobj.group(2)
+
+    if matchobj.group(2)[-6:] == '.shtml' and os.access(localpath, os.F_OK):
+        location = matchobj.group(2)
+        if matchobj.group(3) is None:
+            newname = location[:-6] + '.html'
+        else:
+            newname = location[:-6] + '.html' + matchobj.group(3)
+        #print 'Rewriting', location, 'to', newname
+        return matchobj.group(1) + newname + matchobj.group(4)
+    else:
+        return matchobj.group(0)
+  
+files = []
+for f in sys.argv[1:]:
+    posLastDot = f.rfind(".")
+    mhtmlname = f[:posLastDot] + ".mhtml"
+    cmd = "man2html " + f + "> " + mhtmlname
+    os.system(cmd)
+    print ">>>>>>> " + mhtmlname
+    files.append(mhtmlname)
+
+for filename in files:
+    dirname, basefilename = os.path.split(filename)
+#    newfilename = basefilename[:-6] + '.html'
+    newfilename = filename[:-6] + '.html'
+    print 'Converting', filename, '->', newfilename
+    shtml = file(filename, 'r')
+    html = file(newfilename, 'w')
+
+    lines = file("header.txt", 'r').read()
+    lines = lines.replace(".shtml",".html")
+    html.write(lines)
+#    html.write(<!--#include virtual="header.txt"-->)
+    for line in shtml.readlines():
+        # Remove html header/footer created by man2html
+        if line == "Content-type: text/html\n":
+            continue
+        if line[:6] == "<HTML>":
+            continue
+        if line[:7] == "</HEAD>":
+            continue
+        if line[:7] == "</HTML>":
+            continue
+        if line[:7] == "</BODY>":
+            continue
+        line = include_regex.sub(include_virtual, line)
+        # Special case some html references
+        line = llnl_references(line)
+        #insert tags for some options
+        insert_tag(html, line)
+        # Make man2html links relative ones
+        line = relative_reference(line,"http://localhost/cgi-bin/man/man2html?")
+
+        line = url_regex.sub(url_rewrite, line)
+        html.write(line)
+    lines = file("footer.txt", 'r').read()
+    html.write(lines)
+#    html.write(<!--#include virtual="footer.txt"-->)
+    html.close()
+    shtml.close()

doc/html/man_index.shtml

+<!--#include virtual="header.txt"-->
+
+<h1>Man Pages</h1>
+
+<table border="1">
+<tr><td><a href="sacct.html">sacct</a></td><td>displays accounting data for all jobs and job steps in the SLURM job accounting log or SLURM database</td></tr>
+<tr><td><a href="sacctmgr.html">sacctmgr</a></td><td>Used to view and modify Slurm account information.</td></tr>
+<tr><td><a href="salloc.html">salloc</a></td><td>Obtain a SLURM job allocation (a set of nodes), execute a command, and then release the allocation when the command is finished.</td></tr>
+<tr><td><a href="sattach.html">sattach</a></td><td>Attach to a SLURM job step.</td></tr>
+<tr><td><a href="sbatch.html">sbatch</a></td><td>Submit a batch script to SLURM.</td></tr>
+<tr><td><a href="sbcast.html">sbcast</a></td><td>transmit a file to the nodes allocated to a SLURM job.</td></tr>
+<tr><td><a href="scancel.html">scancel</a></td><td>Used to signal jobs or job steps that are under the control of Slurm.</td></tr>
+<tr><td><a href="scontrol.html">scontrol</a></td><td>Used view and modify Slurm configuration and state.</td></tr>
+<tr><td><a href="sinfo.html">sinfo</a></td><td>view information about SLURM nodes and partitions.</td></tr>
+<tr><td><a href="slurm.html">slurm</a></td><td>SLURM system overview.</td></tr>
+<tr><td><a href="smap.html">smap</a></td><td>graphically view information about SLURM jobs, partitions, and set configurations parameters.</td></tr>
+<tr><td><a href="sprio.html">sprio</a></td><td>view the factors that comprise a job's scheduling priority</td></tr>
+<tr><td><a href="squeue.html">squeue</a></td><td>view information about jobs located in the SLURM scheduling queue.</td></tr>
+<tr><td><a href="sreport.html">sreport</a></td><td>Generate reports from the slurm accounting data.</td></tr>
+<tr><td><a href="srun_cr.html">srun_cr</a></td><td>run parallel jobs with checkpoint/restart support</td></tr>
+<tr><td><a href="srun.html">srun</a></td><td>Run parallel jobs</td></tr>
+<tr><td><a href="sshare.html">sshare</a></td><td>Tool for listing the shares of associations to a cluster.</td></tr>
+<tr><td><a href="sstat.html">sstat</a></td><td>Display various status information of a running job/step.</td></tr>
+<tr><td><a href="strigger.html">strigger</a></td><td>Used set, get or clear Slurm trigger information.</td></tr>
+<tr><td><a href="sview.html">sview</a></td><td>graphical user interface to view and modify SLURM state.</td></tr>
+<tr><td><a href="bluegene.conf.html">bluegene.conf</a></td><td>Slurm configuration file for BlueGene systems</td></tr>
+<tr><td><a href="cgroup.conf.html">cgroup.conf</a></td><td>Slurm configuration file for the cgroup support</td></tr>
+<tr><td><a href="gres.conf.html">gres.conf</a></td><td>Slurm configuration file for generic resource management.</td></tr>
+<tr><td><a href="slurm.conf.html">slurm.conf</a></td><td>Slurm configuration file</td></tr>
+<tr><td><a href="slurmdbd.conf.html">slurmdbd.conf</a></td><td>Slurm Database Daemon (SlurmDBD) configuration file</td></tr>
+<tr><td><a href="topology.conf.html">topology.conf</a></td><td>Slurm configuration file for defining the network topology</td></tr>
+<tr><td><a href="wiki.conf.html">wiki.conf</a></td><td>Slurm configuration file for wiki and wiki2 scheduler plugins</td></tr>
+<tr><td><a href="slurm_setup.sh.html">slurm_setup.sh</a></td><td>A script to help install and setup SLURM</td></tr>
+<tr><td><a href="slurmctld.html">slurmctld</a></td><td>The central management daemon of Slurm.</td></tr>
+<tr><td><a href="slurmd.html">slurmd</a></td><td>The compute node daemon for SLURM.</td></tr>
+<tr><td><a href="slurmdbd.html">slurmdbd</a></td><td>Slurm Database Daemon.</td></tr>
+<tr><td><a href="slurmstepd.html">slurmstepd</a></td><td>The job step manager for SLURM.</td></tr>
+<tr><td><a href="SPANK.html">SPANK</a></td><td>SLURM Plug-in Architecture for Node and job (K)control</td></tr>
+</table>
+
+
+<p style="text-align:center;">Last modified 15 October 2010</p>
+
+<!--#include virtual="footer.txt"-->

doc/man/man1/salloc.1

@@ -21,6 +21,11 @@ section). If no command is specified, then the value of
 \fBSallocDefaultCommand\fR is not set, then \fBsalloc\fR runs the
 user's default shell.
 
+The following document describes the the influence of various options on the 
+allocation of cpus to jobs and tasks. 
+.br
+https://computing.llnl.gov/linux/slurm/cpu_management.html
+
 NOTE: The salloc logic includes support to save and restore the terminal line
 settings and is designed to be executed in the foreground. If you need to
 execute salloc in the background, set its standard input to some file, for

doc/man/man1/sbatch.1

@@ -25,6 +25,11 @@ When the job allocation is finally granted for the batch script, SLURM
 runs a single copy of the batch script on the first node in the set of
 allocated nodes.
 
+The following document describes the the influence of various options on the 
+allocation of cpus to jobs and tasks. 
+.br
+https://computing.llnl.gov/linux/slurm/cpu_management.html
+
 .SH "OPTIONS"
 .LP
 

doc/man/man1/srun.1

@@ -10,6 +10,11 @@ srun \- Run parallel jobs
 Run a parallel job on cluster managed by SLURM.  If necessary, srun will
 first create a resource allocation in which to run the parallel job.
 
+The following document describes the the influence of various options on the 
+allocation of cpus to jobs and tasks. 
+.br
+https://computing.llnl.gov/linux/slurm/cpu_management.html
+
 .SH "OPTIONS"
 .LP