aboutsummaryrefslogtreecommitdiff
path: root/pkg/language/doc/keep.hlp
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
commitfa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch)
treebdda434976bc09c864f2e4fa6f16ba1952b1e555 /pkg/language/doc/keep.hlp
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'pkg/language/doc/keep.hlp')
-rw-r--r--pkg/language/doc/keep.hlp32
1 files changed, 32 insertions, 0 deletions
diff --git a/pkg/language/doc/keep.hlp b/pkg/language/doc/keep.hlp
new file mode 100644
index 00000000..11935af0
--- /dev/null
+++ b/pkg/language/doc/keep.hlp
@@ -0,0 +1,32 @@
+.help keep Feb86 language
+.ih
+NAME
+keep -- keep memory after task termination
+.ih
+USAGE
+keep
+.ih
+DESCRIPTION
+Normally when a script task terminates any tasks, packages, environment
+variables, etc. defined during the execution of that task are discarded
+(in other words, the memory used by the task is freed).
+The \fIkeep\fR command instructs the CL to retain the definitions after
+script termination. Only one level of "keep" is achieved, e.g.,
+if a script with a keep is called from a higher level script, then when
+the higher level script terminates the task definitions will still be lost
+(unless this higher level script also uses \fIkeep\fR).
+.ih
+EXAMPLE
+1. The most common use for \fIkeep\fR is to retain a set of definitions
+in a script task.
+
+.nf
+ set pkdir = "home$hebrew/"
+ task aleph, beth, kaph = hebrew.cl
+
+ keep
+.fi
+.ih
+SEE ALSO
+task, package
+.endhelp