summaryrefslogtreecommitdiffstats
path: root/top-refs.txi
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2017-02-20 00:05:31 -0800
committerBryan Newbold <bnewbold@robocracy.org>2017-02-20 00:05:31 -0800
commit5145dd3aa0c02c9fc496d1432fc4410674206e1d (patch)
tree540afc30c51da085f5bd8ec3f4c89f6496e7900d /top-refs.txi
parent8466d8cfa486fb30d1755c4261b781135083787b (diff)
downloadslib-5145dd3aa0c02c9fc496d1432fc4410674206e1d.tar.gz
slib-5145dd3aa0c02c9fc496d1432fc4410674206e1d.zip
Import Upstream version 3a2upstream/3a2
Diffstat (limited to 'top-refs.txi')
-rw-r--r--top-refs.txi5
1 files changed, 4 insertions, 1 deletions
diff --git a/top-refs.txi b/top-refs.txi
index 11944bb..dd231c8 100644
--- a/top-refs.txi
+++ b/top-refs.txi
@@ -18,6 +18,7 @@ Returns a list of the top-level variables referenced by the Scheme
expression @var{obj}.
@end defun
+
@defun top-refs<-file filename
@var{filename} should be a string naming an existing file containing Scheme
@@ -33,6 +34,7 @@ constant or composed of combinations of vicinity functions and
string literal constants; and the resulting file exists (possibly
with ".scm" appended).
@end defun
+
@noindent
The following function parses an @dfn{Info} Index.
@cindex Info
@@ -54,7 +56,7 @@ info -f slib2d6.info -n "Index" -o slib-index.info
@dots{} (info) indexes of @var{file}. The identifiers have the case that
the implementation's @code{read} uses for symbols. Identifiers
containing spaces (eg. @code{close-base on base-table}) are
-@emph{not} included.
+@emph{not} included. #f is returned if the index is not found.
Each info index is headed by a @samp{* Menu:} line. To list the
symbols in the first and third info indexes do:
@@ -63,3 +65,4 @@ symbols in the first and third info indexes do:
(exports<-info-index "slib.info" 1 3)
@end example
@end defun
+