* Initial form of documentation.

2016-09-09 16:50:40 -04:00
parent 04515dcd35
commit acfb11e010
1 changed files with 29 additions and 0 deletions
--- a/doc/SGE-tools.txt
+++ b/doc/SGE-tools.txt
@@ -0,0 +1,29 @@
+
+Various SGE utilities
+=====================
+
+
+find-run-hosts.sh
+-----------------
+
+This tool returns information about execution hosts and processes
+related to a given job.
+
+Usage:
+
+`find-run-hosts.sh <JOBID>`::
+Lists the hosts where this job is executing, which also shows how many
+cores are allocated on each node for this job.
+
+`find-run-hosts.sh process <JOBID>`::
+Dumps the processes on the executing nodes of this job
+(in `ps --forest` format).
+
+`find-run-hosts.sh master-node <JOBID>`::
+Finds out the master node of this job.
+
+`find-run-hosts.sh list-nodes <JOBID>`::
+LIsts all the nodes allocated for this job.
+
+
+