slitaz-tools annotate doc/tazinst.en.html @ rev 697

Added tag 4.7 for changeset 83491d0ac7b1
author Christophe Lincoln <pankso@slitaz.org>
date Thu Mar 01 15:56:00 2012 +0100 (2012-03-01)
parents b88f5042481a
children e8cb58647552
rev   line source
paul@619 1 <!DOCTYPE html>
paul@619 2 <html xmlns="http://www.w3.org/1999/xhtml">
paul@619 3 <head>
paul@619 4 <title>Tazinst Manual - Manual for 'tazinst' installer</title>
paul@619 5 <meta charset="utf-8" />
paul@619 6 <link rel="shortcut icon" href="favicon.ico" />
paul@619 7 <link rel="stylesheet" type="text/css" href="style.css" />
paul@619 8 </head>
paul@619 9 <body>
paul@619 10
paul@619 11 <!-- Header -->
paul@619 12 <div id="header">
paul@619 13 <h1>Tazinst Manual</h1>
paul@619 14 </div>
paul@619 15
paul@619 16 <!-- Start content -->
paul@619 17 <div id="content">
paul@619 18
paul@619 19 <h2>NAME</h2>
paul@619 20 <p>
paul@619 21 Tazinst - Tiny autonomous zone installer manager
paul@619 22 </p>
paul@619 23
paul@619 24 <h2>SYNTAX</h2>
paul@619 25 <pre>
domcox@665 26 tazinst [command] [option]
paul@619 27 </pre>
paul@619 28
paul@619 29 <h2>DESCRIPTION</h2>
paul@619 30 <p>
domcox@665 31 Tazinst is a lightweight SliTaz HDD installer (~ 31 KB). It installs SliTaz
paul@666 32 to a hard drive from a Live-CD, a LiveUSB key, a SliTaz ISO image, or from
domcox@665 33 the web by downloading a stable, cooking or rolling version or by giving
domcox@665 34 the http link of another iso (eg: Development ISO).
paul@619 35 </p>
paul@619 36 <p>
domcox@665 37 Tazinst can format the target partition to ext2, ext3, ext4 or other formats
domcox@665 38 if the matching packages are installed. The home partition can be installed
paul@666 39 on another partition and if need be, formatted before installation into any
domcox@665 40 one of the available formats. Tazinst may upon request install the Grub
domcox@665 41 bootloader in the MBR of the target disk. A dual-boot with an existing
domcox@665 42 Windows© partition is possible, finding the Windows© partition can either be
domcox@665 43 done automatically or manually specified.
paul@619 44 </p>
paul@619 45 <p>
domcox@665 46 Tazinst can also update SliTaz installed on a hard disk partition which is
domcox@665 47 handy in case of version changes. In this case, Slitaz is updated, data in
domcox@665 48 /home is preserved and additional packages are reinstalled on to the new
domcox@665 49 version.
paul@619 50 </p>
paul@619 51 <p>
domcox@665 52 Tazinst was created independently for the needs of the SliTaz GNU/Linux mini
domcox@665 53 distribution.
paul@619 54 </p>
paul@619 55 <p>
domcox@665 56 Tazinst is written from scratch in shell script and is compatible with
domcox@665 57 Busybox Ash and Bash. Tazinst is licensed under the GNU Free gpl v3.
paul@619 58 </p>
paul@619 59
domcox@665 60 <h2>SETUP FILE</h2>
paul@619 61 <p>
domcox@665 62 Tazinst installer is able to perform an installation automatically based on
domcox@665 63 a simple setup file with clear variables such as:
domcox@665 64 <code>INST_TYPE="iso"</code>, <code>TGT_PARTITION="/dev/hda1"</code>.
domcox@665 65
paul@666 66 With this way, it allows developers to create a different kind of frontend:
domcox@665 67 Dialog, GTK and CGI/web in TazPanel. The frontend just has to create a
domcox@665 68 setup file and start the cmdline installer and report steps in a nice way
domcox@665 69 (progress bar or/and messages).
paul@619 70 </p>
paul@619 71 <p>
domcox@665 72 The setup file contains the following variables:
paul@619 73 </p>
paul@619 74 <ul>
domcox@665 75 <li class="level1"><div class="li">
domcox@665 76 The variables describing the installation source:
paul@619 77
paul@619 78 <ol>
domcox@665 79 <li class="level1"><div class="li">
domcox@665 80 <strong>*INST_TYPE</strong>: the type of media containing the SliTaz source
domcox@665 81 files, either: <strong>cdrom</strong> (SliTaz LiveCD), <strong>usb</strong>
domcox@665 82 (SliTaz LiveUSB), <strong>iso</strong> (ISO image of SliTaz),
domcox@665 83 <strong>web</strong> (ISO image on the Web), <strong>weboot</strong>,
domcox@665 84 ex: <code>INST_TYPE=web</code>
domcox@665 85 </div></li>
domcox@665 86 <li class="level1"><div class="li">
domcox@665 87 <strong>SRC_FILE</strong>: the name of the source file containing SliTaz.
domcox@665 88 It depends on the type of support:
paul@619 89 <ul>
domcox@656 90 <li class="level2"><div class="li">cdrom (SliTaz LiveCD):
domcox@665 91 <i>unused</i>
domcox@665 92 </div></li>
domcox@656 93 <li class="level2"><div class="li">usb (SliTaz LiveUSB): name of the
domcox@656 94 partition on the host USB device, ex: <code>SRC_FILE=/dev/sdb1</code>
domcox@665 95 </div></li>
domcox@656 96 <li class="level2"><div class="li">iso (ISO image of SliTaz): name of the
domcox@665 97 ISO file, ex: <code>SRC_FILE=~/slitaz.3.0.iso</code>
domcox@665 98 </div></li>
domcox@656 99 <li class="level2"><div class="li">web (ISO image on the Web): name of the
domcox@656 100 URL, ex: <code>
paul@619 101 SRC_FILE=http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso</code>.
domcox@656 102 Note that 3 URLs are predefined: 'stable', 'cooking, 'rolling', ex:
paul@619 103 <code>SRC_FILE=cooking</code> downloads the latest cooking available
domcox@665 104 from the web
domcox@665 105 </div></li>
domcox@665 106 <li class="level2"><div class="li">weboot: <i>unused</i>
domcox@665 107 </div></li>
domcox@667 108 </ul>
domcox@667 109 </div></li>
paul@619 110 </ol>
domcox@665 111 </div></li>
domcox@665 112 </ul>
paul@619 113
paul@619 114 <ul>
domcox@665 115 <li class="level1"><div class="li">The variables describing the target
domcox@665 116 partition:
domcox@665 117
domcox@665 118 <ol>
domcox@665 119 <li class="level1"><div class="li">
domcox@665 120 <strong>*TGT_PARTITION</strong>: the name of the target partition SliTaz
domcox@665 121 will install to or update,
domcox@665 122 ex: <code>TGT_PARTITION=/dev/hda3</code>
domcox@665 123 </div></li>
domcox@665 124 <li class="level1"><div class="li">
domcox@665 125 <strong>TGT_FS</strong>: if this variable is entered, the target partition
domcox@665 126 will be formatted in the file system specified, otherwise the partition will
domcox@665 127 be cleaned and /home will be preserved, ex: <code>TGT_FS=ext3</code>
domcox@665 128 </div></li>
domcox@665 129 <li class="level1"><div class="li">
domcox@665 130 <strong>TGT_HOME</strong>: this variable indicates if need be, the name of
domcox@665 131 the partition to receive the /home directory,
domcox@665 132 ex: <code>TGT_HOME=/dev/hda5</code>
domcox@665 133 </div></li>
domcox@665 134 <li class="level1"><div class="li">
domcox@665 135 <strong>TGT_HOME_FS</strong>: if this variable is entered, the home
domcox@665 136 partition will be formatted in the file system specified,
domcox@665 137 ex: <code>TGT_HOME_FS=ext2</code>
domcox@665 138 </div></li>
domcox@665 139 </ol>
domcox@665 140 </div></li>
paul@619 141 </ul>
paul@619 142
domcox@665 143 <ul>
domcox@665 144 <li class="level1"><div class="li">The system settings:
domcox@665 145
paul@619 146 <ol>
domcox@665 147 <li class="level1"><div class="li">
domcox@665 148 <strong>TGT_HOSTNAME</strong>: name of the system,
domcox@665 149 ex: <code>TGT_HOSTNAME=hd-slitaz</code>, by default
domcox@665 150 <code>TGT_HOSTNAME=slitaz</code>
domcox@665 151 </div></li>
domcox@665 152 <li class="level1"><div class="li">
domcox@665 153 <strong>TGT_ROOT_PWD</strong>: superuser password,
domcox@665 154 ex: <code>TGT_ROOT_PWD=toor</code>, by default
domcox@665 155 <code>TGT_ROOT_PWD=root</code>
domcox@665 156 </div></li>
domcox@665 157 <li class="level1"><div class="li">
domcox@665 158 <strong>TGT_USER</strong>: user name,
domcox@665 159 ex: <code>TGT_USER=toto</code>, by default <code>TGT_USER=tux</code>
domcox@665 160 </div></li>
domcox@665 161 <li class="level1"><div class="li">
domcox@665 162 <strong>TGT_USER_PWD</strong>: user password,
domcox@665 163 ex: <code>TGT_USER_PWD=titi</code>, by default
domcox@665 164 <code>TGT_USER_PWD=tux</code>
domcox@665 165 </div></li>
paul@619 166 </ol>
domcox@665 167 </div></li>
domcox@665 168 </ul>
paul@619 169
paul@619 170 <ul>
domcox@665 171 <li class="level1"><div class="li"> The boot loader (bootloader)
domcox@665 172 configuration variables:
domcox@665 173
domcox@665 174 <ol>
domcox@665 175 <li class="level1"><div class="li">
domcox@665 176 <strong>TGT_GRUB</strong>: install the GRUB bootloader (yes or no),
domcox@665 177 ex: <code>TGT_GRUB=yes</code>, by default <code>TGT_GRUB=no</code>
domcox@665 178 </div></li>
domcox@665 179 <li class="level1"><div class="li">
domcox@665 180 <strong>TGT_WINBOOT</strong>: if this variable is entered, it indicates the
domcox@665 181 partition containing Windows© to implement a dual-boot. It can also be set
paul@666 182 to 'auto', in this case the dual-boot will be on the first partition
paul@666 183 Windows© detects,
domcox@665 184 ex: <code>TGT_WINBOOT=auto</code>
domcox@665 185 </div></li>
domcox@665 186 </ol>
domcox@667 187 </div></li>
paul@619 188 </ul>
paul@619 189
paul@619 190 <p>
domcox@665 191 Note that only variables preceded by a asterisk are mandatory, others are
domcox@665 192 optional. Thus a minimal setup file can be:
paul@619 193 </p>
paul@619 194 <pre>
paul@619 195 INST_TYPE=cdrom
paul@619 196 TGT_PARTITION=/dev/hda3
paul@619 197 </pre>
paul@619 198 <p>
domcox@665 199 This file will install SliTaz on /dev/hda3 formatting the partition from a
domcox@665 200 LiveCD.
paul@619 201 </p>
paul@619 202
domcox@665 203 <h2>COMMANDS</h2>
domcox@665 204
domcox@667 205 <a id="new"></a>
domcox@665 206 <h3>new</h3>
domcox@665 207 <p>
domcox@665 208 Generates a new self-documenting setup file which when edited as required
domcox@665 209 by the user will install or update SliTaz to a hard drive.
domcox@665 210 </p>
domcox@665 211 <pre>
domcox@665 212 tazinst new /var/lib/tazinst.conf
domcox@665 213 </pre>
domcox@665 214
domcox@665 215
domcox@667 216 <a id="install"></a>
paul@619 217 <h3>install</h3>
paul@619 218 <p>
domcox@665 219 Performs a SliTaz install on a HDD based on data in the setup file.
domcox@665 220 If you decide to format your HDD, all data will be lost. If you do not
paul@666 221 format, all data except for any existing /home directory will be removed,
paul@666 222 the home directory will be kept as is.
paul@619 223 </p>
paul@619 224 <pre>
paul@619 225 tazinst install /var/lib/tazinst.conf
paul@619 226 </pre>
paul@619 227
domcox@667 228 <a id="upgrade"></a>
paul@619 229 <h3>upgrade</h3>
paul@619 230 <p>
domcox@665 231 Upgrade an existing SliTaz system on a HDD based on data in the setup file.
domcox@665 232 Your /home /etc /var/www directories will be kept, all other directories
domcox@665 233 will be removed. Any additional package added to your old Slitaz system
domcox@665 234 will be updated as long you have an active internet connection.
paul@619 235 </p>
paul@619 236 <pre>
paul@619 237 tazinst upgrade /var/lib/tazinst.conf
paul@619 238 </pre>
paul@619 239
domcox@667 240 <a id="showurl"></a>
domcox@656 241 <h3>showurl</h3>
domcox@665 242 <p>
domcox@665 243 Display the full URL of the predefined shortcuts: 'stable', 'cooking,
domcox@665 244 'rolling'.
domcox@665 245 </p>
domcox@665 246 <p>
domcox@665 247 Note: You may overwrite these shortcuts in the system file:
domcox@665 248 /etc/slitaz/tazinst.conf.
domcox@665 249 </p>
domcox@656 250 <pre>
domcox@656 251 tazinst showurl stable
domcox@656 252 </pre>
domcox@656 253
domcox@667 254 <a id="check"></a>
domcox@656 255 <h3>check</h3>
domcox@665 256 <p>
domcox@665 257 Check a setup file for errors.
domcox@665 258 </p>
domcox@656 259 <pre>
domcox@656 260 tazinst check /var/lib/tazinst.conf
domcox@656 261 </pre>
domcox@656 262
domcox@667 263 <a id="log"></a>
domcox@665 264 <h3>log</h3>
domcox@665 265 <p>
domcox@665 266 Display the last log file contents and exit.
domcox@665 267 </p>
domcox@665 268 <pre>
domcox@665 269 tazinst log
domcox@665 270 </pre>
domcox@665 271
domcox@667 272 <a id="version"></a>
domcox@665 273 <h3>version</h3>
domcox@665 274 <p>
domcox@665 275 Print the version information and exit.
domcox@665 276 </p>
domcox@665 277 <pre>
domcox@665 278 tazinst version
domcox@665 279 </pre>
domcox@665 280
domcox@665 281 <h2>SYSTEM FILE</h2>
domcox@665 282 <p>
paul@666 283 The /etc/slitaz/tazinst.conf configuration file allows you to change the default
paul@666 284 settings of tazinst, if you want to use custom values for URLs, directories
paul@666 285 and files, you'll have to create one and modify the following variables:
domcox@665 286 </p>
domcox@665 287
domcox@665 288 <ul>
domcox@665 289 <li class="level1"><div class="li">Predefined urls:
domcox@665 290
domcox@665 291 <ol>
domcox@665 292 <li class="level1"><div class="li">URL of the current stable version:<br />
domcox@665 293 <code>URL_STABLE="http://mirror.slitaz.org/iso/stable/slitaz-4.0.iso"
domcox@665 294 </code>
domcox@665 295 </div></li>
domcox@665 296 <li class="level1"><div class="li">URL of the current cooking version:<br />
domcox@665 297 <code>URL_COOKING="http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso"
domcox@665 298 </code>
domcox@665 299 </div></li>
domcox@665 300 <li class="level1"><div class="li">URL of the current rolling version:<br />
domcox@665 301 <code>URL_ROLLING="http://mirror.slitaz.org/iso/rolling/slitaz-core.iso"
domcox@665 302 </code>
domcox@665 303 </div></li>
domcox@665 304 </ol>
domcox@667 305 </div></li>
domcox@665 306 </ul>
domcox@665 307
domcox@665 308 <ul>
domcox@665 309 <li class="level1"><div class="li">Mount points:
domcox@665 310
domcox@665 311 <ol>
domcox@665 312 <li class="level1"><div class="li">
domcox@665 313 Source partition mount point:<br />
domcox@665 314 <code>SOURCE_ROOT="/media/source"</code>
domcox@665 315 </div></li>
domcox@665 316 <li class="level1"><div class="li">
domcox@665 317 Target partition mount point:<br />
domcox@665 318 <code>TARGET_ROOT="/mnt/target"</code>
domcox@665 319 </div></li>
domcox@665 320 </ol>
domcox@665 321 </div></li>
domcox@665 322 </ul>
domcox@665 323
domcox@665 324 <ul>
domcox@665 325 <li class="level1"><div class="li">Log and Debug:
domcox@665 326
domcox@665 327 <ol>
domcox@665 328 <li class="level1"><div class="li">Log File Location:<br />
domcox@665 329 <code>LOG="/var/log/tazinst.log"</code>
domcox@665 330 </div></li>
domcox@665 331 <li class="level1"><div class="li">Debugging: (quiet => 0, debug => 1)<br />
domcox@667 332 <code>DEBUG=0</code><br />
paul@666 333 It is highly recommended to set <code>DEBUG=1</code> and attach the
paul@666 334 contents of the resulting Log file when sending a bug report to
paul@666 335 developers.
domcox@667 336 </div></li>
domcox@665 337 </ol>
domcox@665 338 </div></li>
domcox@665 339 </ul>
domcox@656 340
paul@619 341 <h2>MAINTAINERS</h2>
paul@619 342 <p>
paul@619 343 Christophe Lincoln &lt;pankso at slitaz.org&gt; <br />
paul@619 344 Dominique Corbex &lt;domcox at slitaz.org&gt;
paul@619 345 </p>
paul@619 346
paul@619 347 <!-- End of content -->
paul@619 348 </div>
paul@619 349
paul@619 350 <div id="footer">
pascal@675 351 Copyright &copy; 2012 <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a>
paul@619 352 </div>
paul@619 353
paul@619 354 </body>
paul@619 355 </html>