This is the mail archive of the guile@sourceware.cygnus.com mailing list for the Guile project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Man page for guile.



I figured having a man page (even a simple one) for guile might be
helpful to a lot of people, so I wrote one.  If this text is long
enough that I need to go through the copyright mess now, then I'll do
it, but below I just listed the copyright as belonging to the FSF (I
suspect that may not be kosher).

.\" Man page for guile.
.\" Copyright (C) 2000 Free Software Foundation
.\" Originally written by Rob Browning <rlb@cs.utexas.edu>
.TH guile 1 "2000 January 10"
.SH NAME
guile \- The GNU extension lanugage
.SH SYNOPSIS
.B guile
.RB [ \-s
.IR script ]
.RB [ \-c
.IR expression ]
.RB [ \-\- ]
.RB [ \-l
.IR file ]
.RB [ \-e
.IR func ]
.RB [\| \-ds \|]
.RB [\| \-q \|]
.RB [\| \-\-emacs \|]
.RB [\| \-h \||\| \-\-help \|]
.RB [\| \-v \||\| \-\-version \|]
.RB [\| \e \|]
.B ...
.SH DESCRIPTION
.I Guile
is an interpreter for the Scheme programming language, nicely packaged
as a library you can link into your programs. Your program has full
access to the interpreter's data structures, so you can extend Guile
with your own primitives, datatypes and syntax. The result is a
scripting language tailored to your application.

The primary documentation for Guile is provided in the form of info
pages which you can read from the command line via "info guile" or
"info guile-ref", or through Emacs' built in info system (type C-h i)
from within Emacs.  This man page is updated only when someone
volunteers to do so; the Emacs maintainers' priority goal is to
minimize the amount of time this man page takes away from other more
useful projects.
.\" ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
.SH OPTIONS
.TP
.BI \-s\ script
Load Scheme source code from file
.I script
and exit.  This option stops argument processing and passes all
remaining arguments to as the value of "(command-line)".
.TP
.BI \-c\ expression
Evaluate Scheme
.I expression
and exit.  This option stops argument processing and passes all
remaining arguments to as the value of "(command-line)".
.TP
.BI \-\-
Stop scanning arguments.  This option stops argument processing and
passes all remaining arguments to as the value of "(command-line)".
.TP
.BI \-l\ file
Load Scheme source from
.IR file .
.TP
.\"FIXME Clarify: Can you specify more than one of these for more than
 \"one script?
.BI \-e\ function
Apply
.I function
to command line arguments.
.TP
.BI \-ds
.\"FIXME Clarify: This is unclear.
Execute -s script at this point.
.TP
.BI \-q
Do not load the user's init file.
.TP
.BI \-\-emacs
Enable the Emacs protocol (experimental).
.TP
.BR \-h ,\ \-\-help
Display usage information and exit.
.TP
.BR \-v ,\ \-\-version
Display version information and exit.
.TP
.BR \e
Read arguments from following script lines.  See the guile-ref info
pages for more details.
.\" ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
.SH "SEE ALSO"
info
.BR guile ,
info
.B guile-ref ,
info
.B r5rs

-- 
Rob Browning <rlb@cs.utexas.edu> PGP=E80E0D04F521A094 532B97F5D64E3930

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]