tazlito view man/tazlito.1 @ rev 513

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