From 4cd2722652048079469732bfb1357cb747fce782 Mon Sep 17 00:00:00 2001 From: Marius Vollmer Date: Tue, 24 Apr 2001 23:23:05 +0000 Subject: [PATCH] * guile.1: New file, from Robert Merkel and Rob Browning. * Makefile.am (man_MANS, EXTRADIST): Added, but still commented out: install and distirbute the manpage. It is not yet installed or distributed since we don't have the Robert's papers yet. --- doc/Makefile.am | 6 ++++ doc/guile.1 | 93 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 99 insertions(+) create mode 100644 doc/guile.1 diff --git a/doc/Makefile.am b/doc/Makefile.am index 5acbb145c..a22dff8bf 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -21,6 +21,9 @@ AUTOMAKE_OPTIONS = foreign +# pending the papers from Robert Merkel +# man_MANS = guile.1 + info_TEXINFOS = guile.texi r5rs.texi goops.texi guile-tut.texi guile_TEXINFOS = preface.texi intro.texi scheme-intro.texi \ @@ -73,3 +76,6 @@ $(srcdir)/version.texi: stamp-vti # And the same for version-tutorial.texi. $(srcdir)/version-tutorial.texi: stamp-vti1 @: + +# pending the papers from Robert Merkel +# EXTRA_DIST = guile.1 diff --git a/doc/guile.1 b/doc/guile.1 new file mode 100644 index 000000000..ddf3cde1c --- /dev/null +++ b/doc/guile.1 @@ -0,0 +1,93 @@ +.\" Written by Robert Merkel (rgmerk@mira.net) +.\" augmented by Rob Browning +.\" 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 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" +.B info guile, info guile-tut + +http://www.schemers.org provides a general introduction to the +Scheme language. + +.SH AUTHORS +Robert Merkel wrote this manpage. +Rob Browning 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. -- 2.20.1