1.2 Notations

In this manual, each entry is represented like this:

Category: foo arg1 arg2

[spec] Description of foo ...

Category denotes the category of the entry foo. The following category will appear in this manual:

Function	A Scheme function.
Special Form	A special form (in the R5RS term, "syntax").
Macro	A macro.
Module	A module
Class	A class.
Generic Function	A generic function
Method	A method
Reader Syntax	A lexical syntax that is interpreted by the reader.

For functions, special forms and macros, the entry may followed by one or more arguments. In the argument list, the following notations may appear:

arg ...

Indicates zero or more arguments.

&optional x y z

&optional (x x-default) (y y-default) z

Indicates it may take up to three optional arguments. The second form specifies default values. Note that Gauche doesn't really support Common-Lisp style &optional argument specifier in the lambda list. I use this notation since it is useful to indicate valid pattern of arguments.

&keyword x y z

&keyword (x x-default) (y y-default) z

Indicates it may take keyword arguments x, y and z. Note that Gauche doesn't really support Common-Lisp style &keyword argument specifier in the lambda list. I use this notation since it is useful to indicate valid pattern of arguments.

&rest args

Indicates it may take rest arguements. Note that Gauche doesn't really support Common-Lisp style &rest argument specifier in the lambda list. I use this notation since it is useful to indicate valid pattern of arguments.

The description of the entry follows the entry line. If the specification of the entry comes from some standard or implementation, its origin is noted in the bracket at the beginning of the description. The following origins are noted:

[R5RS]

[R5RS+]

The entry works as specified in "Revised^5 Report of Algorithmic Language Scheme.". If it is marked as "[R5RS+]", the entry has additional functionality.

[SRFI-n]

[SRFI-n+]

The entry works as specified in SRFI-n. If it is marked as "[SRFI-n+]", the entry has additional functionality.

[POSIX]

The API of the entry reflects the API specified in POSIX.