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