tazlito diff man/tazlito.1 @ rev 501
Clean efi/boot to build loram
author | Pascal Bellard <pascal.bellard@slitaz.org> |
---|---|
date | Sun May 20 13:25:56 2018 +0200 (2018-05-20) |
parents | |
children |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/man/tazlito.1 Sun May 20 13:25:56 2018 +0200 1.3 @@ -0,0 +1,352 @@ 1.4 +.TH TazLiTo "1" "29.01.2016" 1.5 +.SH NAME 1.6 +Tazlito \(em SliTaz Live Tool. 1.7 +.SH SYNTAX 1.8 +.nf 1.9 +.RI "tazlito [" command "] [" list | iso | flavor "] [" dir ] 1.10 +.fi 1.11 +.SH DESCRIPTION 1.12 +Tazlito is a small utility to extract a Live CD, rebuild the ISO image and 1.13 +regenerate the root filesystem of the Live CD. Tazlito can also generate a 1.14 +distribution from a list of packages previously downloaded. Tazlito uses the 1.15 +configuration file 1.16 +.IR tazlito.conf (5). 1.17 +.PP 1.18 +Tazlito installed by default on SliTaz and installed/successfully tested on 1.19 +Debian GNU/Linux. You will find additional information about creating a LiveCD 1.20 +in the Handbook. 1.21 +.SH COMMANDS 1.22 +.SS usage 1.23 +Display a summary of available commands with a short description. 1.24 +.nf 1.25 +$ tazlito usage 1.26 +.fi 1.27 +.SS stats 1.28 +Display the configuration variables, the paths to the various files and 1.29 +directories, and information on the ISO image. 1.30 +.nf 1.31 +$ tazlito stats 1.32 +.fi 1.33 +.SS list-addfiles 1.34 +Display the list of additional files in the rootfs. 1.35 +.nf 1.36 +$ tazlito list-addfiles 1.37 +.fi 1.38 +.SS gen-config 1.39 +Generate a configuration file ready to be edited. 1.40 +.PP 1.41 +By default the file is created in the current directory, but can be in another 1.42 +directory if specified via the command line. 1.43 +.nf 1.44 +$ tazlito gen-config 1.45 +$ tazlito gen-config \fI/path/to/distro\fR 1.46 +.fi 1.47 +.SS configure 1.48 +Configure the system configuration file or one found in the current directory. 1.49 +.PP 1.50 +You will be asked for ISO name, volume name, paths to packages repository and 1.51 +to distro. 1.52 +.nf 1.53 +# tazlito configure 1.54 +.fi 1.55 +.SS gen-iso 1.56 +Generate a new Live CD image following modifications and additions to the root 1.57 +filesystem of the CD-ROM. 1.58 +.PP 1.59 +To function, this command needs a directory containing the distro-tree of the 1.60 +Live system. This tree can easily be built with the 1.61 +.B extract-distro 1.62 +command, modified and rebuilt via: 1.63 +.nf 1.64 +# tazlito gen-iso 1.65 +.fi 1.66 +.SS gen-initiso 1.67 +The same as 1.68 +.BR gen-iso , 1.69 +but it rebuilds the initramfs compressed system prior. 1.70 +.PP 1.71 +The initramfs contains the root filesystem and must be rebuilt if modified. 1.72 +.nf 1.73 +# tazlito gen-initiso 1.74 +.fi 1.75 +.SS list-flavors 1.76 +Download (if necessary) and display a list of the different flavors available. 1.77 +.PP 1.78 +You can force the download with the 1.79 +.I --recharge 1.80 +option. 1.81 +.nf 1.82 +$ tazlito list-flavors 1.83 +# tazlito list-flavors --recharge 1.84 +.fi 1.85 +.SS get-flavor 1.86 +Download (if necessary) and prepares the files for 1.87 +.B gen-distro 1.88 +to generate an ISO image. 1.89 +.PP 1.90 +Option 1.91 +.I --noup 1.92 +can be used to skip updating flavor (see 1.93 +.B upgrade-flavor 1.94 +command). 1.95 +.nf 1.96 +# tazlito get-flavor \fIcore\fR 1.97 +.fi 1.98 +.SS show-flavor 1.99 +Display the description of the flavor and its size after regeneration. 1.100 +.PP 1.101 +The options 1.102 +.IR --brief " and " --noheader 1.103 +reduce the output displayed. 1.104 +.nf 1.105 +$ tazlito show-flavor \fIbase\fR 1.106 +$ tazlito show-flavor \fIjustx\fR --brief 1.107 +$ tazlito show-flavor \fIcore\fR --brief --noheader 1.108 +.fi 1.109 +.SS gen-flavor 1.110 +Create a description file of a new flavor from the results of generating a 1.111 +distro 1.112 +.RB ( gen-distro ). 1.113 +The 1.114 +.I .flavor 1.115 +file can then be sent to slitaz.org. 1.116 +.nf 1.117 +# tazlito gen-flavor \fInew-flavor\fR 1.118 +.fi 1.119 +.SS gen-liveflavor 1.120 +Create a description file of a new flavor from the results of generating a 1.121 +distro based on the current system. 1.122 +.PP 1.123 +The 1.124 +.I --help 1.125 +option provides more information. 1.126 +.nf 1.127 +# tazlito gen-liveflavor --help 1.128 +# tazlito gen-liveflavor \fIflavor-name\fR 1.129 +# tazlito gen-liveflavor \fIflavor-name flavor-patch-file\fR 1.130 +.fi 1.131 +Format of the flavor-patch-file: 1.132 +.TS 1.133 +c l. 1.134 +\fBcode\fR \fBdata\fR 1.135 +_ 1.136 +@ flavor description 1.137 ++ package to add 1.138 +- package to remove 1.139 +! non-free package to add 1.140 +? display message 1.141 +.TE 1.142 +Example: 1.143 +.nf 1.144 +@ Developer tools for SliTaz maintainers 1.145 ++ slitaz-toolchain 1.146 ++ mercurial 1.147 +.fi 1.148 +.SS iso2flavor 1.149 +Create a flavor file from the ISO image. 1.150 +.nf 1.151 +# tazlito iso2flavor \fIslitaz-cooking.iso mycooking\fR 1.152 +.fi 1.153 +.SS upgrade-flavor 1.154 +Refresh a flavor description file. Sizes and actual number of packages will be 1.155 +re-calculated. List of unknown packages will be displayed if any, as well as 1.156 +list of important packages missed in the flavor (like 1.157 +.BR syslinux " or " linux ). 1.158 +Packages versions (presented in the legacy flavor format) will be stripped from 1.159 +the flavor package list. 1.160 +.nf 1.161 +# tazlito upgrade-flavor \fIcore\fR 1.162 +.fi 1.163 +.SS extract-flavor 1.164 +Convert a flavor into an easily modifiable tree structure. Path to the 1.165 +extracted flavors repository specified by variable 1.166 +.I FLAVORS_REPOSITORY 1.167 +in the tazlito.conf(5) (by default 1.168 +.IR /home/slitaz/cooking/flavors ). 1.169 +.PP 1.170 +This repository can be managed with mercurial: http://hg.slitaz.org/flavors . 1.171 +.nf 1.172 +# tazlito extract-flavor \fIcore\fR 1.173 +.fi 1.174 +.SS pack-flavor 1.175 +Convert a tree structure, extracted by 1.176 +.B extract-flavor 1.177 +into a flavor file 1.178 +.RI ( .flavor ). 1.179 +.nf 1.180 +# tazlito pack-flavor \fIcore\fR 1.181 +.fi 1.182 +Execute this command after changing existing flavor, or after preparing new 1.183 +flavor. File 1.184 +.I packages.list 1.185 +inside flavor tree structure can contain include directive at the beginning, 1.186 +for example: 1.187 +.nf 1.188 +@include \fIjustx\fR 1.189 +.fi 1.190 +to include all the packages listed in the 1.191 +.I justx 1.192 +flavor. 1.193 +.SS extract-distro 1.194 +Extract an ISO image from the Live CD to rebuild the structure of the root 1.195 +CD-ROM and system. It is then possible to make the desired changes or additions 1.196 +and rebuild the ISO image via 1.197 +.BR gen-iso " or " gen-initiso . 1.198 +.PP 1.199 +ISO image is extracted by default to the path specified by variable 1.200 +.I DISTRO 1.201 +in the tazlito.conf(5). Desired path may be specified in the second argument. 1.202 +.nf 1.203 +# tazlito extract-distro \fI/tmp/slitaz-cooking.iso\fR 1.204 +# tazlito extract-distro \fI/tmp/slitaz-cooking.iso\fR \fI/tmp/extracted\fR 1.205 +.fi 1.206 +.SS gen-distro 1.207 +Generate the distro-tree and an ISO image via a list of packages. 1.208 +.PP 1.209 +To function, this command needs a list of packages and other files provided by 1.210 +command 1.211 +.BR get-flavor . 1.212 +List is expected to be the file 1.213 +.I distro-packages.list 1.214 +in the current directory, or can be specified in the command argument. 1.215 +If package list not given, new list 1.216 +.I distro-packages.list 1.217 +will be re-created in the current directory using all currently installed 1.218 +packages. 1.219 +.PP 1.220 +If one uses the Live CD, the options 1.221 +.IR --cdrom " and " --iso= 1.222 +allows the regeneration of packages that place files in 1.223 +.I /boot 1.224 +without being obliged to download them and recovers the additional files of the 1.225 +Live CD. 1.226 +.PP 1.227 +The path to the various directories are configured in the tazlito.conf(5) 1.228 +and packages can be downloaded from the SliTaz mirrors or generated by 1.229 +Cookutils. 1.230 +.nf 1.231 +# tazlito gen-distro 1.232 +# tazlito gen-distro --cdrom 1.233 +# tazlito gen-distro --iso=\fIslitaz.iso\fR 1.234 +# tazlito gen-distro \fIpackage-list\fR 1.235 +.fi 1.236 +.SS clean-distro 1.237 +Remove all files generated or extracts of the structure of the LiveCD. 1.238 +.nf 1.239 +# tazlito clean-distro 1.240 +.fi 1.241 +.SS check-distro 1.242 +Verify few configuration files in the generated rootfs 1.243 +.RI ( /etc/slitaz-release ", " /var/lib/tazpkg/mirror , 1.244 +.IR /boot/isolinux/isolinux.cfg ). 1.245 +.PP 1.246 +.B TODO: 1.247 +Remove this function. First two files are maintained by tazpkg while it runs on 1.248 +rootfs, while last one file should be maintained by tazlito itself. 1.249 +.nf 1.250 +# tazlito check-distro 1.251 +.fi 1.252 +.SS writeiso 1.253 +Write the current filesystem to a cpio archive 1.254 +.RI ( rootfs.gz ) 1.255 +and then generate a bootable ISO image. Writeiso can be used in a HD install or 1.256 +in live mode and will also archive your current 1.257 +.I /home 1.258 +directory. 1.259 +.PP 1.260 +This command lets you easily remaster and build your own Live CD image, just 1.261 +boot, modify any files, and then: 1.262 +.nf 1.263 +# tazlito writeiso [gzip|lzma|none] 1.264 +# tazlito writeiso gzip 1.265 +# tazlito writeiso gzip \fIimage-name\fR 1.266 +.fi 1.267 +.SS repack 1.268 +Recompress the rootfs with the best possible compression. 1.269 +.nf 1.270 +# tazlito repack \fIslitaz.iso\fR 1.271 +.fi 1.272 +.SS merge 1.273 +Combine several flavors like nested Russian dolls. Each rootfs is a subset of 1.274 +the previous. The first rootfs is extracted from the ISO image used in the 1.275 +third argument. The flavor will then be chosen to launch at startup according 1.276 +to the amount of RAM available. 1.277 +.nf 1.278 +# tazlito merge \fI160M slitaz-core.iso 96M rootfs-justx.gz 32M rootfs-base.gz\fR 1.279 +.fi 1.280 +.SS build-loram 1.281 +Create an ISO image flavor for low RAM systems from a SliTaz ISO image. You can 1.282 +build a flavor with 1.283 +.I / 1.284 +always in RAM or where 1.285 +.I / 1.286 +resides on the CD-ROM: 1.287 +.nf 1.288 +# tazlito build-loram \fIslitaz.iso loram.iso\fR 1.289 +# tazlito build-loram \fIslitaz.iso loram-cdrom.iso\fR cdrom 1.290 +.fi 1.291 +Third argument can be one of the: 1.292 +.TP 1.293 +.I cdrom 1.294 +Move rootfs to squashfs filesystem(s) to the CD-ROM writeable with 1.295 +aufs/overlayfs. These squashfs may be loaded in RAM at boot time. Rootfs are also 1.296 +copied to CD-ROM for tiny ramsize systems. Meta flavors are converted to normal 1.297 +flavors. 1.298 +.TP 1.299 +.I smallcdrom 1.300 +TODO. 1.301 +.TP 1.302 +.I http 1.303 +Create http bootstrap to load and remove loram_cdrom. Meta flavors are converted 1.304 +to normal flavors. 1.305 +.TP 1.306 +.I ram 1.307 +Move rootfs to a squashfs filesystem into the initramfs writeable with 1.308 +aufs/overlayfs. Meta flavor selection sizes are updated. 1.309 +.SS emu-iso 1.310 +Use the QEMU emulator to start and run SliTaz. 1.311 +.PP 1.312 +QEMU is used to test the newly built ISO image without burning to a CD-ROM or 1.313 +booting into frugal mode. 1.314 +.nf 1.315 +# tazlito emu-iso 1.316 +# tazlito emu-iso path/to/image.iso 1.317 +.fi 1.318 +.SS burn-iso 1.319 +Burn an ISO image guessing the CD-ROM device and its speed. 1.320 +.PP 1.321 +The default ISO image is the one located in the current configuration file, but 1.322 +it's possible to specify a different image via the command line: 1.323 +.nf 1.324 +# tazlito burn-iso 1.325 +# tazlito burn-iso \fIslitaz-hacked.iso\fR 1.326 +.fi 1.327 +.SH LICENSE 1.328 +Tazlito is free software; you can redistribute it and/or modify it under the 1.329 +terms of the GNU General Public License as published by the Free Software 1.330 +Foundation; either version 3 of the License, or (at your option) any later 1.331 +version. 1.332 +.PP 1.333 +Tazlito is distributed in the hope that it will be useful, but 1.334 +.BR "without any warranty" ; 1.335 +without even the implied warranty of 1.336 +.BR merchantability " or " "fitness for a particular purpose" . 1.337 +See the GNU General Public License for more details. 1.338 +.SH AUTHORS 1.339 +Christophe Lincoln <pankso@slitaz.org> 1.340 +.br 1.341 +Pascal Bellard <pascal.bellard@ads-lu.com> 1.342 +.br 1.343 +Paul Issott <paul@slitaz.org> 1.344 +.br 1.345 +Eric Joseph-Alexandre <erjo@slitaz.org> 1.346 +.br 1.347 +Claudinei Pereira <claudinei@slitaz.org> 1.348 +.br 1.349 +Aleksej Bobylev <al.bobylev@gmail.com> 1.350 +.SH MAINTAINERS 1.351 +Christophe Lincoln <pankso@slitaz.org> 1.352 +.br 1.353 +Pascal Bellard <pascal.bellard@slitaz.org> 1.354 +.SH SEE ALSO 1.355 +tazlito.conf(5), flavor(5).