source: project/chicken/trunk/csi.1 @ 15700

Last change on this file since 15700 was 10952, checked in by felix winkelmann, 12 years ago

merged changed from trunk rev. 10622:10950 (untested)

File size: 3.6 KB
Line 
1-.\" dummy line
2.TH CSI 1 "20 May 2008"
3
4.SH NAME
5
6The
7.I Chicken
8Scheme interpreter
9
10.SH SYNOPSIS
11
12.B csi
13[
14.I pathname
15|
16.I option ...
17]
18
19.SH DESCRIPTION
20
21.I csi
22is an interpreter for the programming language
23.I Scheme
24supporting most of the features as described in the
25.I Revised^5 Report on
26.I the Algorithmic Language Scheme
27\.
28.I csi
29is implemented as a program compiled with the
30.B chicken
31compiler.
32
33.SH OPTIONS
34
35.TP
36.B \-\-
37Ignore everything on the command-line following this marker. Runtime options
38.B \-\:...
39are still recognized.
40
41.TP
42.B \-i\ \-case\-insensitive
43Enables the reader to read symbols case-insensitive. The default is to read case-sensitive (in violation of R5RS).
44This option registers the
45.B case\-insensitive
46feature identifier.
47
48.TP
49.B \-b\ \-batch
50Quit the interpreter after processing all command line options.
51
52.TP
53.BI \-e\ \-eval \ expressions
54Evaluate
55.I expressions
56\.
57
58.TP
59.BI \-p\ \-print \ expressions
60Evaluate
61.I expressions
62and print result(s)
63\.
64
65.TP
66.BI \-P\ \-pretty-print \ expressions
67Evaluate
68.I expressions
69and pretty-print result(s)
70\.
71
72.BI \-D\ \-feature \ symbol
73Registers
74.I symbol
75to be a valid feature identifier for
76.B cond\-expand
77
78.TP
79.B \-h\ \-help
80Write a summary of the available command line options to standard ouput and exit.
81
82.TP
83.BI \-I\ \-include\-path \ pathname
84Specifies an alternative search-path for files included via the
85.B include
86special form. This option may be given multiple times. If the environment variable
87.B CHICKEN_INCLUDE_PATH
88is set, it should contain a list of alternative include
89pathnames separated by
90.B \; .
91
92.TP
93.BI \-k\ \-keyword\-style style
94Enables alternative keyword syntax, where style may be either
95.B prefix
96(as in Common Lisp),
97.B suffix
98(as in DSSSL) or
99.B none
100Any other value is ignored. The default is \texttt{suffix}.
101
102.TP
103.B \-n\ \-no\-init
104Do not load the initialization-file
105.I ~/\.csirc
106\.
107If this option is not given and the file
108.I ~/\.csirc
109exists, then it is loaded before the read-eval-print loop commences.
110
111.TP
112.B \-w\ \-no\-warnings
113Disables any warnings that might be issued by the reader or evaluated code.
114
115.TP
116.B \-q\ \-quiet
117Do not print a startup message.
118
119.TP
120.BI \-s\ \-script\  pathname
121This is equivalent to
122.B \-batch\ \-quiet
123.I pathname
124, but also ignores all arguments after the argument following
125.B \-script
126
127.TP
128.BI \-sx\ pathname
129Similar to
130.B \-script
131but invokes prints each expression before it is evaluated,
132
133.TP
134.BI \-ss\ pathname
135Similar to
136.B \-script
137but invokes the procedure
138.B main
139after loading the file specified by
140.B pathname
141with a single argument (the list of command line arguments) returning any result as status code.
142
143.TP
144.BI \-R\ \-require\-extension\  name
145Require extension for evaluated code.
146
147.TP
148.B \-v\ \-version
149Write the banner with version information to standard output and exit.
150
151.SH ENVIRONMENT\ VARIABLES
152
153.TP
154.B CHICKEN_INCLUDE_PATH
155Contains one or more pathnames where the interpreter should also look for include-files, separated by
156.B \;
157characters.
158
159.TP
160.B CHICKEN_PREFIX
161Is used as a prefix directory for support files, include-files and libraries.
162
163.TP
164.B CSI_OPTIONS
165When set to a string of command-line options, then the options are passed implicitly
166to every direct or indirect invocation of
167.I csi
168.br
169Note that runtime options of the form
170.B \-\:\.\.\.
171can not be passed using this method.
172
173.SH DOCUMENTATION
174
175More information can be found in the
176.I Chicken\ User's\ Manual
177
178.SH BUGS
179Submit bug reports by e-mail to
180.I chicken-janitors@nongnu.org
181, preferrably using the
182.B chicken\-bug
183tool.
184
185.SH AUTHOR
186Felix Winkelmann and the Chicken Team
187
188.SH SEE ALSO
189.BR chicken(1)
190.BR chicken-bug(1)
Note: See TracBrowser for help on using the repository browser.