From 84352bae86df16766fdb4f92fecd72ab6cd3b6c3 Mon Sep 17 00:00:00 2001 From: Ferry Boender Date: Mon, 27 Jul 2015 14:14:11 +0200 Subject: [PATCH] Documented exit code handling in `raw` output mode. --- doc/MANUAL.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/MANUAL.md b/doc/MANUAL.md index a286cfb..7762fb8 100644 --- a/doc/MANUAL.md +++ b/doc/MANUAL.md @@ -1035,8 +1035,12 @@ The following output types are supported: ### Exit codes -If the script's exit code is 0, the output of the script (stdout) is captured -and shown to the user in the browser. +Exit codes are handled by Scriptform if the output type is not `raw`. Otherwise +it is the script's responsibility to properly handle exit codes of subscripts +and showing errors. + +If the output type is `escaped` or `html` and the script's exit code is 0, the +output of the script (stdout) is captured and shown to the user in the browser. If a script's exit code is not 0, it is assumed an error occured. Scriptform will show the script's stderr output (in red) to the user instead of stdin.