doc: Add introduction and supported platforms.
[guile-r6rs-libs.git] / doc / guile-r6rs-libs.texi
blobf58d1f798067a0857a383ebf2d016d957a60db2d
1 \input texinfo  @c -*-texinfo-*-
3 @c Copyright (C) 2009 Ludovic Courtès <ludo@gnu.org>
4 @c
5 @c Permission is granted to copy, distribute and/or modify this document
6 @c under the terms of the GNU Free Documentation License, Version 1.2
7 @c or any later version published by the Free Software Foundation;
8 @c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
9 @c Texts.  A copy of the license is included in the section entitled ``GNU
10 @c Free Documentation License''.
12 @c %**start of header
13 @setfilename guile-r6rs-libs.info
14 @settitle R6RS Libraries for GNU Guile
15 @footnotestyle end
16 @setchapternewpage odd
17 @c %**end of header
19 @set EDITION 1
20 @include version.texi
22 @copying
23 This file documents Guile-R6rs-Libs @value{VERSION}.
25 Copyright @copyright{} 2009 Ludovic Court@`es
27 @quotation
28 Permission is granted to copy, distribute and/or modify this document
29 under the terms of the GNU Free Documentation License, Version 1.2
30 or any later version published by the Free Software Foundation;
31 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
32 Texts.  A copy of the license is included in the section entitled ``GNU
33 Free Documentation License''.
34 @end quotation
35 @end copying
37 @dircategory The Algorithmic Language Scheme
38 @direntry
39 * Guile-R6RS-Libs: (guile-r6rs-libs).      R6RS Libraries for GNU Guile.
40 @end direntry
43 @titlepage
44 @title R6RS Libraries for GNU Guile
45 @subtitle for GNU Guile-R6rs-Libs @value{VERSION}
46 @author Ludovic Court@`es
48 @page
49 @vskip 0pt plus 1filll
50 Edition @value{EDITION} @*
51 @c Updated for Guile-R6rs-Libs @value{VERSION} @*
52 @value{UPDATED} @*
54 Copyright @copyright{} 2009 Ludovic Court@`es
56 Permission is granted to copy, distribute and/or modify this document
57 under the terms of the GNU Free Documentation License, Version 1.2
58 or any later version published by the Free Software Foundation;
59 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
60 Texts.  A copy of the license is included in the section entitled ``GNU
61 Free Documentation License''.
63 @end titlepage
65 @contents
67 @c *********************************************************************
68 @node Top
69 @top R6RS Libraries for GNU Guile
71 This document describes Guile-R6RS-Libs version @value{VERSION}, a set
72 of @url{http://www.r6rs.org/, R6RS} libraries for GNU Guile 1.8.x and
73 later.  It was last updated in @value{UPDATED-MONTH}.
75 @menu
76 * Introduction::                
77 * API Reference::               
79 * Concept Index::               
80 * Function Index::              
81 * GNU Free Documentation License::  
82 @end menu
84 @c *********************************************************************
85 @node Introduction
86 @chapter Introduction
88 Guile-R6RS-Libs provides a subset of the
89 @url{http://www.r6rs.org/final/html/r6rs-lib/r6rs-lib.html, R6RS
90 Standard Libraries} for GNU Guile 1.8 and later.  It currently focuses
91 on the bytevector API and binary I/O primitives, along with a few other
92 I/O facilities.
94 Guile-R6RS-Libs @value{VERSION} was successfully tested on the following
95 platforms:
97 @c XXX: Update for each release.
98 @itemize
99 @item @code{i386-unknown-gnu0.3} with GCC 4.3.3;
100 @item @code{i686-pc-linux-gnu} with GCC 4.2.4;
101 @item @code{x86_64-unknown-linux-gnu} with GCC 4.3.3;
102 @item @code{x86_64-unknown-linux-gnu} with a 2009-02-24 snapshot of the
103 forthcoming GCC 4.4;
104 @item @code{sparc64-unknown-linux-gnu} with GCC 4.3.1;
105 @item @code{alphaev56-unknown-linux-gnu} with GCC 4.2.4;
106 @item @code{powerpc64-unknown-linux-gnu} with GCC 4.1.2;
107 @item @code{ia64-unknown-linux-gnu} with GCC 4.3.2;
108 @item @code{hppa2.0-unknown-linux-gnu} with GCC 4.3.2;
109 @item @code{armv5tel-unknown-linux-gnueabi} with GCC 4.1.2.
110 @end itemize
113 @c *********************************************************************
114 @node API Reference
115 @chapter API Reference
117 @include api-r6rs.texi
119 @c *********************************************************************
120 @node Concept Index
121 @unnumbered Concept Index
122 @printindex cp
124 @node Function Index
125 @unnumbered Function Index
126 @printindex fn
128 @c *********************************************************************
129 @node GNU Free Documentation License
130 @appendix GNU Free Documentation License
132 @include fdl-1.2.texi
135 @bye
137 @c Local Variables:
138 @c ispell-local-dictionary: "american"
139 @c End: