[Swift-commit] r6382 - trunk/docs/userguide

[wozniak at ci.uchicago.edu]

Author: wozniak
Date: 2013-03-14 16:23:48 -0500 (Thu, 14 Mar 2013)
New Revision: 6382

Modified:
   trunk/docs/userguide/commands
Log:
Document SWIFT_HEAP_MAX


Modified: trunk/docs/userguide/commands
===================================================================
--- trunk/docs/userguide/commands	2013-03-14 14:53:10 UTC (rev 6381)
+++ trunk/docs/userguide/commands	2013-03-14 21:23:48 UTC (rev 6382)
@@ -80,28 +80,28 @@
 
 -recompile
 
-      Forces Swift to re-compile the invoked Swift script. While Swift 
-      is meant to detect when recompilation is necessary, in some 
-      special cases it fails to do so. This flag helps with those 
+      Forces Swift to re-compile the invoked Swift script. While Swift
+      is meant to detect when recompilation is necessary, in some
+      special cases it fails to do so. This flag helps with those
       special cases.
 
 -cdm.file
-     
+
      Specifies a CDM policy file.
 
 -reduced.logging
 
-      Makes logging more terse by disabling provenance information and 
+      Makes logging more terse by disabling provenance information and
       low-level task messages
 
 -minimal.logging
 
-      Makes logging much more terse: reports warnings only 
+      Makes logging much more terse: reports warnings only
 
 -tui
 
     Displays an interactive text mode monitor during a run. (since Swift
-    0.9) 
+    0.9)
 
 In addition, the following Swift properties can be set on the command line:
 
@@ -142,12 +142,18 @@
 
 The swift is influenced by the following environment variables:
 
-GLOBUS_HOSTNAME, GLOBUS_TCP_PORT_RANGE 
+GLOBUS_HOSTNAME, GLOBUS_TCP_PORT_RANGE
 
     Set in the environment before running Swift. These can be set to inform Swift
     of the configuration of your local firewall. More information can be found in
     the Globus firewall How-to <http://dev.globus.org/wiki/FirewallHowTo>.
 
+SWIFT_HEAP_MAX
+
+    Sets the java heap size.  Use this if Swift runs out of memory.
+    Uses the format set by java -Xmx, which is how this is implemented.
+    The default setting is 1024M.
+
 COG_OPTS
 
     Set in the environment before running Swift. Options set in
@@ -155,7 +161,7 @@
     which will run Swift. The parameters vary between virtual machine
     imlementations, but can usually be used to alter settings such as
     maximum heap size. Typing 'java -help' will sometimes give a list of
-    commands. 
+    commands.
 
 
 swift-osg-ress-site-catalog