1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-21 12:10:26 +02:00

(Manual Layout): Wrap POSIX, API, and SLIB in @acronym. Change from

paragraph format (somewhat clumsy-looking on paper, at least) to
@table format, with headers @strong.  Made example modules complete
sentences.  From Stephen Compall, thanks!
This commit is contained in:
Marius Vollmer 2003-11-13 20:46:48 +00:00
parent 5df36eac84
commit 96e0538252

View file

@ -34,23 +34,25 @@ the file @file{COPYING.LIB}.
The manual is divided into five parts. The manual is divided into five parts.
@strong{Part I: Introduction to Guile} provides an overview of what @table @strong
Guile is and how you can use it. A whirlwind tour shows how Guile can @item Part I: Introduction to Guile
be used interactively and as a script interpreter, how to link Guile Provides an overview of what Guile is and how you can use it. A
into your own applications, and how to write modules of interpreted and whirlwind tour shows how Guile can be used interactively and as a
compiled code for use with Guile. Everything introduced here is script interpreter, how to link Guile into your own applications, and
documented again and in full by the later parts of the manual. This how to write modules of interpreted and compiled code for use with
part also explains how to obtain and install new versions of Guile, and Guile. Everything introduced here is documented again and in full by
how to report bugs effectively. the later parts of the manual. This part also explains how to obtain
and install new versions of Guile, and how to report bugs effectively.
@strong{Part II: Writing and Running Guile Scheme} and @strong{Part III: @item Part II: Writing and Running Guile Scheme
Programming with Guile} document all aspects of practical programming @itemx Part III: Programming with Guile
using Guile. This covers both the Scheme level --- where we provide an Document all aspects of practical programming using Guile. This
introduction to the key ideas of the Scheme language --- and use of covers both the Scheme level --- where we provide an introduction to
Guile's @code{scm} interface to write new primitives and objects in C, the key ideas of the Scheme language --- and use of Guile's @code{scm}
and to incorporate Guile into a C application. It also covers the use interface to write new primitives and objects in C, and to incorporate
of Guile as a POSIX-compliant script interpreter and how to use the Guile into a C application. It also covers the use of Guile as a
Guile debugger. @acronym{POSIX}-compliant script interpreter and how to use the Guile
debugger.
@c @strong{Part V: Extending Applications Using Guile} explains the options @c @strong{Part V: Extending Applications Using Guile} explains the options
@c available for using Guile as a application extension language. At the @c available for using Guile as a application extension language. At the
@ -65,11 +67,12 @@ Guile debugger.
@c This part of the manual covers the complete range of application @c This part of the manual covers the complete range of application
@c extension options. @c extension options.
@strong{Part IV: Guile API Reference} documents Guile's core API. Most @item Part IV: Guile API Reference
of the variables and procedures in Guile's core programming interface Documents Guile's core @acronym{API}. Most of the variables and
are available in both Scheme and C and are related systematically such procedures in Guile's core programming interface are available in both
that the C interface can be inferred from the Scheme interface and vice Scheme and C and are related systematically such that the C interface
versa. Therefore, this part of the manual documents the Guile API in can be inferred from the Scheme interface and vice versa. Therefore,
this part of the manual documents the Guile @acronym{API} in
functionality-based groups with the Scheme and C interfaces presented functionality-based groups with the Scheme and C interfaces presented
side by side. Where the Scheme and C interfaces for a particular side by side. Where the Scheme and C interfaces for a particular
functional area do differ --- which is sometimes inevitable, given the functional area do differ --- which is sometimes inevitable, given the
@ -86,20 +89,22 @@ together.
@c all documented from scratch, and organized by functionality rather than @c all documented from scratch, and organized by functionality rather than
@c by the defining standards. @c by the defining standards.
@strong{Part V: Guile Modules} describes some important modules, @item Part V: Guile Modules
distributed as part of the Guile distribution, that extend the Describes some important modules, distributed as part of the Guile
functionality provided by the Guile Scheme core. Two important examples distribution, that extend the functionality provided by the Guile
are: Scheme core. Two important examples are:
@itemize @bullet @itemize @bullet
@item @item
the POSIX module, which provides Scheme-level procedures for system and The @acronym{POSIX} module, which provides Scheme-level procedures for
network programming that conform to the POSIX standard system and network programming that conform to the @acronym{POSIX}
standard.
@item @item
the SLIB module, which makes Aubrey Jaffer's portable Scheme library The @acronym{SLIB} module, which makes Aubrey Jaffer's portable Scheme
available for use in Guile. library available for use in Guile.
@end itemize @end itemize
@end table
@iftex @iftex