source: project/chicken/trunk/chicken-setup.1 @ 6226

Last change on this file since 6226 was 6226, checked in by felix winkelmann, 13 years ago

added chicken-bug(1) tool (incomplete, yet); install-info with --info-file=... does not seem to work?

File size: 5.3 KB
Line 
1.\" dummy line
2.TH CHICKEN-SETUP 1 "25 Jan 2004"
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 \-check
54Downloads the repository-index and lists locally installed extensions for which a newer
55release is available for download.
56
57.TP
58.BI \-csc\-option option
59Passes
60.B option
61as an extra argument to invocations of the compiler-driver (
62.I csc
63). This works only if
64.I csc
65is invoked as
66.I (run\ (csc\ ...))
67
68.TP
69.BI \-destdir\ pathname
70Specifies alternative installation prefix by setting the
71.B installation-prefix
72parameter.
73
74.TP
75.B \-docindex
76Displays the path to the index-page of any installed extension-documentation. If the index page
77does not exist, it is created.
78
79.TP
80.B \-dont\-ask
81Do not ask the user before trying to download required extensions.
82
83.TP
84.BI \-eval\ expression
85Evaluates the given expression(s).
86
87.TP
88.B \-fetch
89Only download, don't extract, build or install.
90
91.TP
92.B \-fetch\-tree
93Downloads and prints the repository catalog to stdout.
94
95.TP
96.B \-help
97Show usage information and exit.
98
99.TP
100.BI \-host\ hostname:port
101Specifies alternative host for downloading extensions.
102.B port
103may be omitted and defaults to 80.
104
105.TP
106.B \-keep
107Keep temporary files and directories.
108
109.TP
110.B \-list
111List all installed extensions and exit, or show extension-information of extensions given on the
112command-line (following this option).
113
114.TP
115.BI \-local\ path
116Fetch extension sources from local filesystem at
117.B path
118instead of downloading egg from egg server.
119
120.TP
121.B \-no\-install
122Do not install generated binaries and/or support files. Any invocations of
123.I install\-program
124,
125.I install\-extension
126or
127.I install\-script
128will be be no-ops.
129
130.TP
131.B \-program\-path
132Display the path where executables are installed.
133
134.TP
135.BI \-program\-path\ directory
136Sets the location where executables are installed.
137
138.TP
139.BI \-proxy\ hostname:port
140Connect to server via proxy.
141.B port
142may be omitted and defaults to 80.
143
144.TP
145.B \-repository
146Displays the name of the extension repository.
147
148.TP
149.BI \-repository\ directory
150Sets the location of the extension repository for all subsequent operations.
151The default repository path is the installation library directory (usually
152.I \/usr\/local\/lib\/chicken
153, or (if set) the directory given in the environment variable
154.I CHICKEN\_REPOSITORY
155
156.TP
157.BI \-revision\ revision
158Specifies the subversion revision that you want to check out (only useful in
159combination with the
160.B \-svn
161option).
162
163.TP
164.BI \-run\ filename
165Load and execute given file.
166
167.TP
168.BI \-script\ filename
169Executes the given Scheme source file with all remaining arguments and exit.
170
171.TP
172.BI \-svn\ url
173Fetch extension sources from Subversion (http://subversion.tigris.org) repository,
174instead of downloading egg from egg server.
175
176.TP
177.B \-test
178If the extension sources contain a directory named
179.B tests
180and this directory includes a file named
181.B run\.scm
182then this file is executed (with
183.B tests
184being the current working directory).
185
186.TP
187.BI \-tree\ filename
188Uses the repository catalog stored in
189.B filename
190instead of downloading it.
191
192.TP
193.B \-uninstall
194Removes all following extensions from repository.
195
196.TP
197.B \-verbose
198Display additional information (mainly for debugging).
199
200.TP
201.B \-version
202Display version and exit.
203
204.TP
205.B \-\-
206Ignore all further arguments.
207
208.SH ENVIRONMENT\ VARIABLES
209
210.TP
211.B CHICKEN_PREFIX
212An alternative installation prefix, where the Scheme-to-C translator
213and any support files and libraries are located. Defaults to the installation
214time prefix given when configuring the system.
215
216.TP
217.B CHICKEN_REPOSITORY
218The path where extension libraries are installed. Defaults to the package-library
219path selected during configuration (usually
220.B $prefix/lib/chicken/<binary\-version>
221)
222
223.TP
224.B CHICKEN_SETUP_OPTIONS
225A string with default options that should be passed to every invocation of
226.B chicken\-setup
227.
228
229.SH DOCUMENTATION
230
231More information can be found in the
232.I Chicken\ User's\ Manual
233
234.SH BUGS
235Submit bug reports by e-mail to
236.I felix@call-with-current-continuation.org
237, preferrably using the
238.B chicken\-bug
239tool.
240
241.SH AUTHOR
242.I chicken\-setup
243was written by Felix L. Winkelmann (felix@call-with-current-continuation.org).
244
245.SH SEE ALSO
246.BR chicken(1)
247.BR csc(1)
248.BR chicken-bug(1)
Note: See TracBrowser for help on using the repository browser.