Added some more utility programs. See the ThornGuide for details.

git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGHIO/IOFlexIO/trunk@223 ebee0441-1374-4afa-a3b5-247f3ba15b9a

1 files changed, 25 insertions, 3 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 5dc5a70..defad82 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -31,7 +31,7 @@ Such datafiles can be used for further postprocessing (eg. visualization)
 or fed back into Cactus via the filereader capabilities of thorn IOUtil.\\[3ex]
 
 
-{\bf Parallel File I/O}\\
+\subsection{Parallel File I/O}
 
 According to the ouptput mode parameter settings ({\tt IO::out3D\_mode,
 IO::out3D\_unchunked, IO::out3D\_procs}) of thorn IOUtil, thorn IOFlexIO
@@ -95,7 +95,7 @@ the current working directory:
 \vspace*{3ex}
 
 
-{\bf Checkpointing \& Recovery}\\
+\subsection{Checkpointing \& Recovery}
 
 Thorn IOFlexIO can also be used for creating IEEEIO checkpoint files and
 recovering from such files later on.\\
@@ -115,7 +115,7 @@ to this thorn's documentation).
 
 \section{Comments}
 
-{\bf Importing external data into Cactus with IOFlexIO}\\
+\subsection{Importing external data into Cactus with IOFlexIO}
 
 In order to import external data into Cactus (eg. to initialize some variable)
 you first need to convert this data into an IEEEIO datafile which then can be
@@ -172,6 +172,28 @@ Since the single dataset in it only contains zeros
 it would probably not make much sense to feed this datafile into Cactus for
 initializing your x coordinate grid function :-)
 %
+%
+\subsection{Other utility programs in IOFlexIO}
+%
+In addition to the IEEEIO recombiner program, thorn IOFlexIO also provides
+some other utilities which can be build the same way:
+%
+\begin{itemize}
+  \item {\tt ieee\_merge.c}\\
+    Merges the contents of its input files into a single output file.\\
+    This might be useful for IOFlexIO datafile created by different runs.
+  \item {\tt ieee\_extract.c}\\
+    Extracts a hyperslab from all datasets of the input file.\\
+    You can select a hyperslab by specifying an origin and an extent (eg.
+    128x128x128+32+32+32 selects a 128-cubed hyperslab with origin (32, 32, 32)).
+  \item {\tt ieee\_convert\_from\_cactus3.c}\\
+    Converts Cactus 3 IEEEIO datafiles into Cactus 4.\\
+    It also takes a textfile as input with mapping information for variable
+    names.
+\end{itemize}
+%
+If any of these utility programs is called without arguments it will print
+a usage message.
 % Automatically created from the ccl files
 % Do not worry for now.
 \include{interface}