aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/documentation.tex33
1 files changed, 32 insertions, 1 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index f85cdc6..5dc5a70 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -61,7 +61,38 @@ To build the recombiner just do a
in the Cactus toplevel directory. The recombiner executable {\tt
ieee\_recombiner} will be placed in the {\tt exe/<configuration>/}
-subdirectory.\\[3ex]
+subdirectory.\\
+Its usage is:
+\begin{verbatim}
+~/Cactus/exe/wave> ieee_recombiner
+
+-------------------------------
+Cactus 4 IEEEIO File Recombiner
+-------------------------------
+
+Usage: recombiner <chunked_infile0> <unchunked_outfile>
+ eg, recombiner alp_3d.file_0.ieee alp_3d.ieee
+
+\end{verbatim}
+
+If you have a lot of different variables to recombine you can use the following
+Bourne shell commands to recombine them.
+This assumes that the chunked output files for each variable are located in a
+subdirectory {\tt <varname>\_3d/}.
+The recombined output file {\tt <varname>\_3d.ieee} would then be placed into
+the current working directory:
+
+\begin{verbatim}
+ for var in *_3d ; \
+ do \
+ { \
+ if [ ! -r $var.ieee ] ; then \
+ ieee_recombiner $var/$var.file_0.ieee $var.ieee; \
+ fi; \
+ }; \
+ done
+\end{verbatim}
+\vspace*{3ex}
{\bf Checkpointing \& Recovery}\\