Changeset 9823

Timestamp:

Nov 1, 2006, 12:41:11 PM (20 years ago)

Author:

jhoblitt

Message:

add blurb about registering pre-created detrends

File:

• trunk/doc/ipptools/dettool.txt (modified) (2 diffs)

trunk/doc/ipptools/dettool.txt

@@ -335 +335 @@
 iteration:
 
-        dettool -updatedetrun -det_id <det_id> -iter <iter> [-again|-stop]
-
-where "-rerun" causes a new iteration to be started and "-stop" causes all
-iteration to cease (and potentially alerts the human overlords).
+        dettool -updatedetrun -det_id <det_id> -iter <iter> [-again|-state <state>] 
+
+where "-rerun" causes a new iteration to be started and "-state" sets the
+detrun into other of these states: "stop", "run", "reg".  The "stop" states
+causes all iteration to cease (and potentially alerts the human overlords).
 
 In practise, the above three commands ("dettool -residexp", "detool
@@ -352 +353 @@
         dettool -rerun -det_id <det_id> -iter <iter> -accept <exp_tag> -accept <exp_tag> ... -reject <exp_tag> -reject <exp_tag> ...
 
-
+--------------------------------------------------------------------------------
+
+Registering pre-created detrends
+
+    dettool -register_detrend ...
+
+Which creates a new detrend run set to the state of "reg".
+
+    detool -register_detrend_imfile -det_id <det_id> ...
+
+registers a new imfile into the detRun.  Note that this operation is a
+little dangerous as the validity of the det_id run isn't checked.
+
+    detool -updatedetrun -state stop
+
+Sets the dettool run's state to "stop" so that it will become visiable
+to detselect.
+