[bpt/guile.git] / doc / guile.1

.\" Written by Robert Merkel (rgmerk@mira.net)
.\" augmented by Rob Browning <rlb@cs.utexas.edu>
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH GUILE 1
.SH NAME
guile \- a Scheme interpreter
.SH SYNOPSIS
.B guile [-q] [-ds] [--help] [--version] [--emacs] [--debug]
.B [-l FILE] [-e FUNCTION] [\]
.B [-c EXPR] [-s SCRIPT] [--]
.SH DESCRIPTION
GNU Guile is an interpreter for the Scheme programming language.  It
implements R5RS, providing additional features
necessary for real-world use.  It is extremely simple to embed guile
into a C program, calling C from Scheme and Scheme from C.  Guile's
design makes it very suitable for use as an "extension" or "glue"
language, but it also works well as a stand-alone scheme development
environment.

The
.B guile
executable itself provides a stand-alone interpreter for scheme
programs, for either interactive use or executing scripts.

This manpage provides only brief instruction in invoking
.B guile
from the command line.  Please consult the guile info documentation
(type 
.B info guile
at a command prompt) for more information.  There is also a tutorial
.B (info guile-tut) 
available.

.SH OPTIONS
.IP -l FILE
Load scheme source code from file.
.IP -e FUNCTION
After reading script, apply FUNCTION to command-line arguments
.IP -ds
do -s SCRIPT at this point (note that this argument must be used in
conjuction with -s)
.IP --help 
Describe command line options and exit
.IP --debug
Start guile with debugging evaluator and backtraces enabled 
(useful for debugging guile scripts)
.IP --version
Display guile version and exit.
.IP --emacs
Enable emacs protocol for use from within emacs (experimental)
.IP --
Stop argument processing, start guile in interactive mode.
.IP -c EXPR
Stop argument processing, evaluate EXPR as a scheme expression.
.IP -s SCRIPT-FILE
Load Scheme source from SCRIPT-FILE and execute as a script.

.SH ENVIRONMENT
.\".TP \w'MANROFFSEQ\ \ 'u
.TP
.B GUILE_LOAD_PATH
If
.RB $ GUILE_LOAD_PATH
is set, its value is used to agument the path to search for scheme
files when loading.  It should be a colon separated list of
directories which will be prepended to the default %load-path.

.SH FILES
.I ~/.guile
is a guile script that is executed before any other processing occurs.
For example, the following .guile activates guile's readline
interface:

.RS 4
(use-modules (ice-9 readline))
.RS 0
(activate-readline)

.SH "SEE ALSO"
The full documentation for guile is maintained as a Texinfo manual.  If
the info and guile programs are properly installed at your site, the
command
.IP
.B info guile
.PP
should give you access to the complete manual.

http://www.schemers.org provides a general introduction to the
Scheme language.

.SH AUTHORS
Robert Merkel <rgmerk@mira.net> wrote this manpage.  
Rob Browning <rlb@cs.utexas.edu> has added to it.

.B guile 
is GNU software.  Guile is originally based on Aubrey Jaffer's
SCM interpreter, and is the work of many individuals.
Commit	Line	Data
4cd27226 MV	1	.\" Written by Robert Merkel (rgmerk@mira.net)
	2	.\" augmented by Rob Browning <rlb@cs.utexas.edu>
	3	.\" Process this file with
	4	.\" groff -man -Tascii foo.1
	5	.\"
1660414a	6	.TH GUILE 1
4cd27226 MV	7	.SH NAME
	8	guile \- a Scheme interpreter
	9	.SH SYNOPSIS
	10	.B guile [-q] [-ds] [--help] [--version] [--emacs] [--debug]
	11	.B [-l FILE] [-e FUNCTION] [\]
	12	.B [-c EXPR] [-s SCRIPT] [--]
	13	.SH DESCRIPTION
1660414a LC	14	GNU Guile is an interpreter for the Scheme programming language. It
1660414a LC	15	implements R5RS, providing additional features
4cd27226 MV	16	necessary for real-world use. It is extremely simple to embed guile
	17	into a C program, calling C from Scheme and Scheme from C. Guile's
	18	design makes it very suitable for use as an "extension" or "glue"
	19	language, but it also works well as a stand-alone scheme development
	20	environment.
	21
	22	The
	23	.B guile
	24	executable itself provides a stand-alone interpreter for scheme
	25	programs, for either interactive use or executing scripts.
	26
	27	This manpage provides only brief instruction in invoking
	28	.B guile
	29	from the command line. Please consult the guile info documentation
	30	(type
	31	.B info guile
	32	at a command prompt) for more information. There is also a tutorial
	33	.B (info guile-tut)
	34	available.
	35
	36	.SH OPTIONS
	37	.IP -l FILE
	38	Load scheme source code from file.
	39	.IP -e FUNCTION
	40	After reading script, apply FUNCTION to command-line arguments
	41	.IP -ds
	42	do -s SCRIPT at this point (note that this argument must be used in
	43	conjuction with -s)
	44	.IP --help
	45	Describe command line options and exit
	46	.IP --debug
	47	Start guile with debugging evaluator and backtraces enabled
	48	(useful for debugging guile scripts)
	49	.IP --version
	50	Display guile version and exit.
	51	.IP --emacs
	52	Enable emacs protocol for use from within emacs (experimental)
	53	.IP --
	54	Stop argument processing, start guile in interactive mode.
	55	.IP -c EXPR
	56	Stop argument processing, evaluate EXPR as a scheme expression.
	57	.IP -s SCRIPT-FILE
	58	Load Scheme source from SCRIPT-FILE and execute as a script.
	59
	60	.SH ENVIRONMENT
	61	.\".TP \w'MANROFFSEQ\ \ 'u
	62	.TP
	63	.B GUILE_LOAD_PATH
	64	If
	65	.RB $ GUILE_LOAD_PATH
	66	is set, its value is used to agument the path to search for scheme
	67	files when loading. It should be a colon separated list of
	68	directories which will be prepended to the default %load-path.
	69
	70	.SH FILES
	71	.I ~/.guile
	72	is a guile script that is executed before any other processing occurs.
	73	For example, the following .guile activates guile's readline
	74	interface:
	75
	76	.RS 4
	77	(use-modules (ice-9 readline))
	78	.RS 0
	79	(activate-readline)
80
81	.SH "SEE ALSO"
1660414a LC	82	The full documentation for guile is maintained as a Texinfo manual. If
	83	the info and guile programs are properly installed at your site, the
	84	command
	85	.IP
	86	.B info guile
	87	.PP
	88	should give you access to the complete manual.
4cd27226 MV	89
	90	http://www.schemers.org provides a general introduction to the
	91	Scheme language.
	92
	93	.SH AUTHORS
	94	Robert Merkel <rgmerk@mira.net> wrote this manpage.
	95	Rob Browning <rlb@cs.utexas.edu> has added to it.
	96
	97	.B guile
	98	is GNU software. Guile is originally based on Aubrey Jaffer's
	99	SCM interpreter, and is the work of many individuals.