tazinst annotate doc/tazinst.en.html @ rev 0

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