tazlito annotate doc/tazlito.en.html @ rev 121

Update manual (en)
author Paul Issott <paul@slitaz.org>
date Mon Jan 18 14:50:41 2010 +0000 (2010-01-18)
parents 76b0b5871b01
children 24510d119fd7
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@117 63 <a name="usage"></a>
pankso@117 64 <h3><font color="#6c0023">usage</font></h3>
pankso@117 65 <p>
pankso@117 66 The 'usage' command displays a summary of available commands
pankso@117 67 with a short description:
pankso@117 68 </p>
pankso@117 69 <pre>
pankso@117 70 # tazlito usage
pankso@117 71 </pre>
pankso@117 72 <a name="stats"></a>
pankso@117 73 <h3><font color="#6c0023">stats</font></h3>
pankso@117 74 <p>
pankso@117 75 Stats displays the configuration variables, the paths to the
pankso@117 76 various files and directories, and information on the ISO image:
pankso@117 77 </p>
pankso@117 78 <pre>
pankso@117 79 # tazlito stats
pankso@117 80 </pre>
pankso@117 81 <a name="gen-config"></a>
pankso@117 82 <h3><font color="#6c0023">gen-config</font></h3>
pankso@117 83 <p>
pankso@117 84 The 'gen-config' command allows you to generate a configuration
pankso@117 85 file ready to be edited. By default the file is created in
pankso@117 86 the current directory, but can be in another directory
pankso@117 87 if specified via the command line:
pankso@117 88 </p>
pankso@117 89 <pre>
pankso@117 90 # tazlito gen-config
pankso@117 91 # tazlito gen-config /path/to/distro
pankso@117 92 </pre>
pankso@117 93 <a name="configure"></a>
pankso@117 94 <h3><font color="#6c0023">configure</font></h3>
pankso@117 95 <p>
pankso@117 96 This command configures the system configuration
pankso@117 97 file or one found in the current directory:
pankso@117 98 </p>
pankso@117 99 <pre>
pankso@117 100 # tazlito configure
pankso@117 101 </pre>
pankso@117 102 <a name="gen-iso"></a>
pankso@117 103 <h3><font color="#6c0023">gen-iso</font></h3>
pankso@117 104 <p>
pankso@117 105 The 'gen-iso' command can generate a
pankso@117 106 new LiveCD image following modifications and additions to the
pankso@117 107 root filesystem of the cdrom. To function, this command needs
pankso@117 108 a directory containing the distro-tree of the Live system.
pankso@117 109 This tree can easily be built with the 'extract-distro' command,
pankso@117 110 modified and rebuilt via:
pankso@117 111 </p>
pankso@117 112 <pre>
pankso@117 113 # tazlito gen-iso
pankso@117 114 </pre>
pankso@117 115 <a name="gen-initiso"></a>
pankso@117 116 <h3><font color="#6c0023">gen-initiso</font></h3>
pankso@117 117 <p>
pankso@117 118 The 'gen'initso' command will do the same work as 'gen-iso',
pankso@117 119 but it rebuilds the initramfs compressed system prior.
pankso@117 120 The initramfs contains the root filesystem and
pankso@117 121 must be rebuilt if modified:
pankso@117 122 </p>
pankso@117 123 <pre>
pankso@117 124 # tazlito gen-initiso
pankso@117 125 </pre>
pankso@117 126 <a name="list-flavors"></a>
pankso@117 127 <h3><font color="#6c0023">list-flavors</font></h3>
pankso@117 128 <p>
pankso@117 129 The 'list-flavors' command downloads (if necessary) and displays
pankso@117 130 a list of the different flavors available. You can force the
pankso@117 131 download with the --recharge option:
pankso@117 132 </p>
pankso@117 133 <pre>
pankso@117 134 # tazlito list-flavors
pankso@117 135 # tazlito list-flavors --recharge
pankso@117 136 </pre>
pankso@117 137 <a name="get-flavors"></a>
pankso@117 138 <h3><font color="#6c0023">get-flavor</font></h3>
pankso@117 139 <p>
pankso@117 140 The 'get-flavor' command downloads (if necessary) and prepares the
pankso@117 141 files for 'gen-distro' to generate a flavor:
pankso@117 142 </p>
pankso@117 143 <pre>
pankso@117 144 # tazlito get-flavor particular-flavor
pankso@117 145 </pre>
pankso@117 146 <a name="show-flavors"></a>
pankso@117 147 <h3><font color="#6c0023">show-flavor</font></h3>
pankso@117 148 <p>
pankso@117 149 The 'show-flavor' command displays the description of the
pankso@117 150 flavor and its size after regeneration. The options
pankso@117 151 --brief and --noheader reduce the output displayed:
pankso@117 152 </p>
pankso@117 153 <pre>
pankso@117 154 # tazlito show-flavor particular-flavor
pankso@117 155 # tazlito show-flavor particular-flavor --brief
pankso@117 156 # tazlito show-flavor particular-flavor --brief --noheader
pankso@117 157 </pre>
pankso@117 158 <a name="gen-flavor"></a>
pankso@117 159 <h3><font color="#6c0023">gen-flavor</font></h3>
pankso@117 160 <p>
pankso@117 161 The 'gen-flavor' command creates a description file of a new
pankso@117 162 flavor from the results of generating a distro (gen-distro).
pankso@117 163 The .flavor file can then be sent to slitaz.org:
pankso@117 164 </p>
pankso@117 165 <pre>
pankso@117 166 # tazlito gen-flavor new-flavor
pankso@117 167 </pre>
pankso@117 168 <a name="gen-liveflavor"></a>
pankso@117 169 <h3><font color="#6c0023">gen-liveflavor</font></h3>
pankso@117 170 <p>
pankso@117 171 The 'gen-liveflavor' command creates a description file of a new
pankso@117 172 flavor from the results of generating a distro based on the
pankso@117 173 current system. The --help option provides more information:
pankso@117 174 </p>
pankso@117 175 <pre> # tazlito gen-liveflavor
pankso@117 176 # tazlito gen-liveflavor --help
pankso@117 177 </pre>
pankso@117 178 <a name="extract-distro"></a>
pankso@117 179 <h3><font color="#6c0023">extract-distro</font></h3>
pankso@117 180 <p>
pankso@117 181 The 'extract-distro' command is used to extract an ISO image
pankso@117 182 from the LiveCD to rebuild the structure of the root cdrom
pankso@117 183 and system. It is then possible to make the desired changes
pankso@117 184 or additions and rebuild the ISO image via 'gen-iso' or
pankso@117 185 'gen-initiso'. Example of use:
pankso@117 186 </p>
pankso@117 187 <pre>
pankso@117 188 # tazlito extract-distro slitaz-cooking.iso
pankso@117 189 </pre>
pankso@117 190 <a name="gen-distro"></a>
pankso@117 191 <h3><font color="#6c0023">gen-distro</font></h3>
pankso@117 192 <p>
pankso@117 193 The <em>Generate Distribution</em> command can generate the
pankso@117 194 distro-tree and an ISO image via a list of packages. To function,
pankso@117 195 this command needs a list of packages, a directory containing
pankso@117 196 all the (.tazpkg) packages on the list, and a directory to
pankso@117 197 generate the distribution. The list of packages can be extracted
pankso@117 198 from a flavor by the 'get-flavor' command. If one uses the
pankso@117 199 LiveCD, the options --cdrom and --iso= permit the regeneration
pankso@117 200 of packages that place files in /boot without being obliged
pankso@117 201 to download them and recovers the additional files of the
pankso@117 202 LiveCD. The path to the various directories are configured
pankso@117 203 in the configuration file and packages can be downloaded
pankso@117 204 from the SliTaz mirrors or generated by Tazwok. To generate
pankso@117 205 a distribution:
pankso@117 206 </p>
pankso@117 207 <pre>
pankso@117 208 # tazlito gen-distro
pankso@117 209 # tazlito gen-distro --cdrom
pankso@117 210 # tazlito gen-distro --iso=slitaz.iso
pankso@117 211 # tazlito gen-distro package-list
pankso@117 212 </pre>
pankso@117 213 <a name="clean-distro"></a>
pankso@117 214 <h3><font color="#6c0023">clean-distro</font></h3>
pankso@117 215 <p>
pankso@117 216 Removes all files generated or extracts of the structure
pankso@117 217 of the LiveCD:
pankso@117 218 </p>
pankso@117 219 <pre>
pankso@117 220 # tazlito clean-distro
pankso@117 221 </pre>
pankso@117 222 <a name="addhacker"></a>
pankso@117 223 <h3><font color="#6c0023">addhacker</font></h3>
pankso@117 224 <p>
pankso@117 225 The 'addhacker' command allows the addition of the user
pankso@117 226 hacker to the distribution - it helps to have a user account
pankso@117 227 without a password. Note that this command changes permissions
pankso@117 228 on all files in <code>/home/hacker</code>:
pankso@117 229 </p>
pankso@117 230 <pre>
pankso@117 231 # tazlito addhacker
pankso@117 232 </pre>
pankso@117 233 <a name="check-distro"></a>
pankso@117 234 <h3><font color="#6c0023">check-distro</font></h3>
pankso@117 235 <p>
pankso@117 236 This command simply verifies if files installed
pankso@117 237 by the packages are present on the system:
pankso@117 238 </p>
pankso@117 239 <pre>
pankso@117 240 # tazlito check-distro
pankso@117 241 </pre>
paul@121 242 <a name="emu-iso"></a>
paul@121 243 <h3><font color="#6c0023">emu-iso</font></h3>
paul@121 244 <p>
paul@121 245 The emu-iso command uses the Qemu emulator to start and run SliTaz.
paul@121 246 Qemu is used to test the newly built ISO image without burning to a
paul@121 247 cdrom or booting into frugal mode.
paul@121 248 </p>
paul@121 249 <pre>
paul@121 250 # tazlito emu-iso
paul@121 251 # tazlito emu-iso path/to/image.iso
paul@121 252 </pre>
pankso@117 253 <a name="burn-iso"></a>
pankso@117 254 <h3><font color="#6c0023">burn-iso</font></h3>
pankso@117 255 <p>
pankso@117 256 Burn-iso will guess the cdrom device and its speed, and wodim
pankso@117 257 (part of cdrkit) will begin to burn an ISO image. The default
pankso@117 258 ISO image is the one in the current configuration file,
pankso@117 259 but it's possible to specify a different image via the
pankso@117 260 command line:
pankso@117 261 </p>
pankso@117 262 <pre>
pankso@117 263 # tazlito burn-iso
pankso@117 264 # tazlito burn-iso slitaz-hacked.iso
pankso@117 265 </pre>
pankso@117 266
pankso@117 267 <h2>MAINTAINER</h2>
pankso@117 268 <p>
pankso@117 269 Christophe Lincoln &lt;pankso at slitaz.org&gt;
pankso@117 270 </p>
pankso@117 271
pankso@117 272 <!-- End content -->
pankso@117 273 </div>
pankso@117 274 </body>
pankso@117 275 </html>
pankso@117 276