source: project/chicken/trunk/chicken-install.1 @ 12819

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

build bugfixes (thanks to Wietse Jacobs); added -repository option to setup tools

File size: 3.7 KB
Line 
1.\" dummy line
2.TH CHICKEN-INSTALL 1 "13 Aug 2008"
3
4.SH NAME
5
6chicken-install \- download and install extension libraries for Chicken Scheme
7
8.SH SYNOPSIS
9
10chicken-install [OPTION | EXTENSION[:VERSION]] ...
11
12.SH DESCRIPTION
13
14.I chicken\-install
15is a program that downloads, compiles and installs a prepackaged
16extension library from sources. If no extension name is given on the
17command-line, then any existing
18.B setup
19scripts in the current
20directory will be executed in some unspecified order.
21See the
22.B Chicken
23manual for more information.
24
25.SH OPTIONS
26
27.TP
28.B \-h,\ \-help     
29Shows a summary of options and exits.
30
31.TP
32.B \-v,\ \-version
33Shows tool version and exits.
34
35.TP
36.B \-force
37Do not ask when versions don't match, continue with the installation instead.
38
39.TP
40.BI \-i,\ \-init\ DIRECTORY
41Initialize empty alternative repository.
42
43.TP
44.B \-k,\ \-keep
45Keep temporary directories after an installation process finished
46(whether successfull or not).
47
48.TP
49.N \-n\-install
50Do not install the extension, just build it. Implies
51.B \-keep
52
53.TP
54.BI \-l,\ \-location \ LOCATION
55Specifies the location from where to retrieve the extension sources.
56Defaults to the current official egg-repository suitable for this
57version of
58.B CHICKEN
59Depending on the transport used (see below), the
60.B LOCATION
61may be an svn(1) repository URL, a http URL or a location in the local
62file-system.
63
64.TP
65.BI \-r,\ \-repository \ DIRECTORY
66Specify alternative extension repository directory instead of the
67default (which is usually "<PREFIX>/lib/chicken/<BINARYVERSION>").
68
69.TP
70.BI \-t,\ \-transport \ TRANSPORT
71Selects the mechanism to use to download any extensions that are directly
72or indirectly to be installed. Currently the transports
73.B http
74(the default, retrieve files via the HTTP protocol),
75.B svn
76(retrieve by performing a checkout - requires the svn(1) client to be
77installed) and
78.B local
79(install directly from the local file-system).
80
81.TP
82.B \-s,\ \-sudo
83Perform any installation steps the install files by commands invoked
84with the sudo(1) tool.
85
86.TP
87.B \-u,\ \-update
88Scan all installed import libraries and generate module database file.
89
90.TP
91.B \-r,\ \-retrieve
92Only fetch the extensions, do not install them.
93
94.TP
95.BI \-p,\ \-prefix \ PREFIX
96Select an alternative installation prefix.
97
98.TP
99.B \-host\-extension
100Mark this extension as a "host" extension. This is mainly intended
101for cross-compilation.
102
103.TP
104.B \-test
105After successfull installation, invoke any accompanying test-suite,
106if found in the extension sources. When this option is given, additional
107dependencies configured in the
108.B test\-depends
109meta property may be downloaded and installed, if necessary.
110
111.TP
112.BI \-username USERNAME
113Set username for transports that require authentification.
114
115.TP
116.BI \-password PASSWORD
117Set password for transports that require authentification.
118
119.SH ENVIRONMENT\ VARIABLES
120
121.TP
122.B CHICKEN_PREFIX
123The installation prefix where CHICKEN Scheme and its support files and
124libraries are located. Defaults to the installation time prefix given
125when configuring the system.
126
127.TP
128.B CHICKEN_INSTALL_PREFIX
129An alternative installation prefix that will be prepended to extension
130installation paths if specified.
131
132.TP
133.B CHICKEN_REPOSITORY
134The path where extension libraries are installed. Defaults to the package-library
135path selected during configuration (usually
136.B $prefix/lib/chicken/<binary\-version>
137)
138
139
140.SH DOCUMENTATION
141
142More information can be found in the
143.I Chicken\ User's\ Manual
144
145.SH BUGS
146Submit bug reports by e-mail to
147.I chicken-janitors@nongnu.org
148, preferrably using the
149.B chicken\-bug
150tool.
151
152.SH AUTHORS
153The Chicken Team
154
155.SH SEE ALSO
156.BR chicken-uninstall(1)
157.BR chicken-status(1)
158.BR chicken(1)
159.BR csc(1)
160.BR chicken-bug(1)
Note: See TracBrowser for help on using the repository browser.