Adding copying of parameter files

git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOUtil/trunk@142 b32723a9-ab3a-4a60-88e2-2e5d99d7c17a

1 files changed, 29 insertions, 0 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 8a7cb24..fbad3c8 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -136,6 +136,35 @@ which can direct their output to a different directory.
   to override this. The default is to never write output.
 \end{itemize}
 
+\section{Manipulating Parameter Files}
+
+Thorn {\tt CactusBase/IOUtil} can also manage and manipulate parameter 
+files, using the parameter {\tt IO::parfile\_write} to 
+
+\begin{itemize}
+
+  \item{\tt IO::parfile\_write="copy"} This is the default option,
+  and makes an exact replica of the input parameter file in the
+  standard output directory (this is particularly useful when the
+  output directory is going to be archived).
+
+  \item{\tt IO::parfile\_write="generate"} Generate a new parameter
+  file from runtime information, containing the Cactus version, the
+  name of the original parameter file, the run time/date, the host to
+  run on, and the number of processors - all on comment
+  lines. Following this the parameter file contains the ActiveThorns
+  list plus a sorted list of all active thorns' parameters which have
+  been set in the original parameter file.
+
+  \item{\tt IO::parfile\_write="no"} Switch off writing of a new 
+	parameter file.
+
+\end{itemize}
+
+The name of the new parameter file defaults to the original filename, 
+unless the parameter {\tt IO::parfile\_name} is set. Note that if a file
+already exists with the chosen name it will not be overwritten.
+  
 
 \section{I/O modes}
 \label{iomodes}