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

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

added missing documentation; -init option for chicken-install; added missing chicken-home to chicken.import.scm

File size: 3.4 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 \-t,\ \-transport \ TRANSPORT
66Selects the mechanism to use to download any extensions that are directly
67or indirectly to be installed. Currently the transports
68.B http
69(the default, retrieve files via the HTTP protocol),
70.B svn
71(retrieve by performing a checkout - requires the svn(1) client to be
72installed) and
73.B local
74(install directly from the local file-system).
75
76.TP
77.B \-s,\ \-sudo
78Perform any installation steps the install files by commands invoked
79with the sudo(1) tool.
80
81.TP
82.B \-r,\ \-retrieve
83Only fetch the extensions, do not install them.
84
85.TP
86.BI \-p,\ \-prefix \ PREFIX
87Select an alternative installation prefix.
88
89.TP
90.B \-host\-extension
91Mark this extension as a "host" extension. This is mainly intended
92for cross-compilation.
93
94.TP
95.B \-test
96After successfull installation, invoke any accompanying test-suite,
97if found in the extension sources. When this option is given, additional
98dependencies configured in the
99.B test\-depends
100meta property may be downloaded and installed, if necessary.
101
102.TP
103.BI \-username USERNAME
104Set username for transports that require authentification.
105
106.TP
107.BI \-password PASSWORD
108Set password for transports that require authentification.
109
110.SH ENVIRONMENT\ VARIABLES
111
112.TP
113.B CHICKEN_PREFIX
114The installation prefix where CHICKEN Scheme and its support files and
115libraries are located. Defaults to the installation time prefix given
116when configuring the system.
117
118.TP
119.B CHICKEN_INSTALL_PREFIX
120An alternative installation prefix that will be prepended to extension
121installation paths if specified.
122
123.TP
124.B CHICKEN_REPOSITORY
125The path where extension libraries are installed. Defaults to the package-library
126path selected during configuration (usually
127.B $prefix/lib/chicken/<binary\-version>
128)
129
130
131.SH DOCUMENTATION
132
133More information can be found in the
134.I Chicken\ User's\ Manual
135
136.SH BUGS
137Submit bug reports by e-mail to
138.I chicken-janitors@nongnu.org
139, preferrably using the
140.B chicken\-bug
141tool.
142
143.SH AUTHORS
144The Chicken Team
145
146.SH SEE ALSO
147.BR chicken-uninstall(1)
148.BR chicken-status(1)
149.BR chicken(1)
150.BR csc(1)
151.BR chicken-bug(1)
Note: See TracBrowser for help on using the repository browser.