[padb-devel] [padb commit] r36 - Spell check the website and cleanup the usage page
codesite-noreply at google.com
codesite-noreply at google.com
Mon Jun 8 22:15:46 BST 2009
Author: apittman
Date: Mon Jun 8 14:14:56 2009
New Revision: 36
Modified:
trunk/doc/download.html
trunk/doc/extensions.html
trunk/doc/index.html
trunk/doc/usage.html
Log:
Spell check the website and cleanup the usage page
slightly.
Modified: trunk/doc/download.html
==============================================================================
--- trunk/doc/download.html (original)
+++ trunk/doc/download.html Mon Jun 8 14:14:56 2009
@@ -2,22 +2,22 @@
<h2>Beta version</h2>
-The current Beta release is 2.5 and avaliable for download
-<a href=padb-2.5.tgz title="Download beta release">here</a> or from the
google
+The current Beta release (r31) is 2.5-beta and available for download
+<a href=padb-2.5-r31.tgz title="Download beta release">here</a> or from
the google
<a href=http://code.google.com/p/padb/downloads/list>downloads</a> section.
-<h2>Stable version</h2>
+<h2>Stable release</h2>
At present there are no "stable" releases made since the Quadrics 2.2
version, a release is scheduled for early June 2009.
<h3>Quadrics release</h3>
-The latest stable release from Quadrics is 2.2 was made on the 16th
+The latest stable release from Quadrics is version 2.2 was made on the 16th
March 2009 and at the time of writing is downloadable from their
<a href=http://www.quadrics.com/linux title="Quadrics download
page">website
-</a> in the QSNET2LIBS package. The padb avaliable on this site
-is a fork of that release.
+</a> in the QSNET2LIBS package. No further releases are expected
+from quadrics at this time.
<h2>Source code access</h2>
Subversion access to <i>padb</i> is hosted by
Modified: trunk/doc/extensions.html
==============================================================================
--- trunk/doc/extensions.html (original)
+++ trunk/doc/extensions.html Mon Jun 8 14:14:56 2009
@@ -3,7 +3,7 @@
requires modifications to the MPI library to function properly.
At this time patches are available for Open MPI svn trunk
only.
-Contant the <a href="mailto:padb-devel at pittman.org.uk">developer mailing
list</a>
+Contact the <a href="mailto:padb-devel at pittman.org.uk">developer mailing
list</a>
for more information.
<p>
Modified: trunk/doc/index.html
==============================================================================
--- trunk/doc/index.html (original)
+++ trunk/doc/index.html Mon Jun 8 14:14:56 2009
@@ -1,13 +1,12 @@
-<head><title>Padb: A parallel debugging tool</title></head>
<h1>Padb: A parallel debugging tool</h1>
<h2>About</h2>
<i>Padb</i> is a <b>Job Inspection Tool</b> for examining and
-debugging parallel programs, primaraly it simplifies the process of
-gathering stack traces but also supports a wide range of other functions.
+debugging parallel programs, primarily it simplifies the process of
+gathering stack traces on compute clusters however it also supports a wide
range of other functions.
<i>Padb</i> supports a wide range of parallel environments and it's
likely it'll work out-of-the-box on your cluster. It's an
-open source, non-interactive, command line, scriptable tool intended
+open source, non-interactive, command line, script-able tool intended
for use by programmers and system administrators alike.
<h2>Features</h2>
@@ -16,8 +15,9 @@
<li>MPI Message queue display</li>
<li>Deadlock detection</li>
<li>Process interrogation</li>
-<li>Signal forwarding</li>
+<li>Signal forwarding/delivery</li>
<li>MPI collective reporting</li>
+<li>Job monitoring</li>
</ul>
<h2>What padb isn't</h2>
@@ -29,17 +29,17 @@
does not launch or wrap your jobs for you, it is not a job harness but
rather attaches to or targets jobs which are already running.
-<h2>Licence</h2>
-<i>padb</i> is licenced under the
+<h2>License</h2>
+<i>padb</i> is licensed under the
<a href=http://www.gnu.org/licenses/lgpl.html>LGPL</a> and as such is
-open-source and free to use.
+open-source and free to use and modify.
<h2>History</h2>
-<i>Padb</i> was origionally concieved by software developers at
+<i>Padb</i> was originally conceived by software developers at
<a href=http://www.quadrics.com/>Quadrics</a> around 2004 to solve the
kind of problems facing them at the time. It's been a part of the
Quadrics software stack for a number of years and has recently been
-made avalaible to a wider audience. It has been commercially supported
+made available to a wider audience. It has been commercially supported
for a number of years and is known to work at a scale of thousands of
processes.
@@ -53,10 +53,11 @@
<li><a href=https://computing.llnl.gov/linux/slurm>Slurm</a></li>
Runs natively on clusters running Slurm irrespective of the runtime used.
<li><a href=http://www.open-mpi.org/>Open MPI</a></li>
-Supports orte or OMPI jobs run under slurm.
+Supports orte or OpenMPI jobs run under slurm.
<li><a href=http://www.mcs.anl.gov/mpi/mpich/>MPICH2</a></li>
Supports mpd or MPICH2 jobs run under slurm.
</ul>
+<p>In addition padb can be told to target individual UNIX processes.
<h2>Prerequisites</h2>
<i>Padb</i> requires very little support from the OS or parallel
Modified: trunk/doc/usage.html
==============================================================================
--- trunk/doc/usage.html (original)
+++ trunk/doc/usage.html Mon Jun 8 14:14:56 2009
@@ -2,55 +2,62 @@
<h2>Selecting the Resource Manager (Job Launcher)</h2>
<i>Padb</i> supports many resource managers and should select
-the appropiate one for your cluster, if you have more than
+the appropriate one for your cluster, if you have more than
one resource manager installed or <i>padb</i> can't detect
-the correct one use <emph>-O rmgr=<rmgs></emph>
+the correct one use the <b>rmgr</b> <a href=#config>configuration
option</a>.
-If no resource manager is found use -Ormgr=local and proccess
-pids will be used instead of job ids.
+<p>If no resource manager is found use <b>-O rmgr=local</b> and process
+identifiers will be used instead of job ids.
+
+<p>The <b>--list-rmgrs</b> option can be used to show a list of detected
+resource managers and their active jobs.
<h2>Selecting the job(s) to target</h2>
<i>Padb</i> provides several ways for the user to select which jobs
-to target depending on requirments. All jobs detected by padb are
-identified by a unique numberic "jobid", typically this maps directly
+to target depending on requirements. All jobs detected by padb are
+identified by a unique numeric "jobid", typically this maps directly
only a identifier provided by the underlying resource manager.
The default is to target jobs of the current user, this can be
-over-ridden with the --user flag.
+over-ridden with the <b>--user</b> flag.
<h3>Showing list of current jobs</h3>
To show a list of currently running jobs for a given user use the
---show-jobs flag.
+<b>--show-jobs</b> flag.
<h3>To target all jobs</h3>
-To target all jobs currently running for a given user use the --all (-a)
flag.
+To target all jobs currently running for a given user use the <b>--all</b>
(<b>-a</b>) flag.
<h3>To target any jobs</h3>
-To target "any" job currently running for a given user use the --any (-A)
flag.
-This differs from targeting all jobs as it will raise an error if more
+To target "any" job currently running for a given user use the
<b>--any</b> (<b>-A</b>) flag.
+This differs from targeting all jobs as it will exit with an error if more
than one job is running.
<h3>To target a specific job</h3>
To target a specific job specify the jobid for the job on the command line,
after all other options.
-
-<h3>To target a specific job (Full report option)</h3>
+<a name=full-report</a><h3>To target a specific job (Full report
option)</h3>
If trying to diagnose a problem or gather information there is another
-option, --full-report=<jobid>, this tells padb to target the job
+option, <b>--full-report=<jobid></b>, this tells padb to target the
job
specified and to report all information about the job it knows how to
collect. This option is typically used when creating bug reports to
-send to third parties or to inspect a job for anomolies.
+send to third parties or to inspect a job for anomalies.
<h2>Example</h2>
To show a stack trace for process ID 10
use <pre>padb -Ormgr=local --stack-trace 10</pre>
+<hr>
+
+
<h1>Selecting ranks (Processes)</h1>
-In modes where data for each rank is reported seperatly it is possible
-to restrict which ranks are queried, this is done via the --rank option.
-Multiple ranks can be selected by specifing --rank multiple times.
+In modes where data for each process is reported separately it is possible
+to restrict which ranks are queried, this is done via the <b>--rank</b>
option.
+Multiple ranks can be selected by specifying <b>--rank</b> multiple times
+or passing a comma separated list.
+<hr>
<h1>Selecting which mode to run in.</h1>
<i>Padb</i> can present an array of different information about your
@@ -60,42 +67,62 @@
<h2>Full Report</h2>
If you are just starting with <i>padb</i> or are creating an error
-report for somebody else then the --full-report option is a good place
+report for somebody else then the <b>--full-report=<jobid></b>
option is a good place
to start, this will complete a full diagnostic report for the job
iterating over the more common padb options. For large jobs this can
generate a lot of output so redirecting to a file is recommended.
<h2>Stack Trace</h2>
-The --stack-trace (-x) option will cause a stack trace to be given for
-each selected rank. The stack trace generated by this call is moderatly
+The <b>--stack-trace</b> (<b>-x</b>) option will cause a stack trace to be
given for
+each selected rank. The stack trace generated by this call is moderately
terse and gives one function call per line. This option is best combined
-with --tree (-t) to condense stack traces into a tree based format.
+with <b>--tree</b> (<b>-t</b>) to condense stack traces into a tree based
format.
<h3>Stack Trace (Longer)</h3>
-Fuller stack traces can be obtained by setting the config options
+Fuller stack traces can be obtained by setting the <a
href=#config>configuration options</a>
stack-shows-params=1 and stack-shows-locals=1. This can help to narrow
down a problem however does not work well with tree based stack traces
-so is recommended to be used with the --rank flag.
+so is recommended to be used with the <b>--rank</b> flag.
<h2>Message Queues</h2>
For MPI programs the MPI Message Queues can be shown on MPI stacks
-which support it, use the --message-queue (-q) option to show the
+which support it, use the <b>--message-queue</b> (<b>-q</b>) option to
show the
message queues.
-<h1>Configuration options</h1>
+<h2>Process info</h2>
+To view information about individual processes in a job use the
+<b>--proc-info</b> option, best combined with
<b>--proc=format=<format></b>,
+for example <b>--proc-format=vp,pid,state,pcpu,vmsize,vmrss</b>
+
+<hr>
+
+<a name=config></a><h1>Configuration options</h1>
<i>padb</i> has a number of extended configuration options for tuning
-it's behaviour, these can be set in a number of ways. All configuration
+it's behavior, these can be set in a number of ways. All configuration
options are key/value pairs.
<ul>
<li>Command line</li>
-Use the command-line option "--config-option <key>=<value>".
--O can be substitued for --config-option.
+Use the command-line option <b>--config-option
<key>=<value></b>.
+<b>-O</b> can be substituted for <b>--config-option</b>.
<li>Environment</li>
-Set the environment variable PADB_<key>=<value>. All
-environment variables are assumed to be in upper case.
+Set the environment variable <b>PADB_<KEY>=<value></b>. All
+environment variables should be specified in upper case.
<li>Config file</li>
-Config is also loaded from /etc/padb.conf and ~/.padbrc. Contact the
-mailing list for help with these files.
+Config is also loaded from <b>/etc/padb.conf</b> and <b>~/.padbrc</b>.
Contact the
+<a href=email.html>mailing lists</a> for help with these files.
</ul>
A list of configuration options along with their current values can be
-obtained with the command "padb -Ohelp"
+obtained by specifying a key of help with or without a value, i.e. <b>padb
-Ohelp</b>
+
+<h2>Example</h2>
+<pre>
+ashley at alpha:~$ padb --show-jobs
+Error, multiple resource managers detected, use -Ormgr=<resource manager>
+orte slurm local-fd local
+ashley at alpha:~$ padb --show-jobs --config-option rmgr=orte
+59315
+ashley at alpha:~$ export PADB_RMGR=orte
+ashley at alpha:~$ padb --show-jobs
+59315
+ashley at alpha:~$
+</pre>
More information about the padb-devel
mailing list