source: project/wiki/eggref/5/chicken-belt @ 36801

Last change on this file since 36801 was 36801, checked in by evhan, 13 months ago

wiki/eggref: update docs/formatting/urls and eggref/5/{r7rs,fancypants,chicken-belt}

File size: 6.0 KB
Line 
1[[tags: egg]]
2
3== chicken-belt
4
5A utility belt to make the Chicken hacker's life easier.
6
7[[toc:]]
8
9== Overview
10
11{{chicken-belt}} currently includes three programs:
12
13; {{chicken-select}}, {{chicken-build}} : These programs can be used to manage a repository of Chicken installations pointed to by the environment variable {{CHICKENS}} ({{~/chickens}} by default) referred to as ''coop''. Each installation resides in a sub-directory of {{CHICKENS}}. 
14; {{chicken-hatch}} : This program helps with hatching new eggs.
15
16== chicken-select
17
18This program is used to select a Chicken installation from your
19coop. It will present you with a list of available Chickens indexed by
20number. The currently selected Chicken (if any) is highlighted by a
21leading arrow ({{->}}). Selecting an installation by index will create
22a symlink for its directory to {{$CHICKENS/use-this}}. Alternatively
23you can pass the name of a Chicken version as an argument to
24{{chicken-select}} in order to select it (available since version
250.0.8). For convenience, place {{$CHICKENS/use-this/bin}} in your
26{{PATH}} to have the currently selected Chicken readily available.
27
28=== Available Options
29
30; -v : verbose mode; displays additional information about the Chickens in the coop
31
32=== Author
33
34Christian Kellermann
35
36
37== chicken-build
38
39This program is used to conveniently build a Chicken from source and
40install it to your coop. The only required argument is the name for
41the Chicken installation. It will be used as the sub-directory name in
42your coop and must be given as the last argument of the command
43line. The resulting path will then be set as the {{PREFIX}} when
44{{make}} and {{make install}} are excuted. Note that you can set any
45other environment variables to {{make}} by just setting them when
46running {{chicken-build}}. In fact, you still ''have'' to set the
47{{PLATFORM}} variable this way (see the example below).
48
49=== Available Options
50
51; -b, --bootstrap : build and use a bootstrap Chicken compiler, i.e. run {{make boot-chicken}} and set {{CHICKEN=./chicken-boot}} for the remainig build process.
52; -c, --chicken CHICKEN_NAME : use $CHICKENS/CHICKEN_NAME/bin/chicken for compiling; when passed together with {{-b}}, it will be used for  {{make boot-chicken}} only (the latter is possible since version 0.0.10)
53; -n, --no-spotless : don't run make spotless before building
54; -t, --test : test the build after installation via {{make check}} (available since version 0.0.10)
55; -d, --debug : make a debug build, i.e. set {{DEBUGBUILD=1}}
56; -h, --help : show help
57
58=== Example
59
60  tar zxf chicken-4.7.0.tar.gz
61  cd chicken-4.7.0
62  PLATFORM=linux chicken-build -b 4.7.0
63
64This will build Chicken 4.7.0 for Linux using a bootstrap
65compiler. The result will be installed to {{$CHICKEN/4.7.0}},
66i.e. {{~/chickens/4.7.0}} by default. The build sequence executed by
67this {{chicken-build}} incantation is:
68
69  make PLATFORM=linux spotless
70  make PLATFORM=linux boot-chicken
71  make PLATFORM=linux spotless
72  make PLATFORM=linux CHICKEN=./chicken-boot PREFIX=$CHICKENS/4.7.0
73  make PLATFORM=linux CHICKEN=./chicken-boot PREFIX=$CHICKENS/4.7.0 install
74
75Alternatively, without bootstrap compiler:
76
77  PLATFORM=linux chicken-build 4.7.0
78
79Executes:
80
81  make PLATFORM=linux spotless
82  make PLATFORM=linux PREFIX=$CHICKENS/4.7.0
83  make PLATFORM=linux PREFIX=$CHICKENS/4.7.0 install
84
85
86=== Updating an installation
87
88If you want to update a version that you have previously installed with chicken-build, all you have to do is run chicken-build in the
89new directory with the name of the build you want to update. You will be asked if you want to purge the previous installation. It's safe to answer yes here, since '''it will only purge the old installation if the new version has been built successfully'''.
90
91=== Author
92
93Moritz Heidkamp
94
95
96== chicken-hatch
97
98The {{chicken-hatch}} program helps you to hatch new eggs. The only
99mandatory command line option is the egg's name, everything else will
100be prompted for. The functionality is currently very limited but it
101will hopefully be improved in the near future. This program has been
102included in chicken-belt since version 0.0.6.
103
104=== Usage
105
106  chicken-hatch [OPTIONS] egg-name
107
108If you don't know what categories are available or which license to choose, you might want to invoke {{chicken-hatch}} without any ''options''. It will then prompt you interactively for the needed information.
109
110=== Available Options
111
112; -c, --category : the egg's category
113; -l, --license : the license the egg can be copied and used under
114; -h, --help : show help
115
116=== Author
117
118Moritz Heidkamp
119
120== License
121
122 Copyright (c) 2011-2018, Christian Kellermann, Moritz Heidkamp
123 All rights reserved.
124 
125 Redistribution and use in source and binary forms, with or without
126 modification, are permitted provided that the following conditions are
127 met:
128 
129 Redistributions of source code must retain the above copyright
130 notice, this list of conditions and the following disclaimer.
131 
132 Redistributions in binary form must reproduce the above copyright
133 notice, this list of conditions and the following disclaimer in the
134 documentation and/or other materials provided with the distribution.
135 
136 Neither the name of the author nor the names of its contributors may
137 be used to endorse or promote products derived from this software
138 without specific prior written permission.
139 
140 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
141 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
142 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
143 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
144 COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
145 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
146 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
147 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
148 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
149 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
150 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
151 OF THE POSSIBILITY OF SUCH DAMAGE.
Note: See TracBrowser for help on using the repository browser.