summaryrefslogtreecommitdiffstats
path: root/txr.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2021-04-26 18:33:46 -0700
committerKaz Kylheku <kaz@kylheku.com>2021-04-26 18:33:46 -0700
commit6c8d43bae5a967fc2ffe9fab3f90344b23ce580b (patch)
treecd4f618274d245f8101373aaa609b9ace1226e36 /txr.1
parent572f13d7b95bb265fed622b4e4c9a1ed11eefcc4 (diff)
downloadtxr-6c8d43bae5a967fc2ffe9fab3f90344b23ce580b.tar.gz
txr-6c8d43bae5a967fc2ffe9fab3f90344b23ce580b.tar.bz2
txr-6c8d43bae5a967fc2ffe9fab3f90344b23ce580b.zip
doc: document --free-all
* txr.1: the --free-all command line option appeared in TXR 144 in 2016, but was never documented.
Diffstat (limited to 'txr.1')
-rw-r--r--txr.19
1 files changed, 9 insertions, 0 deletions
diff --git a/txr.1 b/txr.1
index 88663164..b9e54676 100644
--- a/txr.1
+++ b/txr.1
@@ -965,6 +965,15 @@ example, objects which have been reclaimed by the garbage collector
are marked as inaccessible, and marked as uninitialized when they are
allocated again.
+.coIP --free-all
+This option specifies that all memory allocated by \*(TX should be freed upon
+normal termination. This behavior is useful for debugging memory leaks.
+An accurate leak detection tool, such as the one built into Valgrind,
+should report zero leaked or still reachable memory if
+.code --free-all
+has been used and \*(TX has terminated normally.
+that indicates either a leak in \*(TX, a leak or global object retention
+in a platform library, or else a a leak introduced due to misuse of FFI.
.coIP --dv-regex
If this option is used, then regular expressions are all treated using the
derivative-based back-end. The NFA-based regex implementation is disabled.