aboutsummaryrefslogtreecommitdiff
path: root/doc/pies.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/pies.texi')
-rw-r--r--doc/pies.texi20
1 files changed, 18 insertions, 2 deletions
diff --git a/doc/pies.texi b/doc/pies.texi
index 3f9ec4b..e1ca650 100644
--- a/doc/pies.texi
+++ b/doc/pies.texi
@@ -831,16 +831,32 @@ The following macro-variables are expanded within @var{string}:
@item package @tab Package name (@samp{Pies}).
@item version @tab Package version (@value{VERSION}).
@item component @tab Name of the terminated component.
-@item retcode @tab Component exit code, in decimal.
+@item termination @tab Termination cause (see below).
+@item retcode @tab Component exit code (or signal number, if exited
+on signal), in decimal.
@end multitable
+The @samp{termination} variable is set so as to facilitate its use
+with the @samp{retcode} variable. Namely, its value is @samp{exited
+with}, if the component exited and @samp{terminated on signal}, if
+the component terminated on a signal. Thus, using
+
+@smallexample
+$@{termination@} $@{retcode@}
+@end smallexample
+
+@noindent
+results in a correct English sentence. This message, however, cannot
+be properly internationalized. This will be fixed in the future
+versions.
+
If @code{message} statement is not given, the following default
message is used instead:
@smallexample
From: <>
X-Agent: $@{canonical-program-name@} ($@{package@} $@{version@})
-Subject: Component $@{component@} terminated with code $@{retcode@}.
+Subject: Component $@{component@} $@{termination@} $@{retcode@}.
@end smallexample
@end deffn

Return to:

Send suggestions and report system problems to the System administrator.