[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Guile-commits] GNU Guile branch, stable-2.0, updated. v2.0.0-64-g900a6f
[Guile-commits] GNU Guile branch, stable-2.0, updated. v2.0.0-64-g900a6f8
Sat, 05 Mar 2011 19:29:34 +0000
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU Guile".
The branch, stable-2.0 has been updated
via 900a6f87bad5c5a34f017cc6c851483758433f38 (commit)
from fd029c35de681efe530ba1e054e918c69d3602ef (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
Author: Mark Harig <address@hidden>
Date: Fri Mar 4 19:36:28 2011 -0500
Updated Guile manual page.
* doc/guile.1: Added the current month and year, Guile version
descriptive text, and the text GNU to the title.
Updated the nroff formatting commands for the SYNOPSIS and OPTIONS
sections to what 'man' prescribes. See 'man(1)', 'man(7)', and
Corrected grammar, spelling, and capitalization (for example,
'scheme' to 'Scheme').
Vertical white-space was non-standard (two lines between some
sections, one space between others). Changed this to the standard
one empty line before each section heading, and added dots (a single
period on a line) before every section heading (.SH) so that
maintainers will find the readability unchanged.
Added white space to follow the 'groff' recommendation of starting
every sentence on its own line, and breaking sentences at
Corrected an error in description of the info command.
Added the missing option '--no-debug', and the short switches '-h'
Changed the description of the environment variable
GUILE_LOAD_COMPILED_PATH so that it references the Guile variable
`%load-compiled-path' instead of the variable `%load-path'.
Updated the copyright to include 2011.
Summary of changes:
doc/guile.1 | 295 ++++++++++++++++++++++++++++++++++++++++-------------------
1 files changed, 199 insertions(+), 96 deletions(-)
diff --git a/doc/guile.1 b/doc/guile.1
index 2d1fba9..e36c2aa 100644
@@ -3,113 +3,210 @@
.\" Process this file with
.\" groff -man -Tascii foo.1
-.TH GUILE 1
+.\" title section date source manual
+.TH GUILE 1 "2011-03-04" GNU "GNU Guile 2.0"
-guile \- the GNU extension language
+guile \- The GNU Project Extension Language
-.B guile [-L DIRECTORY] [-l FILE] [-e FUNCTION] [\\\\]
-.B [-c EXPR] [-s SCRIPT] [--] [SCRIPT] [ARG...]
+.RB [\| \-L
+.IR DIRECTORY \|]
+.RB [\| \-l
+.IR FILE \|]
+.RB [\| \-e
+.IR FUNCTION \|]
+.\".RI [\| \\\\ \|]
+.RB [\| \e \|]
+.RB [\| \-c
+.IR EXPR \|]
+.RB [\| \-s
+.IR SCRIPT \|]
+.RB [\| \-\- \|]
+.RI [\| SCRIPT
+.RI [\| ARGs\ for\ SCRIPT \|]\c
-Only the most useful options are listed here; see below for the
+Only the most useful options are listed here;
+see below for the remainder.
-GNU Guile is an implemention of the Scheme programming language. It
-extends the R5RS and R6RS language standards, providing additional
-features necessary for real-world use. Guile works well for interactive
-use, basic scripting, and extension of larger applications, as well as
-for stand-alone Scheme application development.
+GNU Guile is an implementation of the Scheme programming language.
+It extends the R5RS and R6RS language standards,
+providing additional features necessary for real-world use.
+Guile works well for interactive use,
+and extension of larger applications,
+as well as for stand-alone Scheme application development.
executable itself provides a stand-alone interactive compiler and
-run-time for Scheme programs, both for interactive use and for executing
-Scheme scripts or programs.
+run-time for Scheme programs,
+both for interactive use and for executing Scheme scripts or programs.
This manual page provides only brief instruction in invoking
-from the command line. Please consult the guile info documentation
-.B info "guile(Invoking Guile)"
-at a command prompt) for more information.
+from the command line.
+Please consult the Guile info documentation for more information,
+(type \fB info "(guile)Invoking Guile"\fR at a command prompt).
-.IP -L DIRECTORY
-Add DIRECTORY to the front of Guile's module load path.
-.IP -l FILE
-Load scheme source code from file.
-.IP -e FUNCTION
-After reading script, apply FUNCTION to command-line arguments. Note
-that FUNCTION is evaluated, so e.g.
+.BI -L \ DIRECTORY
+Add \fIDIRECTORY\fR to the front of Guile's module load path.
+.BI -l \ FILE
+Load Scheme source code from \fIFILE\fR.
+.BI -e \ FUNCTION
+After reading \fISCRIPT\fR, apply \fIFUNCTION\fR to command-line arguments.
+Note that \fIFUNCTION\fR is evaluated,
+so, for example,
.B (@ (my-module) my-proc)
is valid here.
The "meta switch", used to work around limitations in #! scripts.
-See "The Meta Switch" in the texinfo documentation, for more details.
-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. Note that
-the in many cases it is not necessary to use -s; one may invoke Guile
-.B guile SCRIPT-FILE ARG...
-Do -s SCRIPT at this point. Note that this argument must be used in
-conjuction with -s.
-Start guile with the debugging VM. By default, on when invoked
-interactively, off otherwise.
+See "The Meta Switch" in the texinfo documentation for more details.
+Stop argument processing, and start
+in interactive mode.
+.BI -c \ EXPR
+Stop argument processing,
+and evaluate \fIEXPR\fR as a Scheme expression.
+.BI -s \ SCRIPT-FILE
+Load Scheme source from \fISCRIPT-FILE\fR and execute as a script.
+Note that in many cases it is not necessary to use \fB-s\fR;
+one may invoke
+.I SCRIPT-FILE ARG...
+Carry out \fB\-s \fISCRIPT\fR at this point in the option sequence.
+Note that this argument must be used in conjunction with \fB\-s\fR.
+with the debugging VM.
+By default, debugging is on when
+is invoked interactively;
+it is off otherwise.
+without the debugging VM,
+is being run interactively.
Compile source files automatically (default behavior).
Disable automatic source file compilation.
-Listen on a port or socket for remote REPL connections. See the manual
-for more details.
-Load SRFI extensions N, M, etc. For example, "--use-srfi=8,13".
-.IP -x EXTENSION
-Add EXTENSION to the Guile's load extension list.
-Describe command line options and exit
+Listen on a port or socket for remote REPL connections.
+See the manual for more details.
+Load SRFI extensions \fIN\fR, \fIM\fR, etc.
+.BI -x \ EXTENSION
+Add \fIEXTENSION\fR to the
+load extension list.
+Describe command-line options and exit.
Display guile version and exit.
-In interactive mode, suppress loading the user's ~/.guile file.
+In interactive mode,
+suppress loading the user's initialization file,
.\".TP \w'MANROFFSEQ\ \ 'u
.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.
+is set before
+its value is used to augment the path to search for Scheme files when
+It should be a colon-separated list of directories,
+which will be prefixed to the default
.RB $ GUILE_LOAD_COMPILED_PATH
-is set, its value is used to agument the path to search for compiled
-Scheme files (.go files) when loading. It should be a colon separated
-list of directories which will be prepended to the default %load-path.
+is set before
+its value is used to augment the path to search for compiled
+Scheme files (.go files) when loading.
+It should be a colon-separated list of directories,
+which will be prefixed to the default
-is a guile script that is executed before any other processing occurs.
-For example, the following .guile activates guile's readline
+A Guile script that is executed before any other processing occurs.
+For example, the following
+activates guile's readline interface:
-(use-modules (ice-9 readline))
+.B (use-modules (ice-9 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
+The full documentation for Guile is maintained as a Texinfo manual.
+programs are properly installed at your site,
.B info guile
@@ -117,39 +214,45 @@ should give you access to the complete manual.
http://www.schemers.org provides a general introduction to the
.SH "REPORTING BUGS"
-There is a mailing list, address@hidden, for reporting Guile bugs and
-fixes. But before reporting something as a bug, please try to be sure
-that it really is a bug, not a misunderstanding or a deliberate feature.
+There is a mailing list,
+for reporting Guile bugs and fixes.
+But before reporting something as a bug,
+please try to be sure that it really is a bug,
+not a misunderstanding or a deliberate feature.
We ask you to read the section ``Reporting Bugs'' in the Guile reference
-manual (or Info system) for hints on how and when to report bugs. Also,
-include the version number of the Guile you are running in every bug
-report that you send in. Bugs tend actually to be fixed if they can be
-isolated, so it is in your interest to report them in such a way that
-they can be easily reproduced.
+manual (or Info system) for hints on how and when to report bugs.
+Also, include the version number of the Guile you are running in every bug
+report that you send in.
+Bugs tend actually to get fixed if they can be isolated,
+so it is in your interest to report them in such a way that they can be
-Copyright (C) 2010 Free Software Foundation, Inc.
+Copyright (C) 2010, 2011 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of this
document provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
-document under the conditions for verbatim copying, provided that the
-entire resulting derived work is distributed under the terms of a
-permission notice identical to this one.
+document under the conditions for verbatim copying,
+provided that the entire resulting derived work is distributed under the
+terms of a permission notice identical to this one.
Permission is granted to copy and distribute translations of this
-document into another language, under the above conditions for modified
-versions, except that this permission notice may be stated in a
+document into another language,
+under the above conditions for modified versions,
+except that this permission notice may be stated in a
translation approved by the Free Software Foundation.
-Robert Merkel <address@hidden> wrote this manpage.
+Robert Merkel <address@hidden> wrote this manpage.
Rob Browning <address@hidden> has added to it.
-is GNU software. Guile is originally based on Aubrey Jaffer's
-SCM interpreter, and is the work of many individuals.
+is GNU software.
+Guile is originally based on Aubrey Jaffer's SCM interpreter,
+and is the work of many individuals.
|[Prev in Thread]
||[Next in Thread]|
- [Guile-commits] GNU Guile branch, stable-2.0, updated. v2.0.0-64-g900a6f8,
Andy Wingo <=