aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/documentation.tex')
-rw-r--r--doc/documentation.tex14
1 files changed, 5 insertions, 9 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index d27de47..1decb0d 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -29,9 +29,8 @@
% START CACTUS THORNGUIDE
\begin{abstract}
-Thorn \textbf{ManualTermination} safely terminates Cactus
-simulation jobs, and can be configured to allow other users to
-terminate the job.
+Thorn \textbf{ManualTermination} safely terminates Cactus simulation jobs,
+and can be configured to allow other users to terminate the job.
The thorn can also be configured to terminate a certain number of minutes
before a given maximum walltime has elapsed. Also, it can be configured
@@ -41,8 +40,6 @@ on the contents of that file.
In either case, the job should be checkpointed.
\end{abstract}
-
-
\section{Requirements}
The program must be set up for checkpointing. (It can be argued that
@@ -84,8 +81,8 @@ The two modes, termination by wall time and termination from file, are
meant to be independent and can be used together or separately.
The default file checked is on the root node (the node of MPI rank 0)
-\texttt{/tmp//cactus\_terminate.\textit{job\_id}},
-where by default, \texttt{\textit{job\_id}} is gotten from the \texttt{PBS\_JOBID}
+\texttt{/tmp//cactus\_terminate.\textit{job\_id}}, where by default,
+\texttt{\textit{job\_id}} is gotten from the \texttt{PBS\_JOBID}
environment variable. If the environment variable
\texttt{MANUAL\_TERMINATION\_JOB\_ID} is set, that will be used instead
as the \texttt{\textit{job\_id}}.
@@ -102,8 +99,7 @@ It should be possible to use thorn \textbf{ManualTermination} with thorn
\section{Licensing and Support}
Thorn \textbf{ManualTermination} is distributed under the GNU Lesser Public
-License.
-For details please see the file \texttt{README} in the top-level
+License. For details please see the file \texttt{README} in the top-level
directory of this thorn.
Please send any suggestions or comments to the maintainer of the thorn.