doc/flux-start.1: document --scratchdir option

flux-framework · Feb 25, 2017 · 950f011 · 950f011
1 parent a22608d
commit 950f011
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/man1/flux-start.adoc b/doc/man1/flux-start.adoc
@@ -58,6 +58,14 @@ configuration profile named 'PROFILE'. Requires a version of Flux
 built with --enable-caliper. Unless CALI_LOG_VERBOSITY is already
 set in the environment, it will default to 0 for all brokers.
 
+*--scratchdir*='DIR'::
+For selfpmi bootstrap mode, set a pre-existing directory that will
+contain the generated broker.rundir directories for the instance.
+If a DIR is not set with this option, a unique temporary directory will
+be created for the lifetime of the instance and removed when the
+instance is destroyed.
+
+
 EXAMPLES
 --------