chicken-install(1)

1CHICKEN-INSTALL(1)        BSD General Commands Manual       CHICKEN-INSTALL(1)
2

NAME

4     chicken-install — download and install extension libraries for CHICKEN
5     Scheme
6

SYNOPSIS

8     chicken-install [OPTION ...] [NAME[:VERSION] ...]
9

DESCRIPTION

11     chicken-install downloads, compiles and installs a prepackaged extension
12     library from sources.  If no extension name is given on the command line,
13     then any existing egg descriptions in the current directory will be exe‐
14     cuted in unspecified order.
15
16     The program accepts following arguments:
17
18     -h, -help
19             Show usage and exit.
20
21     -version
22             Show version and exit.
23
24     -v, -verbose
25             Print extra information during installation.
26
27     -force  Install without confirmation, even if versions don't match.
28
29     -k, -keep
30             Keep temporary files.
31
32     -s, -sudo
33             Use an external program to elevate privileges for filesystem op‐
34             erations.  The program defaults to sudo(8) but can be overridden
35             with the SUDO environment variable.
36
37     -r, -retrieve
38             Just retrieve the egg, don't install it (giving -r more than once
39             implies -recursive).
40
41     -recursive
42             If -retrieve is given, also fetch dependencies recursively.
43
44     -dry-run
45             Do not build or install, just print the locations of the gener‐
46             ated build & install scripts.
47
48     -list-versions
49             List available versions for the given eggs.
50
51     -purge  Remove cached files for given eggs (or purge cache completely).
52
53     -host   When cross-compiling, only compile extensions for host.
54
55     -target
56             When cross-compiling, only compile extensions for target.
57
58     -test   Run included test cases, if available.
59
60     -n, -no-install
61             Do not install the egg, just build it.
62
63     -no-install-dependencies
64             Do not install dependencies. Note that this option may result in
65             build failures due to missing extension libraries.
66
67     -u, -update-db
68             Update export database.
69
70     -repository
71             Print path used for egg installation.
72
73     -override filename
74             Override versions for installed eggs with information from
75             filename.
76
77     -from-list filename
78             Install eggs listed in filename, which has the same format as
79             chicken-status(1)'s -list output. This option may be given multi‐
80             ple times.
81
82     -cached
83             Install given eggs from cache and do not download.
84
85     -feature, -D name
86             Register feature name, usable as a condition in cond-expand
87             clauses.
88

ENVIRONMENT

90     Following environment variables change the behaviour of chicken-install:
91
92     CHICKEN_EGG_CACHE           Location where eggs are retrieved and built.
93
94     CHICKEN_INSTALL_REPOSITORY  The path where extension libraries are in‐
95                                 stalled. Defaults to the package library path
96                                 selected during configuration (usually
97                                 $prefix/lib/chicken/<binary-version>).
98
99     SUDO                        The command to execute when using -s flag in
100                                 command. If not provided, defaults to
101                                 sudo(8).
102

FILES

104     $XDG_CONFIG_HOME/chicken/setup.defaults
105           User specific setup.defaults file. ( $XDG_CONFIG_HOME defaults to
106           $HOME/.config )
107
108     $prefix/share/chicken/setup.default
109           System-wide setup.defaults file.
110
111     $XDG_CACHE_HOME/chicken-install/
112           Default directory for cached eggs. ( $XDG_CACHE_HOME defaults to
113           $HOME/.cache )
114

EXIT STATUS

116     The chicken-install utility exits 0 on success, 2 if the user aborted an
117     operation, 3 if it was invoked with no explicitly given egg names and no
118     *.egg files could be found in the current directory, and >0 if any other
119     error occurs.
120

EXAMPLES

122     Install ‘regex’ egg as root user:
123
124           # chicken-install regex
125
126     Install an egg as an normal user but using sudo(8):
127
128           $ chicken-install -s regex
129
130     Install an egg as an normal user but elevating privileges with different
131     program, such as OpenBSD doas(1):
132
133           $ SUDO=/usr/bin/doas chicken-install -s regex
134

AUTHORS

142     The CHICKEN Team
143

BUGS

145     Submit bug reports by e-mail to chicken-janitors@nongnu.org
146
147BSD                              Apr 26, 2017                              BSD