rev |
line source |
al@412
|
1 .TH TazLiTo "1" "29.01.2016"
|
al@412
|
2 .SH NAME
|
al@412
|
3 Tazlito \(em SliTaz Live Tool.
|
al@412
|
4 .SH SYNTAX
|
al@412
|
5 .nf
|
al@412
|
6 .RI "tazlito [" command "] [" list | iso | flavor "] [" dir ]
|
al@412
|
7 .fi
|
al@412
|
8 .SH DESCRIPTION
|
al@412
|
9 Tazlito is a small utility to extract a Live CD, rebuild the ISO image and
|
al@412
|
10 regenerate the root filesystem of the Live CD. Tazlito can also generate a
|
al@412
|
11 distribution from a list of packages previously downloaded. Tazlito uses the
|
al@412
|
12 configuration file
|
al@412
|
13 .IR tazlito.conf (5).
|
al@412
|
14 .PP
|
al@412
|
15 Tazlito installed by default on SliTaz and installed/successfully tested on
|
al@412
|
16 Debian GNU/Linux. You will find additional information about creating a LiveCD
|
al@412
|
17 in the Handbook.
|
al@412
|
18 .SH COMMANDS
|
al@412
|
19 .SS usage
|
al@412
|
20 Display a summary of available commands with a short description.
|
al@412
|
21 .nf
|
al@412
|
22 $ tazlito usage
|
al@412
|
23 .fi
|
al@412
|
24 .SS stats
|
al@412
|
25 Display the configuration variables, the paths to the various files and
|
al@412
|
26 directories, and information on the ISO image.
|
al@412
|
27 .nf
|
al@412
|
28 $ tazlito stats
|
al@412
|
29 .fi
|
al@412
|
30 .SS list-addfiles
|
al@412
|
31 Display the list of additional files in the rootfs.
|
al@412
|
32 .nf
|
al@412
|
33 $ tazlito list-addfiles
|
al@412
|
34 .fi
|
al@412
|
35 .SS gen-config
|
al@412
|
36 Generate a configuration file ready to be edited.
|
al@412
|
37 .PP
|
al@412
|
38 By default the file is created in the current directory, but can be in another
|
al@412
|
39 directory if specified via the command line.
|
al@412
|
40 .nf
|
al@412
|
41 $ tazlito gen-config
|
al@412
|
42 $ tazlito gen-config \fI/path/to/distro\fR
|
al@412
|
43 .fi
|
al@412
|
44 .SS configure
|
al@412
|
45 Configure the system configuration file or one found in the current directory.
|
al@412
|
46 .PP
|
al@412
|
47 You will be asked for ISO name, volume name, paths to packages repository and
|
al@412
|
48 to distro.
|
al@412
|
49 .nf
|
al@412
|
50 # tazlito configure
|
al@412
|
51 .fi
|
al@412
|
52 .SS gen-iso
|
al@412
|
53 Generate a new Live CD image following modifications and additions to the root
|
al@412
|
54 filesystem of the CD-ROM.
|
al@412
|
55 .PP
|
al@412
|
56 To function, this command needs a directory containing the distro-tree of the
|
al@412
|
57 Live system. This tree can easily be built with the
|
al@412
|
58 .B extract-distro
|
al@412
|
59 command, modified and rebuilt via:
|
al@412
|
60 .nf
|
al@412
|
61 # tazlito gen-iso
|
al@412
|
62 .fi
|
al@412
|
63 .SS gen-initiso
|
al@412
|
64 The same as
|
al@412
|
65 .BR gen-iso ,
|
al@412
|
66 but it rebuilds the initramfs compressed system prior.
|
al@412
|
67 .PP
|
al@412
|
68 The initramfs contains the root filesystem and must be rebuilt if modified.
|
al@412
|
69 .nf
|
al@412
|
70 # tazlito gen-initiso
|
al@412
|
71 .fi
|
al@412
|
72 .SS list-flavors
|
al@412
|
73 Download (if necessary) and display a list of the different flavors available.
|
al@412
|
74 .PP
|
al@412
|
75 You can force the download with the
|
al@412
|
76 .I --recharge
|
al@412
|
77 option.
|
al@412
|
78 .nf
|
al@412
|
79 $ tazlito list-flavors
|
al@412
|
80 # tazlito list-flavors --recharge
|
al@412
|
81 .fi
|
al@412
|
82 .SS get-flavor
|
al@412
|
83 Download (if necessary) and prepares the files for
|
al@412
|
84 .B gen-distro
|
al@412
|
85 to generate an ISO image.
|
al@412
|
86 .PP
|
al@412
|
87 Option
|
al@412
|
88 .I --noup
|
al@412
|
89 can be used to skip updating flavor (see
|
al@412
|
90 .B upgrade-flavor
|
al@412
|
91 command).
|
al@412
|
92 .nf
|
al@412
|
93 # tazlito get-flavor \fIcore\fR
|
al@412
|
94 .fi
|
al@412
|
95 .SS show-flavor
|
al@412
|
96 Display the description of the flavor and its size after regeneration.
|
al@412
|
97 .PP
|
al@412
|
98 The options
|
al@412
|
99 .IR --brief " and " --noheader
|
al@412
|
100 reduce the output displayed.
|
al@412
|
101 .nf
|
al@412
|
102 $ tazlito show-flavor \fIbase\fR
|
al@412
|
103 $ tazlito show-flavor \fIjustx\fR --brief
|
al@412
|
104 $ tazlito show-flavor \fIcore\fR --brief --noheader
|
al@412
|
105 .fi
|
al@412
|
106 .SS gen-flavor
|
al@412
|
107 Create a description file of a new flavor from the results of generating a
|
al@412
|
108 distro
|
al@412
|
109 .RB ( gen-distro ).
|
al@412
|
110 The
|
al@412
|
111 .I .flavor
|
al@412
|
112 file can then be sent to slitaz.org.
|
al@412
|
113 .nf
|
al@412
|
114 # tazlito gen-flavor \fInew-flavor\fR
|
al@412
|
115 .fi
|
al@412
|
116 .SS gen-liveflavor
|
al@412
|
117 Create a description file of a new flavor from the results of generating a
|
al@412
|
118 distro based on the current system.
|
al@412
|
119 .PP
|
al@412
|
120 The
|
al@412
|
121 .I --help
|
al@412
|
122 option provides more information.
|
al@412
|
123 .nf
|
al@412
|
124 # tazlito gen-liveflavor --help
|
al@412
|
125 # tazlito gen-liveflavor \fIflavor-name\fR
|
al@412
|
126 # tazlito gen-liveflavor \fIflavor-name flavor-patch-file\fR
|
al@412
|
127 .fi
|
al@412
|
128 Format of the flavor-patch-file:
|
al@412
|
129 .TS
|
al@412
|
130 c l.
|
al@412
|
131 \fBcode\fR \fBdata\fR
|
al@412
|
132 _
|
al@412
|
133 @ flavor description
|
al@412
|
134 + package to add
|
al@412
|
135 - package to remove
|
al@412
|
136 ! non-free package to add
|
al@412
|
137 ? display message
|
al@412
|
138 .TE
|
al@412
|
139 Example:
|
al@412
|
140 .nf
|
al@412
|
141 @ Developer tools for SliTaz maintainers
|
al@412
|
142 + slitaz-toolchain
|
al@412
|
143 + mercurial
|
al@412
|
144 .fi
|
al@412
|
145 .SS iso2flavor
|
al@412
|
146 Create a flavor file from the ISO image.
|
al@412
|
147 .nf
|
al@412
|
148 # tazlito iso2flavor \fIslitaz-cooking.iso mycooking\fR
|
al@412
|
149 .fi
|
al@412
|
150 .SS upgrade-flavor
|
al@412
|
151 Refresh a flavor description file. Sizes and actual number of packages will be
|
al@412
|
152 re-calculated. List of unknown packages will be displayed if any, as well as
|
al@412
|
153 list of important packages missed in the flavor (like
|
al@412
|
154 .BR syslinux " or " linux ).
|
al@412
|
155 Packages versions (presented in the legacy flavor format) will be stripped from
|
al@412
|
156 the flavor package list.
|
al@412
|
157 .nf
|
al@412
|
158 # tazlito upgrade-flavor \fIcore\fR
|
al@412
|
159 .fi
|
al@412
|
160 .SS extract-flavor
|
al@412
|
161 Convert a flavor into an easily modifiable tree structure. Path to the
|
al@412
|
162 extracted flavors repository specified by variable
|
al@412
|
163 .I FLAVORS_REPOSITORY
|
al@412
|
164 in the tazlito.conf(5) (by default
|
al@412
|
165 .IR /home/slitaz/cooking/flavors ).
|
al@412
|
166 .PP
|
al@412
|
167 This repository can be managed with mercurial: http://hg.slitaz.org/flavors .
|
al@412
|
168 .nf
|
al@412
|
169 # tazlito extract-flavor \fIcore\fR
|
al@412
|
170 .fi
|
al@412
|
171 .SS pack-flavor
|
al@412
|
172 Convert a tree structure, extracted by
|
al@412
|
173 .B extract-flavor
|
al@412
|
174 into a flavor file
|
al@412
|
175 .RI ( .flavor ).
|
al@412
|
176 .nf
|
al@412
|
177 # tazlito pack-flavor \fIcore\fR
|
al@412
|
178 .fi
|
al@412
|
179 Execute this command after changing existing flavor, or after preparing new
|
al@412
|
180 flavor. File
|
al@412
|
181 .I packages.list
|
al@412
|
182 inside flavor tree structure can contain include directive at the beginning,
|
al@412
|
183 for example:
|
al@412
|
184 .nf
|
al@412
|
185 @include \fIjustx\fR
|
al@412
|
186 .fi
|
al@412
|
187 to include all the packages listed in the
|
al@412
|
188 .I justx
|
al@412
|
189 flavor.
|
al@412
|
190 .SS extract-distro
|
al@412
|
191 Extract an ISO image from the Live CD to rebuild the structure of the root
|
al@412
|
192 CD-ROM and system. It is then possible to make the desired changes or additions
|
al@412
|
193 and rebuild the ISO image via
|
al@412
|
194 .BR gen-iso " or " gen-initiso .
|
al@412
|
195 .PP
|
al@412
|
196 ISO image is extracted by default to the path specified by variable
|
al@412
|
197 .I DISTRO
|
al@412
|
198 in the tazlito.conf(5). Desired path may be specified in the second argument.
|
al@412
|
199 .nf
|
al@412
|
200 # tazlito extract-distro \fI/tmp/slitaz-cooking.iso\fR
|
al@412
|
201 # tazlito extract-distro \fI/tmp/slitaz-cooking.iso\fR \fI/tmp/extracted\fR
|
al@412
|
202 .fi
|
al@412
|
203 .SS gen-distro
|
al@412
|
204 Generate the distro-tree and an ISO image via a list of packages.
|
al@412
|
205 .PP
|
al@412
|
206 To function, this command needs a list of packages and other files provided by
|
al@412
|
207 command
|
al@412
|
208 .BR get-flavor .
|
al@412
|
209 List is expected to be the file
|
al@412
|
210 .I distro-packages.list
|
al@412
|
211 in the current directory, or can be specified in the command argument.
|
al@412
|
212 If package list not given, new list
|
al@412
|
213 .I distro-packages.list
|
al@412
|
214 will be re-created in the current directory using all currently installed
|
al@412
|
215 packages.
|
al@412
|
216 .PP
|
al@412
|
217 If one uses the Live CD, the options
|
al@412
|
218 .IR --cdrom " and " --iso=
|
al@412
|
219 allows the regeneration of packages that place files in
|
al@412
|
220 .I /boot
|
al@412
|
221 without being obliged to download them and recovers the additional files of the
|
al@412
|
222 Live CD.
|
al@412
|
223 .PP
|
al@412
|
224 The path to the various directories are configured in the tazlito.conf(5)
|
al@412
|
225 and packages can be downloaded from the SliTaz mirrors or generated by
|
al@412
|
226 Cookutils.
|
al@412
|
227 .nf
|
al@412
|
228 # tazlito gen-distro
|
al@412
|
229 # tazlito gen-distro --cdrom
|
al@412
|
230 # tazlito gen-distro --iso=\fIslitaz.iso\fR
|
al@412
|
231 # tazlito gen-distro \fIpackage-list\fR
|
al@412
|
232 .fi
|
al@412
|
233 .SS clean-distro
|
al@412
|
234 Remove all files generated or extracts of the structure of the LiveCD.
|
al@412
|
235 .nf
|
al@412
|
236 # tazlito clean-distro
|
al@412
|
237 .fi
|
al@412
|
238 .SS check-distro
|
al@412
|
239 Verify few configuration files in the generated rootfs
|
al@412
|
240 .RI ( /etc/slitaz-release ", " /var/lib/tazpkg/mirror ,
|
al@412
|
241 .IR /boot/isolinux/isolinux.cfg ).
|
al@412
|
242 .PP
|
al@412
|
243 .B TODO:
|
al@412
|
244 Remove this function. First two files are maintained by tazpkg while it runs on
|
al@412
|
245 rootfs, while last one file should be maintained by tazlito itself.
|
al@412
|
246 .nf
|
al@412
|
247 # tazlito check-distro
|
al@412
|
248 .fi
|
al@412
|
249 .SS writeiso
|
al@412
|
250 Write the current filesystem to a cpio archive
|
al@412
|
251 .RI ( rootfs.gz )
|
al@412
|
252 and then generate a bootable ISO image. Writeiso can be used in a HD install or
|
al@412
|
253 in live mode and will also archive your current
|
al@412
|
254 .I /home
|
al@412
|
255 directory.
|
al@412
|
256 .PP
|
al@412
|
257 This command lets you easily remaster and build your own Live CD image, just
|
al@412
|
258 boot, modify any files, and then:
|
al@412
|
259 .nf
|
al@412
|
260 # tazlito writeiso [gzip|lzma|none]
|
al@412
|
261 # tazlito writeiso gzip
|
al@412
|
262 # tazlito writeiso gzip \fIimage-name\fR
|
al@412
|
263 .fi
|
al@412
|
264 .SS repack
|
al@412
|
265 Recompress the rootfs with the best possible compression.
|
al@412
|
266 .nf
|
al@412
|
267 # tazlito repack \fIslitaz.iso\fR
|
al@412
|
268 .fi
|
al@412
|
269 .SS merge
|
al@412
|
270 Combine several flavors like nested Russian dolls. Each rootfs is a subset of
|
al@412
|
271 the previous. The first rootfs is extracted from the ISO image used in the
|
al@412
|
272 third argument. The flavor will then be chosen to launch at startup according
|
al@412
|
273 to the amount of RAM available.
|
al@412
|
274 .nf
|
al@412
|
275 # tazlito merge \fI160M slitaz-core.iso 96M rootfs-justx.gz 32M rootfs-base.gz\fR
|
al@412
|
276 .fi
|
al@412
|
277 .SS build-loram
|
al@412
|
278 Create an ISO image flavor for low RAM systems from a SliTaz ISO image. You can
|
al@412
|
279 build a flavor with
|
al@412
|
280 .I /
|
al@412
|
281 always in RAM or where
|
al@412
|
282 .I /
|
al@412
|
283 resides on the CD-ROM:
|
al@412
|
284 .nf
|
al@412
|
285 # tazlito build-loram \fIslitaz.iso loram.iso\fR
|
al@412
|
286 # tazlito build-loram \fIslitaz.iso loram-cdrom.iso\fR cdrom
|
al@412
|
287 .fi
|
al@412
|
288 Third argument can be one of the:
|
al@412
|
289 .TP
|
al@412
|
290 .I cdrom
|
al@412
|
291 Move rootfs to squashfs filesystem(s) to the CD-ROM writeable with
|
al@412
|
292 aufs/overlayfs. These squashfs may be loaded in RAM at boot time. Rootfs are also
|
al@412
|
293 copied to CD-ROM for tiny ramsize systems. Meta flavors are converted to normal
|
al@412
|
294 flavors.
|
al@412
|
295 .TP
|
al@412
|
296 .I smallcdrom
|
al@412
|
297 TODO.
|
al@412
|
298 .TP
|
al@412
|
299 .I http
|
al@412
|
300 Create http bootstrap to load and remove loram_cdrom. Meta flavors are converted
|
al@412
|
301 to normal flavors.
|
al@412
|
302 .TP
|
al@412
|
303 .I ram
|
al@412
|
304 Move rootfs to a squashfs filesystem into the initramfs writeable with
|
al@412
|
305 aufs/overlayfs. Meta flavor selection sizes are updated.
|
al@412
|
306 .SS emu-iso
|
al@412
|
307 Use the QEMU emulator to start and run SliTaz.
|
al@412
|
308 .PP
|
al@412
|
309 QEMU is used to test the newly built ISO image without burning to a CD-ROM or
|
al@412
|
310 booting into frugal mode.
|
al@412
|
311 .nf
|
al@412
|
312 # tazlito emu-iso
|
al@412
|
313 # tazlito emu-iso path/to/image.iso
|
al@412
|
314 .fi
|
al@412
|
315 .SS burn-iso
|
al@412
|
316 Burn an ISO image guessing the CD-ROM device and its speed.
|
al@412
|
317 .PP
|
al@412
|
318 The default ISO image is the one located in the current configuration file, but
|
al@412
|
319 it's possible to specify a different image via the command line:
|
al@412
|
320 .nf
|
al@412
|
321 # tazlito burn-iso
|
al@412
|
322 # tazlito burn-iso \fIslitaz-hacked.iso\fR
|
al@412
|
323 .fi
|
al@412
|
324 .SH LICENSE
|
al@412
|
325 Tazlito is free software; you can redistribute it and/or modify it under the
|
al@412
|
326 terms of the GNU General Public License as published by the Free Software
|
al@412
|
327 Foundation; either version 3 of the License, or (at your option) any later
|
al@412
|
328 version.
|
al@412
|
329 .PP
|
al@412
|
330 Tazlito is distributed in the hope that it will be useful, but
|
al@412
|
331 .BR "without any warranty" ;
|
al@412
|
332 without even the implied warranty of
|
al@412
|
333 .BR merchantability " or " "fitness for a particular purpose" .
|
al@412
|
334 See the GNU General Public License for more details.
|
al@412
|
335 .SH AUTHORS
|
al@412
|
336 Christophe Lincoln <pankso@slitaz.org>
|
al@412
|
337 .br
|
al@412
|
338 Pascal Bellard <pascal.bellard@ads-lu.com>
|
al@412
|
339 .br
|
al@412
|
340 Paul Issott <paul@slitaz.org>
|
al@412
|
341 .br
|
al@412
|
342 Eric Joseph-Alexandre <erjo@slitaz.org>
|
al@412
|
343 .br
|
al@412
|
344 Claudinei Pereira <claudinei@slitaz.org>
|
al@412
|
345 .br
|
al@412
|
346 Aleksej Bobylev <al.bobylev@gmail.com>
|
al@412
|
347 .SH MAINTAINERS
|
al@412
|
348 Christophe Lincoln <pankso@slitaz.org>
|
al@412
|
349 .br
|
al@412
|
350 Pascal Bellard <pascal.bellard@slitaz.org>
|
al@412
|
351 .SH SEE ALSO
|
al@412
|
352 tazlito.conf(5), flavor(5).
|