bug-guile
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

patch: guile manpage.


From: Rob Browning
Subject: patch: guile manpage.
Date: 06 Jan 2001 19:00:12 -0600
User-agent: Gnus/5.0807 (Gnus v5.8.7) Emacs/20.7

Marius Vollmer <address@hidden> writes:

> We want it! :-) Please send it to address@hidden, complete with
> copyright details, and if possible, Makefile rules for installation,
> etc.

The manpage is reproduced below.

With regard to copyright, the manpage was written by Robert Merkel
whose address appears below.  I'm fairly certain he'd be happy to
handle whatever administrative bits you need wrt copyright, as would I.

With regard to building, just put the manpage in doc/ as guile.1, and
add the following line to doc/Makefile.am:

man_MANS = guile.1

If you need anything further, don't hesitate to contact me.

Thanks

.\" Written by Robert Merkel (address@hidden)
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH GUILE 1 "January 2001" Version "1.4"
.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
Guile is an interpreter for the Scheme programming language.  It
implements a superset of R4RS, providing the 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 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"
.B info guile-{ref,tute}

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

.SH AUTHORS
Robert Merkel <address@hidden> wrote this manpage.  

.B guile 
is GNU software.  Guile is originally based on Aubrey Jaffer's
SCM interpreter, and is the work of many individuals.

-- 
Rob Browning <address@hidden> PGP=E80E0D04F521A094 532B97F5D64E3930



reply via email to

[Prev in Thread] Current Thread [Next in Thread]