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

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

removed -check from chicken-setup manpage [Thanks to Jürgen Lorentz]

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