aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/documentation.tex')
-rw-r--r--doc/documentation.tex18
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.
%%