diff options
| author | tradke <tradke@b32723a9-ab3a-4a60-88e2-2e5d99d7c17a> | 2006-06-06 17:21:56 +0000 |
|---|---|---|
| committer | tradke <tradke@b32723a9-ab3a-4a60-88e2-2e5d99d7c17a> | 2006-06-06 17:21:56 +0000 |
| commit | d8a0479330384a0359448d00a4a61c7d8414ca68 (patch) | |
| tree | ad1cf4866eacb72a42abcb501630e46f586fa80d | |
| parent | 461ebf3df853b7b2655a182e2718534d1b8fbc09 (diff) | |
Document the IO::recover_and_remove parameter.
git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOUtil/trunk@241 b32723a9-ab3a-4a60-88e2-2e5d99d7c17a
| -rw-r--r-- | doc/documentation.tex | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index b5a049e..7fce076 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -435,6 +435,10 @@ parameters. The most important ones are: is kept and older checkpoints are removed in order to save disk space. Setting {\tt IO::checkpoint\_keep} to a positive value will keep so many evolution checkpoints around. A value of $-1$ will keep all (future) checkpoints. + \item {\tt IO::recover\_and\_remove}\\ + determines whether the checkpoint file that the current simulation has + been successfully recovered from, should also be subject of removal, + according to the setting of {\tt IO::checkpoint\_keep} \item {\tt IO::recover}\\ keyword parameter telling if/how to recover.\\ Choices are {\tt "no"}, {\tt "manual"}, {\tt "auto"}, and {\tt "autoprobe"}. |