Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 145 lines (136 sloc) 4.69 kb
12105da @feeley Add doc/gsi.1 a minimal man page for gsi and gsc.
authored
1 .\" Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH GSI/GSC 1 "June 3, 2009" "4.4.3" "User Commands"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh disable hyphenation
10 .\" .hy enable hyphenation
11 .\" .ad l left justify
12 .\" .ad b justify to both left and right margins
13 .\" .nf disable filling
14 .\" .fi enable filling
15 .\" .br insert line break
16 .\" .sp <n> insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 gsi \- Gambit-C Scheme Interpreter and Compiler
20 .SH SYNOPSIS
21 .B gsi
22 [
23 -\fB:\fP\fIarg\fP,... ]
24 [
25 .B \-f
26 ]
27 [
28 .B \-v
29 ]
30 [[\-]
31 [
32 .B \-e
33 ]
34 [
35 .I file
36 ]]...
37 .br
38 .B gsc
39 .RI [ options ]
40 .RI [ files ]
41 .br
42 .PP
43 \fBgsc-script, gsi-script, scheme-ieee-1178-1990, scheme-r4rs, scheme-srfi-0,
44 six\fP, and \fBsix-script\fP: currently synonyms for \fBgsi\fP.
45
46 \fBscheme-r5rs\fP is registered in the Debian alternatives system and can be
47 configured to point at \fBgsi\fP.
48
49 .SH DESCRIPTION
8592623 @feeley Fix typos in Gambit man page.
authored
50 This manual page briefly documents the
12105da @feeley Add doc/gsi.1 a minimal man page for gsi and gsc.
authored
51 .B gsi
52 and
53 .B gsc
54 commands.
55 .PP
56 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
8592623 @feeley Fix typos in Gambit man page.
authored
57 .\" \fI<whatever>\fP escape sequences to invoke bold face and italics,
12105da @feeley Add doc/gsi.1 a minimal man page for gsi and gsc.
authored
58 .\" respectively.
59 The \fBGambit-C\fP programming system is a full implementation of the Scheme
60 language which conforms to the R4RS, R5RS, and IEEE Scheme standards. It
61 consists of two main programs: \fBgsi\fP, the Gambit Scheme interpreter, and
62 \fBgsc\fP, the Gambit Scheme compiler. The interpreter provides an
63 interactive environment with a debugger, while the compiler can produce
64 stand-alone executables or modules which can be linked or loaded at run time.
65 Interpreted code and compiled code can be freely mixed. C modules can be
66 linked with Scheme modules.
67 .PP
68 The interpreter is executed in \fBinteractive mode\fP when no file or `\-' or
69 `\-e' option is given on the command line. When at least one file or `\-' or
70 `\-e' option is present the interpreter is executed in \fBbatch mode\fP.
71 .PP
72 Entering \fB,q\fP or (exit) at the interpreter's command prompt will exit the
73 interpreter.
74 .PP
75 Entering \fB,?\fP at the interpreter's command prompt will display
76 a list of special commands.
77 .PP
78 In \fBbatch mode\fP the command line arguments denote files to be loaded, REPL
79 interactions to start (`\-' option), and expressions to be evaluated (`\-e'
80 option). Note that the `\-' and `\-e' options can be interspersed with the
81 files on the command line and can occur multiple times. The interpreter
82 processes the command line arguments from left to right, loading files with the
83 `load' procedure and evaluating expressions with the `eval' procedure in the
84 global interaction environment. After this processing the interpreter exits.
85 .PP
86 \fBgsc-cc-o.bat\fP is a script called by \fBgsc\fP to generate object files during
87 compilation. It takes its data from environment variables and is not intended
88 for user interaction.
89
90 .SH OPTIONS
91 A summary of options is included below.
92 For a complete description, see the Info files.
93 .TP
94 .B \-
95 Initiate a REPL at this point. (Continue by issuing a \fB,c\fP command at
96 the interpreter prompt)
97 .TP
98 .B \-:
99 Comma separated list of run-time options
100 .TP
101 .B \-e
102 Evaluate an expression.
103 .TP
104 .B \-f
105 Skip initialization file.
106 .TP
107 .B \-v
108 Show version of program.
109 .SH SEE ALSO
110 .br
111
112 The documentation for these programs is arguably too extensive to cover with
113 man pages. Only the common command line options are given here. The programs
114 are documented fully in \fBGambit-C\fP, available on-line at the Gambit-C
115 Homepage. Once package gambc-doc is installed, this 200+ page document is
116 available via the Info system (info gambit-c), in html via doc-base, or as
117 files in /usr/share/doc/gambc (html, pdf, txt).
118
119 .br
120
121 The Debian package r5rs-doc provides the Revised(5) Report on the Algorithmic
122 Language Scheme in several formats. That document is the defining
123 description of the programming language Scheme.
124
125 .br
126 \fBdhelp(1), gcc(1), update-alternatives(8)\fP
127 .SH COPYRIGHT
128 .br
129 Gambit-C is Copyright (c) 1994-2009 by Marc Feeley, all rights reserved.
130 .PP
131 Gambit-C is released under a dual LGPL and Apache 2 license.
132 .br
133 For further information refer to /usr/share/doc/gambc/copyright.
134 .PP
135 This manual page is
136 .br
137 Copyright (c) 2006-2009 Marc Feeley and Kurt B. Kaiser <kbk@shore.net>
138 .br
139 Released under the same license as Gambit-C.
140
141 .SH AUTHOR
142 Gambit-C was written by Marc Feeley <gambit@iro.umontreal.ca>.
143 .PP
144 Homepage: http://gambit.iro.umontreal.ca
Something went wrong with that request. Please try again.