source: project/chicken/branches/prerelease/chicken-setup.1 @ 9381

Last change on this file since 9381 was 9381, checked in by Ivan Raikov, 12 years ago

Merged trunk into prerelease

File size: 6.5 KB
Line 
1.\" dummy line
2.TH CHICKEN-SETUP 1 "28 Feb 2008"
3
4.SH NAME
5
6chicken-setup - program to simplify building and installation of extension libraries for the
7.I CHICKEN
8Scheme system.
9
10.SH SYNOPSIS
11
12.B chicken-setup
13[
14.I option
15]
16[
17.I extension
18]
19
20.SH DESCRIPTION
21
22.I chicken\-setup
23is a program that compiles and installs a prepackaged extension
24library. Extension libraries are either plain Scheme files with the
25.B \.scm
26file-extension or gzipped tar files with the file-extension
27.B \.egg
28Single Scheme files are compiled into a dynamically loadable file
29and installed in the extension repository. More complex installation
30procedures can be performed by packaging an extension in an
31.B \.egg
32archive, that in addition to the source files contains a Scheme
33script of the same name as the library, but with the
34.B \.setup
35file-extension. After extracting the files the setup script will
36be loaded and executed.
37If no extension name is given on the command-line, then any
38existing
39.B \.setup
40scripts in the current directory are processed.
41.I chicken\-setup
42is a full Scheme interpreter with the same functionality as
43.I csi
44but with a number of additional procedures and macros to
45simplify the building and installation of extension libraries.
46See the
47.B Chicken
48manual for more information.
49
50.SH OPTIONS
51
52.TP
53.B \-h,\ \-help     
54Shows a summary of options and exits.
55
56.TP
57.B \-V,\ \-version
58Shows the version of
59.I chicken-setup
60and exits.
61
62.TP
63.B \-release
64Shows release number of CHICKEN and exits.
65
66.TP
67.BI \-R,\ \-repository \ [PATH]         
68If
69.B PATH
70is not given, prints the location of the extension repository.
71If
72.B PATH
73is given, specifies the location for the extension repository
74The default repository path is the installation library directory (usually
75.I /usr/local/lib/chicken
76, or (if set) the directory given in the environment variable
77.I CHICKEN\_REPOSITORY
78
79.TP
80.B \-u,\ \-uninstall
81Removes the given extension from the repository.
82
83.TP
84.BI \-H,\ \-host \ HOSTNAME[:PORT]
85Specifies alternative host for downloading extensions.
86.B PORT
87may be omitted and defaults to 80.
88
89.TP
90.BI \-p,\ \-proxy \ HOSTNAME[:PORT]
91Connects to server via proxy.
92.B PORT
93may be omitted and defaults to 80.
94
95.TP
96.B \-l,\ \-list
97Lists all installed extensions and exits, or show extension-information
98of extensions given on the command-line (following this option).
99
100.TP
101.BI \-r,\ \-run \ FILENAME
102Loads and executes given file.
103
104.TP
105.BI \-P,\ \-program\-path \ [PATH]
106If
107.B PATH
108is not given, prints the location where executable files will be installed.
109If
110.B PATH
111is given, specifies the location for installing executable files.
112
113.TP
114.BI  \-s,\ \-script \ FILENAME           
115Executes the given script with remaining arguments and exits.
116
117.TP
118.B \-f,\ \-fetch
119Only download, don't extract, build or install.
120
121.TP
122.B \-v,\ \-verbose
123Displays additional information (mainly for debugging).
124
125.TP
126.B \-k,\ \-keep
127Keeps intermediate files after building and installing.
128
129.TP
130.BI \-c,\ \-csc\-option \ option
131Passes
132.B option
133as an extra argument to invocations of the compiler-driver (
134.I csc
135). This works only if
136.I csc
137is invoked as
138.I (run\ (csc\ ...))
139
140.TP
141.B \-d,\ \-dont\-ask
142Does not ask the user before trying to download required extensions.
143
144.TP
145.BI \-n,\ \-no\-install
146Does not install generated binaries and support files after building.
147Any invocations of
148.I install\-program
149,
150.I install\-extension
151,
152.I install\-script
153or
154.I copy\-file
155will be no-ops.
156
157.TP
158.B \-i,\ \-docindex
159Displays the path to the index-page of any installed
160extension-documentation. If the index page does not exist, it is
161created.
162
163.TP
164.BI \-e,\ \-eval \ EXPRESSION
165Evaluates the given expression(s).
166
167.TP
168.BI \-t,\ \-test
169If the
170.B .egg
171extension archive contains a directory named
172.B tests
173and this directory includes a file named
174.B run\.scm
175then this file is executed (with
176.B tests
177being the current working directory).
178
179.TP
180.B \-host\-extension
181Compiles any extensions in "host" mode.
182
183.TP
184.BI \-ls \ EXTENSION
185Lists the installed files for the given extension.
186
187.TP
188.B \-fetch\-tree
189Downloads and prints the repository catalog to standard output.
190
191.TP
192.BI \-create\-tree \ PATH
193Creates repository catalog from SVN checkout.
194
195.TP
196.BI \-tree \ FILENAME
197Uses the repository catalog stored in
198.B FILENAME
199instead of downloading it.
200
201
202.TP
203.BI \-svn \ URL
204Fetches extension sources from an SVN repository instead of
205downloading egg from egg server.
206
207.TP
208.BI \-local \ PATH
209Fetches extension sources from the local filesystem at
210.B PATH
211instead of downloading egg from egg server.
212
213.TP
214.BI \-install-prefix \ PATH
215Specifies alternative installation prefix. The installation paths for
216all executable files, examples, and files installed with the
217.I copy-file
218and
219.I move-file
220procedures will be prepended by this prefix, if it is specified.
221
222.TP
223.BI \-revision \ REVISION
224Specifies the SVN revision that to check out (only useful in
225combination with the
226.B \-svn
227option).
228
229.TP
230.BI \-build\-prefix \ PATH
231Specifies the location where
232.I chicken-setup
233will create build directories. The default location is the value
234of environment variable
235.I CHICKEN_TMPDIR
236,
237.I TMPDIR
238or
239.I /tmp/chicken-{MAJOR-VERSION}-build-{USER}
240if none of those variables are found in the environment. If
241.I /tmp
242does not exist or is not writeable, then the build directory is
243.I {HOME}/tmp/chicken-{MAJOR-VERSION}-build-{USER}
244.
245
246
247.TP
248.BI \-download\-dir \ PATH
249Specifies the location where chicken-setup will save downloaded files
250The default is
251.I {BUILD-PREFIX}/downloads)
252
253
254.TP
255.B \-\-
256Ignores all further arguments.
257
258.SH ENVIRONMENT\ VARIABLES
259
260.TP
261.B CHICKEN_PREFIX
262The installation prefix where CHICKEN Scheme and its support files and
263libraries are located. Defaults to the installation time prefix given
264when configuring the system.
265
266.TP
267.B CHICKEN_INSTALL_PREFIX
268An alternative installation prefix that will be prepended to extension
269installation paths if specified.
270
271.TP
272.B CHICKEN_REPOSITORY
273The path where extension libraries are installed. Defaults to the package-library
274path selected during configuration (usually
275.B $prefix/lib/chicken/<binary\-version>
276)
277
278.TP
279.B CHICKEN_SETUP_OPTIONS
280A string with default options that should be passed to every invocation of
281.B chicken\-setup
282.
283
284.TP
285.B CHICKEN_TMPDIR
286The location where egg files will be unpacked and extensions compiled.
287
288.SH DOCUMENTATION
289
290More information can be found in the
291.I Chicken\ User's\ Manual
292
293.SH BUGS
294Submit bug reports by e-mail to
295.I chicken-janitors@nongnu.org
296, preferrably using the
297.B chicken\-bug
298tool.
299
300.SH AUTHORS
301Felix L. Winkelmann and the Chicken Team
302
303.SH SEE ALSO
304.BR chicken(1)
305.BR csc(1)
306.BR chicken-bug(1)
Note: See TracBrowser for help on using the repository browser.