tazlito view doc/tazlito.en.html @ rev 128
Update English manual for writeiso and frugal-install
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Fri Jan 22 17:39:58 2010 +0100 (2010-01-22) |
| parents | bb333e7cd912 |
| children | 8fc82b57300a |
line source
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <title>Tazlito Manual - SliTaz Live Tool</title>
6 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
7 <meta name="description" content="" />
8 <meta name="expires" content="never" />
9 <meta name="modified" content="2008-07-18 14:00:00" />
10 <style type="text/css"><!--
11 body { font: 90% sans-serif, vernada, arial; margin: 0; }
12 #header { background: #f0ba08; color: black; height: 50px;
13 border-top: 1px solid black; border-bottom: 1px solid black; }
14 #content { margin: 0px 50px 26px 50px; }
15 h1 { margin: 14px 0px 0px 16px; }
16 li { line-height: 1.4em; }
17 pre { padding: 5px; color: black; background: #e1e0b0; }
18 pre.script { padding: 10px; color: black; background: #e8e8e8;
19 border: 1px inset #333333; }
20 code { font-size: 100%; color: #669900; background: transparent; }
21 hr { color: white; background: white; height: 1px; border: 0; }
22 --></style>
23 </head>
24 <body bgcolor="#ffffff">
25 <div id="header">
26 <h1><font color="#3e1220">Tazlito Manual</font></h1>
27 </div>
28 <hr />
29 <!-- Start content -->
30 <div id="content">
32 <h2>NAME</h2>
33 <p>
34 Tazlito - SliTaz Live Tool.
35 </p>
37 <h2>SYNTAX</h2>
38 <pre>
39 tazlito [command] [list|iso|flavor] [dir]
40 </pre>
42 <h2>DESCRIPTION</h2>
43 <p>
44 Tazlito is a small utility to extract a LiveCD, rebuild the
45 ISO image and regenerate the root filesystem of the LiveCD.
46 Tazlito can also generate a distribution from a list of packages
47 previously downloaded. To run, Tazlito uses the configuration file
48 /etc/slitaz-tools/tazlito.conf or a tazlito.conf found in the
49 current directory that can be easily generated.
50 It specifies the name of the ISO, volume, maintainer and
51 the paths of the packages to distribute and the generated ISO.
52 Tazlito can also set up a directory containing additional files
53 which will be copied to the LiveCD when generating the distribution.
54 </p>
55 <p>
56 Tazlito is distributed under the free GNU licence GPL V3,
57 installed by default on SliTaz and installed/sucessfully tested
58 on Debian GNU/Linux. You will find additional information
59 about creating a LiveCD in the Handbook.
60 </p>
62 <h2>COMMANDS</h2>
64 <a name="usage"></a>
65 <h3><font color="#6c0023">usage</font></h3>
66 <p>
67 The 'usage' command displays a summary of available commands
68 with a short description:
69 </p>
70 <pre>
71 # tazlito usage
72 </pre>
74 <a name="stats"></a>
75 <h3><font color="#6c0023">stats</font></h3>
76 <p>
77 Stats displays the configuration variables, the paths to the
78 various files and directories, and information on the ISO image:
79 </p>
80 <pre>
81 # tazlito stats
82 </pre>
84 <a name="gen-config"></a>
85 <h3><font color="#6c0023">gen-config</font></h3>
86 <p>
87 The 'gen-config' command allows you to generate a configuration
88 file ready to be edited. By default the file is created in
89 the current directory, but can be in another directory
90 if specified via the command line:
91 </p>
92 <pre>
93 # tazlito gen-config
94 # tazlito gen-config /path/to/distro
95 </pre>
97 <a name="configure"></a>
98 <h3><font color="#6c0023">configure</font></h3>
99 <p>
100 This command configures the system configuration
101 file or one found in the current directory:
102 </p>
103 <pre>
104 # tazlito configure
105 </pre>
107 <a name="gen-iso"></a>
108 <h3><font color="#6c0023">gen-iso</font></h3>
109 <p>
110 The 'gen-iso' command can generate a
111 new LiveCD image following modifications and additions to the
112 root filesystem of the cdrom. To function, this command needs
113 a directory containing the distro-tree of the Live system.
114 This tree can easily be built with the 'extract-distro' command,
115 modified and rebuilt via:
116 </p>
117 <pre>
118 # tazlito gen-iso
119 </pre>
121 <a name="gen-initiso"></a>
122 <h3><font color="#6c0023">gen-initiso</font></h3>
123 <p>
124 The 'gen'initso' command will do the same work as 'gen-iso',
125 but it rebuilds the initramfs compressed system prior.
126 The initramfs contains the root filesystem and
127 must be rebuilt if modified:
128 </p>
129 <pre>
130 # tazlito gen-initiso
131 </pre>
133 <a name="list-flavors"></a>
134 <h3><font color="#6c0023">list-flavors</font></h3>
135 <p>
136 The 'list-flavors' command downloads (if necessary) and displays
137 a list of the different flavors available. You can force the
138 download with the --recharge option:
139 </p>
140 <pre>
141 # tazlito list-flavors
142 # tazlito list-flavors --recharge
143 </pre>
145 <a name="get-flavors"></a>
146 <h3><font color="#6c0023">get-flavor</font></h3>
147 <p>
148 The 'get-flavor' command downloads (if necessary) and prepares the
149 files for 'gen-distro' to generate a flavor:
150 </p>
151 <pre>
152 # tazlito get-flavor particular-flavor
153 </pre>
155 <a name="show-flavors"></a>
156 <h3><font color="#6c0023">show-flavor</font></h3>
157 <p>
158 The 'show-flavor' command displays the description of the
159 flavor and its size after regeneration. The options
160 --brief and --noheader reduce the output displayed:
161 </p>
162 <pre>
163 # tazlito show-flavor particular-flavor
164 # tazlito show-flavor particular-flavor --brief
165 # tazlito show-flavor particular-flavor --brief --noheader
166 </pre>
168 <a name="gen-flavor"></a>
169 <h3><font color="#6c0023">gen-flavor</font></h3>
170 <p>
171 The 'gen-flavor' command creates a description file of a new
172 flavor from the results of generating a distro (gen-distro).
173 The .flavor file can then be sent to slitaz.org:
174 </p>
175 <pre>
176 # tazlito gen-flavor new-flavor
177 </pre>
179 <a name="gen-liveflavor"></a>
180 <h3><font color="#6c0023">gen-liveflavor</font></h3>
181 <p>
182 The 'gen-liveflavor' command creates a description file of a new
183 flavor from the results of generating a distro based on the
184 current system. The --help option provides more information:
185 </p>
186 <pre> # tazlito gen-liveflavor
187 # tazlito gen-liveflavor --help
188 </pre>
190 <a name="extract-distro"></a>
191 <h3><font color="#6c0023">extract-distro</font></h3>
192 <p>
193 The 'extract-distro' command is used to extract an ISO image
194 from the LiveCD to rebuild the structure of the root cdrom
195 and system. It is then possible to make the desired changes
196 or additions and rebuild the ISO image via 'gen-iso' or
197 'gen-initiso'. Example of use:
198 </p>
199 <pre>
200 # tazlito extract-distro slitaz-cooking.iso
201 </pre>
203 <a name="gen-distro"></a>
204 <h3><font color="#6c0023">gen-distro</font></h3>
205 <p>
206 The <em>Generate Distribution</em> command can generate the
207 distro-tree and an ISO image via a list of packages. To function,
208 this command needs a list of packages, a directory containing
209 all the (.tazpkg) packages on the list, and a directory to
210 generate the distribution. The list of packages can be extracted
211 from a flavor by the 'get-flavor' command. If one uses the
212 LiveCD, the options --cdrom and --iso= permit the regeneration
213 of packages that place files in /boot without being obliged
214 to download them and recovers the additional files of the
215 LiveCD. The path to the various directories are configured
216 in the configuration file and packages can be downloaded
217 from the SliTaz mirrors or generated by Tazwok. To generate
218 a distribution:
219 </p>
220 <pre>
221 # tazlito gen-distro
222 # tazlito gen-distro --cdrom
223 # tazlito gen-distro --iso=slitaz.iso
224 # tazlito gen-distro package-list
225 </pre>
227 <a name="clean-distro"></a>
228 <h3><font color="#6c0023">clean-distro</font></h3>
229 <p>
230 Removes all files generated or extracts of the structure
231 of the LiveCD:
232 </p>
233 <pre>
234 # tazlito clean-distro
235 </pre>
237 <a name="check-distro"></a>
238 <h3><font color="#6c0023">check-distro</font></h3>
239 <p>
240 This command simply verifies if files installed
241 by the packages are present on the system:
242 </p>
243 <pre>
244 # tazlito check-distro
245 </pre>
247 <a name="writeiso"></a>
248 <h3><font color="#6c0023">writeiso</font></h3>
249 <p>
250 This command will write all the current filesystem to a cpio archive
251 (rootfs.gz) and then generate a bootable ISO image. Writeiso can be use in
252 live mode or HD install and will also archive your current /home direcory.
253 This command let you easily remaster and build your own LiveCD image, just
254 boot, modify whatever you want and then:
255 </p>
256 <pre>
257 # tazlito writeiso [gzip|lzma|none]
258 # tazlito writeiso gzip
259 # tazlito writeiso gzip image-name
260 </pre>
262 <a name="frugal-install"></a>
263 <h3><font color="#6c0023">Fragal install</font></h3>
264 <p>
265 Perfom a Frugal installation into /boot/frugal and add GRUB entry if needed.
266 Frugal mode will make SliTaz work all in memory (RAM), useful to test distro
267 without burning ISO or to have a rescue system ready to use when computer power
268 on. To install all needed files from a distro tree or an ISO image:
269 </p>
270 <pre>
271 # tazlito frugal-install
272 # tazlito -fi slitaz.iso
273 </pre>
275 <a name="emu-iso"></a>
276 <h3><font color="#6c0023">emu-iso</font></h3>
277 <p>
278 The emu-iso command uses the Qemu emulator to start and run SliTaz.
279 Qemu is used to test the newly built ISO image without burning to a
280 cdrom or booting into frugal mode.
281 </p>
282 <pre>
283 # tazlito emu-iso
284 # tazlito emu-iso path/to/image.iso
285 </pre>
287 <a name="burn-iso"></a>
288 <h3><font color="#6c0023">burn-iso</font></h3>
289 <p>
290 Burn-iso will guess the cdrom device and its speed, and wodim
291 (part of cdrkit) will begin to burn an ISO image. The default
292 ISO image is the one in the current configuration file,
293 but it's possible to specify a different image via the
294 command line:
295 </p>
296 <pre>
297 # tazlito burn-iso
298 # tazlito burn-iso slitaz-hacked.iso
299 </pre>
301 <h2>MAINTAINER</h2>
302 <p>
303 Christophe Lincoln <pankso at slitaz.org>
304 </p>
306 <!-- End content -->
307 </div>
308 </body>
309 </html>