Documents

Reference Manual

In-development Reference Manual

These are draft manuals closer to the development HEAD. The contents may be changed before the final release.

Link to a specific topic in the manual

If you want to link to a specific part of the online manual, you might want to use the following url instead of the direct reference to the html file---html file name may change if the manual is revised.

 https://practical-scheme.net/gauche/man/?l=en&p=TOPIC 

TOPIC can be a name of a function, a macro, a module, a class, or a title of a chapter or a setction. To refer to the Japanese manual, replace l=en for l=ja.

To link to the draft manual, add v=draft parameter to the query:

https://practical-scheme.net/gauche/man/?l=en&v=draft&p=TOPIC 

Browsing manual in REPL

You can also lookup manual with ,doc or ,info toplevel REPL command:

gosh$ ,doc string-ref
 -- Function: string-ref cstring k :optional fallback
     [R7RS+ base] Returns K-th character of a complete string CSTRING.
     It is an error to pass an incomplete string.

     By default, an error is signaled if ‘k’ is out of range (negative,
     or greater than or equal to the length of CSTRING).  However, if an
     optional argument FALLBACK is given, it is returned in such case.
     This is Gauche's extension.

     If CSTRING is a multibyte string without index attached, this
     procedure takes O(K) time.  *Note String indexing::, for ensuring
     O(1) access.

     K can also be a string cursor (also Gauche's extension).  Cursor
     acccess is O(1). 

Or search the entries with regexp match:

gosh> ,doc #/string-r/
bytrestring-replace      String-notated bytevectors:134
string-range             Range:111
string-ref               String accessors & modifiers:17
string-remove            String library (reduced):51
string-replace           SRFI-13 Other string operations:6
string-replace!          Linear adjustable-length strings:53
                         Simple adjustable-size strings:33
string-replicate         String library (reduced):66
string-reverse           SRFI-13 String reverse & append:6
string-reverse!          SRFI-13 String reverse & append:7 

Documents by topic

Short descriptions on specific topics. Those are in the doc/ directory of the source tree.