bt_common_abort(): optionally execute a custom command before aborting

[babeltrace.git] / doc / man / common-common-env.txt

diff --git a/doc/man/common-common-env.txt b/doc/man/common-common-env.txt
index 099635b7e2351cd4fcb892c3eb9719c8a5168ba6..fe1c2aa0ec8e4a1d67a818cfae791f6c54940e93 100644 (file)
--- a/doc/man/common-common-env.txt
+++ b/doc/man/common-common-env.txt
@@ -1,3 +1,13 @@
+`BABELTRACE_EXEC_ON_ABORT`='CMDLINE'::
+    Execute the command line 'CMDLINE', as parsed like a UNIX~98 shell,
+    when any part of the Babeltrace~2 project unexpectedly aborts.
++
+The application only aborts when the executed command returns, ignoring
+its exit status.
++
+This environment variable is ignored when the application has the
+`setuid` or the `setgid` access right flag set.
+

 `BABELTRACE_TERM_COLOR`=(`AUTO` | `NEVER` | `ALWAYS`)::
     Force the terminal color support for the man:babeltrace2(1) program
     and the project's plugins.
 `BABELTRACE_TERM_COLOR`=(`AUTO` | `NEVER` | `ALWAYS`)::
     Force the terminal color support for the man:babeltrace2(1) program
     and the project's plugins.