From fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 Mon Sep 17 00:00:00 2001
From: Joseph Hunkeler <jhunkeler@gmail.com>
Date: Wed, 8 Jul 2015 20:46:52 -0400
Subject: Initial commit

---
 pkg/language/doc/error.hlp | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 pkg/language/doc/error.hlp

(limited to 'pkg/language/doc/error.hlp')

diff --git a/pkg/language/doc/error.hlp b/pkg/language/doc/error.hlp
new file mode 100644
index 00000000..9a312de1
--- /dev/null
+++ b/pkg/language/doc/error.hlp
@@ -0,0 +1,40 @@
+.help error Feb86 language
+.ih
+NAME
+error -- abort a task
+.ih
+USAGE
+error errcode errmsg
+.ih
+PARAMETERS
+.ls errcode
+An integer code identifying the error (not used at present in the CL since
+error handlers are not supported).
+.le
+.ls errmsg
+A string describing the error.
+.le
+.ih
+DESCRIPTION
+\fIError\fR may be used to force an error exit from a script.
+The error message will be displayed, and control will return to the
+most recent interactive cl.
+.ih
+EXAMPLES
+1. Abort the current task if there is an attempt to compute a negative
+square root.
+
+.nf
+	if (x < 0)
+	    error (1, "sqrt of a negative number (x=" // x // ")")
+	else
+	    y = sqrt (x)
+.fi
+.ih
+BUGS
+There is currently no way to post an error handler to receive control
+if \fIerror\fR is called.
+.ih
+SEE ALSO
+cl, bye, logout
+.endhelp
-- 
cgit 

