add off-line tarball extraction utility

This patch contains python script for gdb allows one to extract the source
tarballs from a formaline enabled executable, even if one is unable to runs the
code anymore.

 Usage is:

 gdb -P formaline.py exe/cactus_sim

 which will dump the tarballs in the current directory


git-svn-id: http://svn.cactuscode.org/arrangements/CactusUtils/Formaline/trunk@230 83718e91-0e4f-0410-abf4-91180603181f

1 files changed, 18 insertions, 0 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 8e0e262..68a410c 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -106,6 +106,24 @@
   the executable's source code into the output directory.
 \end{abstract}
 
+\section{Utility Programs provided by Formaline}
+%
+\label{Formaline_utility_programs}
+
+Thorn Formaline provides the following utility programs:
+%
+\begin{itemize}
+  \item {\tt formaline.py}\\
+    A python script for gdb which allows you to recover the source tarballs
+    from the executable even if the executable can no longer be run. It
+    writes the extracted tarballs into the current directory. Use as
+\begin{verbatim}
+  gdb -P formaline.py exe/cactus_sim
+\end{verbatim}
+\end{itemize}
+
+All utility programs are located in src/util.
+
 %% % The following sections are suggestive only.
 %% % Remove them or add your own.
 %%