remove eval-options
[bpt/guile.git] / doc / ref / api-options.texi
index c6ce346..d2710bb 100644 (file)
@@ -1,10 +1,9 @@
 @c -*-texinfo-*-
 @c This is part of the GNU Guile Reference Manual.
-@c Copyright (C)  1996, 1997, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2008
+@c Copyright (C)  1996, 1997, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010
 @c   Free Software Foundation, Inc.
 @c See the file guile.texi for copying conditions.
 
-@page
 @node Options and Config
 @section Configuration, Features and Runtime Options
 
@@ -82,10 +81,11 @@ general are stored.  On Unix-like systems, this is usually
 @deffnx {C Function} scm_sys_library_dir ()
 Return the name of the directory where the Guile Scheme files that
 belong to the core Guile installation (as opposed to files from a 3rd
-party package) are installed.  On Unix-like systems, this is usually
+party package) are installed.  On Unix-like systems this is usually
 @file{/usr/local/share/guile/<GUILE_EFFECTIVE_VERSION>} or
-@file{/usr/share/guile/<GUILE_EFFECTIVE_VERSION>}, for example:
-@file{/usr/local/share/guile/1.6}.
+@file{/usr/share/guile/<GUILE_EFFECTIVE_VERSION>};
+
+@noindent for example @file{/usr/local/share/guile/1.6}.
 @end deffn
 
 @deffn {Scheme Procedure} %site-dir
@@ -99,7 +99,7 @@ your site should be installed.  On Unix-like systems, this is usually
 @defvar %load-path
 List of directories which should be searched for Scheme modules and
 libraries.  @code{%load-path} is initialized when Guile starts up to
-@code{(list (%site-dir) (%library-dir) (%package-data-dir) ".")},
+@code{(list (%site-dir) (%library-dir) (%package-data-dir))},
 prepended with the contents of the GUILE_LOAD_PATH environment variable,
 if it is set.
 @end defvar
@@ -112,15 +112,21 @@ string, into a list and return the resulting list with
 is returned.
 @end deffn
 
-@deffn {Scheme Procedure} search-path path filename [extensions]
-@deffnx {C Function} scm_search_path (path, filename, extensions)
+@deffn {Scheme Procedure} search-path path filename [extensions [require-exts?]]
+@deffnx {C Function} scm_search_path (path, filename, rest)
 Search @var{path} for a directory containing a file named
 @var{filename}. The file must be readable, and not a directory.
 If we find one, return its full filename; otherwise, return
 @code{#f}.  If @var{filename} is absolute, return it unchanged.
 If given, @var{extensions} is a list of strings; for each
 directory in @var{path}, we search for @var{filename}
-concatenated with each @var{extension}.
+concatenated with each @var{extension}.  If @var{require-exts?}
+is true, require that the returned file name have one of the
+given extensions; if @var{require-exts?} is not given, it
+defaults to @code{#f}.
+
+For compatibility with Guile 1.8 and earlier, the C function takes only
+three arguments
 @end deffn
 
 @defvar %guile-build-info
@@ -170,13 +176,21 @@ by @code{(version)}.  The value for @code{libguileinterface} is
 libtool compatible and has form CURRENT:REVISION:AGE
 (@pxref{Versioning,, Library interface versions, libtool, GNU
 Libtool}).  The value for @code{buildstamp} is the output of the
-date(1) command.
+command @samp{date -u +'%Y-%m-%d %T'} (UTC).
 
 In the source, @code{%guile-build-info} is initialized from
 libguile/libpath.h, which is completely generated, so deleting this file
 before a build guarantees up-to-date values for that build.
 @end defvar
 
+@cindex GNU triplet
+@cindex canonical host type
+
+@defvar %host-type
+The canonical host type (GNU triplet) of the host Guile was configured
+for, e.g., @code{"x86_64-unknown-linux-gnu"} (@pxref{Canonicalizing,,,
+autoconf, The GNU Autoconf Manual}).
+@end defvar
 
 @node Feature Tracking
 @subsection Feature Tracking
@@ -378,7 +392,6 @@ configure @emph{reading}, @emph{printing}, @emph{debugging} or
 * Reader options::
 * Printing options::
 * Debugger options::
-* Evaluator options::
 * Evaluator trap options::
 * Examples of option use::
 @end menu
@@ -388,7 +401,6 @@ configure @emph{reading}, @emph{printing}, @emph{debugging} or
 @subsubsection Low Level Options Interfaces
 
 @deffn {Scheme Procedure} read-options-interface [setting]
-@deffnx {Scheme Procedure} eval-options-interface [setting]
 @deffnx {Scheme Procedure} print-options-interface [setting]
 @deffnx {Scheme Procedure} debug-options-interface [setting]
 @deffnx {Scheme Procedure} evaluator-traps-interface [setting]
@@ -495,6 +507,7 @@ keywords         #f      Style of keyword recognition: #f, 'prefix or 'postfix
 case-insensitive no      Convert symbols to lower case.
 positions        yes     Record positions of source code expressions.
 copy             no      Copy source code expressions.
+r6rs-hex-escapes no      Use R6RS-style string hex escapes
 @end smalllisp
 
 Notice that while Standard Scheme is case insensitive, to ease
@@ -503,9 +516,12 @@ Guile is case-sensitive by default.
 
 To make Guile case insensitive, you can type
 
-@smalllisp
+@lisp
 (read-enable 'case-insensitive)
-@end smalllisp
+@end lisp
+
+For more information on the effect of the @code{r6rs-hex-escapes} option, see
+(@pxref{String Syntax}).
 
 @node Printing options
 @subsubsection Printing options
@@ -530,17 +546,6 @@ closure-hook             #f     Hook for printing closures.
 @end smallexample
 
 
-@node Evaluator options
-@subsubsection Evaluator options
-
-These are the evaluator options with their default values, as they are
-printed by typing @code{(eval-options 'full)} in Guile.
-
-@smallexample
-stack           22000   Size of thread stacks (in machine words).
-@end smallexample
-
-
 @node Evaluator trap options
 @subsubsection Evaluator trap options
 [FIXME: These flags, together with their corresponding handlers, are not
@@ -680,7 +685,8 @@ the maximum stack size, use @code{debug-set!}, for example:
 @lisp
 (debug-set! stack 200000)
 @result{}
-(show-file-name #t stack 200000 debug backtrace depth 20 maxdepth 1000 frames 3 indent 10 width 79 procnames cheap)
+(show-file-name #t stack 200000 debug backtrace depth 20
+   maxdepth 1000 frames 3 indent 10 width 79 procnames cheap)
 
 (non-tail-recursive-factorial 500)
 @result{}
@@ -717,7 +723,6 @@ backtrace.  Need to give a better example, possibly putting debugging
 option examples in a separate session.]
 @end enumerate
 
-
 @smalllisp
 guile> (define abc "hello")
 guile> abc