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

slight modifications in tazinst manual
author Hans-G?nter Theisgen
date Fri Oct 06 17:15:36 2017 +0100 (2017-10-06)
parents f9a876208b66
children
rev   line source
domcox@0 1 <!DOCTYPE html>
al@68 2 <html lang="en">
domcox@0 3 <head>
al@68 4 <meta charset="UTF-8">
al@68 5 <title>Tazinst Manual — Manual for “tazinst” installer</title>
al@68 6 <link rel="shortcut icon" href="favicon.ico">
al@68 7 <link rel="stylesheet" href="../slitaz-doc.css">
al@68 8 <script src="../slitaz-doc.js"></script>
domcox@0 9 </head>
domcox@0 10 <body>
domcox@0 11
al@11 12 <header>
domcox@0 13 <h1>Tazinst Manual</h1>
al@11 14 </header>
domcox@0 15
domcox@0 16 <!-- Start content -->
domcox@0 17 <div id="content">
domcox@0 18
domcox@0 19 <h2>NAME</h2>
al@11 20
al@68 21 <p>Tazinst — Tiny autonomous zone installer manager</p>
al@11 22
domcox@0 23
domcox@0 24 <h2>SYNTAX</h2>
al@11 25
domcox@0 26 <pre>
domcox@2 27 tazinst [command] &lt;setting&gt; &lt;value&gt; &lt;file&gt;
domcox@0 28 </pre>
domcox@0 29
al@11 30
domcox@0 31 <h2>DESCRIPTION</h2>
al@11 32
al@11 33 <p>Tazinst is a lightweight SliTaz HDD installer. It installs SliTaz to a hard
al@11 34 drive from any local media such as a Live-CD, a LiveUSB key, an ISO image
al@11 35 located on one of your disks, or from the web by automatically downloading a
al@11 36 SliTaz image.</p>
al@11 37 <p>Tazinst can format the target partition to ext2, ext3 or ext4. The home
al@11 38 partition can be installed on another partition and if need be, formatted before
al@11 39 installation into any one of the available formats. Tazinst may upon request
al@11 40 install a bootloader on the target disk. A dual-boot with an existing Windows™
al@11 41 partition is possible—finding the Windows™ partition can either be done
al@11 42 automatically or manually specified.</p>
al@11 43 <p>Tazinst can also update SliTaz installed on a hard disk partition which is
al@68 44 handy in case of version changes. In this case, SliTaz is updated, any data in
al@11 45 /home is preserved and additional packages are reinstalled on to the new
al@11 46 version.</p>
al@11 47 <p>Tazinst was created independently for the needs of the SliTaz GNU/Linux mini
al@11 48 distribution.</p>
al@11 49 <p>Tazinst is written from scratch in shell script and is compatible with
al@11 50 Busybox Ash and Bash. Tazinst is licensed under the GNU Free GPL v3.</p>
al@11 51
al@11 52
domcox@2 53 <h3>Known limitations</h3>
domcox@0 54
al@11 55 <p>Tazinst doesn't allow SliTaz to boot on (U)EFI systems (mostly Windows™ 8
al@11 56 systems), except in BIOS compatibility mode.</p>
domcox@2 57
domcox@2 58
domcox@2 59 <h2>SETTINGS</h2>
domcox@2 60
al@11 61 <p>Tazinst installer is able to perform an installation automatically based on a
al@11 62 few settings.</p>
domcox@0 63
domcox@2 64
al@11 65 <h3 id="mode">mode</h3>
domcox@0 66
al@11 67 <p>Installation mode that will be performed by tazinst. Type <code>tazinst help
al@11 68 mode</code> in order to have a list of supported modes.</p>
al@11 69
al@11 70
al@11 71 <h3 id="media">media</h3>
al@11 72
al@11 73 <p>The media containing the SliTaz source files, either <strong>cdrom</strong>
al@11 74 (SliTaz LiveCD), <strong>usb</strong> (SliTaz LiveUSB), <strong>iso</strong>
al@11 75 (ISO image of SliTaz), or <strong>web</strong> (ISO image on the Web).</p>
al@11 76
al@11 77
al@11 78 <h3 id="source">source</h3>
al@11 79
al@11 80 <p>The name of the source file containing SliTaz. It depends on the type of
al@11 81 <strong>media</strong>:</p>
al@11 82
al@11 83 <table>
domcox@2 84 <tr>
al@11 85 <td>cdrom:</td>
al@11 86 <td><i>unused</i></td>
domcox@2 87 </tr>
domcox@2 88 <tr>
al@11 89 <td>usb:</td>
al@11 90 <td>name of the partition on the host USB device. Type <code>tazinst
al@11 91 list usb</code></strong> to list USB partitions.</td>
domcox@2 92 </tr>
domcox@2 93 <tr>
al@11 94 <td>iso</td>
al@11 95 <td>name of the ISO file, example: <code>~/slitaz-rolling.iso</code>.
al@11 96 Type <code>tazinst list iso</code> to list iso files on your
al@11 97 disks.</td>
domcox@2 98 </tr>
domcox@2 99 <tr>
al@11 100 <td>web</td>
al@11 101 <td>name of the image on the web, example: <code>stable cooking rolling
al@11 102 base core gtkonly justx</code>, for a full list type <code>tazinst
al@11 103 list web</code>, or enter the full URL of the image, example:
al@11 104 <code>http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso</code>.
al@11 105 </td>
domcox@2 106 </tr>
al@11 107 </table>
domcox@0 108
domcox@0 109
al@11 110 <h3 id="root_uuid">root_uuid</h3>
domcox@0 111
al@11 112 <p>The name of the target partition SliTaz will install to. Type <code>tazinst
al@11 113 list uuid</code> to list partitions on your disks.</p>
domcox@0 114
domcox@0 115
al@11 116 <h3 id="root_format">root_format</h3>
domcox@0 117
al@11 118 <p>Optional. If this setting is used, the target partition will be formatted in
al@11 119 the file system specified, otherwise the partition will be cleaned and /home
al@11 120 will be preserved. Type <code>tazinst help format</code> to get the list of all
al@11 121 supported filesystems, and <code>tazinst list root_format</code> to see
al@11 122 filesystems already installed on your system.</p>
domcox@0 123
domcox@2 124
al@11 125 <h3 id="home_uuid">home_uuid</h3>
domcox@2 126
al@11 127 <p>Optional. A separate home partition may be created if needed. This setting
al@11 128 indicates if need be, the name of the partition to receive the /home
al@11 129 directory.</p>
domcox@2 130
al@11 131
al@11 132 <h3 id="home_format">home_format</h3>
al@11 133
al@11 134 <p>Optional. If this setting is used, a separate /home partition will be
al@11 135 created, this partition will be formatted in the file system specified.</p>
al@11 136
al@11 137
al@11 138 <h3 id="hostname">hostname</h3>
al@11 139
al@11 140 <p>Optional. Hostname of the system, <code>slitaz</code> by default.</p>
al@11 141
al@11 142
al@11 143 <h3 id="root_pwd">root_pwd</h3>
al@11 144
al@11 145 <p>Optional. Superuser [root] password, <code>root</code>, by default.</p>
al@11 146
al@11 147
al@11 148 <h3 id="user_login">user_login</h3>
al@11 149
al@11 150 <p>Optional. First user name, <code>tux</code> by default.</p>
al@11 151
al@11 152
al@11 153 <h3 id="user_pwd">user_pwd</h3>
al@11 154
al@11 155 <p>Optional. First user password, <code>tux</code> by default.</p>
al@11 156
al@11 157
al@11 158 <h3 id="bootloader">bootloader</h3>
al@11 159
al@11 160 <p>Optional. Install a bootloader. Usually you should set it to
al@11 161 <code>auto</code> unless you want to use an already installed bootloader on your
al@11 162 system, install a bootloader by hand yourself or install a specific bootloader.
al@11 163 In this case type <code>tazinst help bootloader</code> to list supported
al@11 164 bootloaders.</p>
al@11 165
al@11 166
al@11 167 <h3 id="winboot">winboot</h3>
al@11 168
al@11 169 <p>Optional. If a bootloader is installed, this setting indicates the partition
al@11 170 containing Windows™ to implement a dual-boot. It can also be set to
al@11 171 <code>auto</code>, in this case the dual-boot will be on the first Windows™
al@11 172 partition. Type <code>tazinst list winboot</code> to see values tazinst
al@11 173 automatically detects.</p>
al@11 174
domcox@0 175
domcox@0 176 <h2>COMMANDS</h2>
domcox@0 177
al@11 178
al@11 179 <h3 id="new">new</h3>
al@11 180
al@11 181 <p>Generates a new self-documenting install file containing settings which, when
al@11 182 set up as required by the user, will allow tazinst to execute an unattended
Hans-G?nter@93 183 installation. The default file is <code>./tazinst.rc</code>, but an optional file
al@11 184 name may be given as a parameter.</p>
al@11 185
domcox@2 186 <h5>Examples:</h5>
al@11 187
domcox@0 188 <pre>
domcox@2 189 tazinst new
domcox@0 190 tazinst new /var/lib/tazinst.conf
domcox@0 191 </pre>
domcox@0 192
al@11 193
al@11 194 <h3 id="set">set</h3>
al@11 195
al@11 196 <p>Assign a new value to a given setting.</p>
al@11 197
domcox@2 198 <h5>Examples:</h5>
al@11 199
domcox@0 200 <pre>
domcox@2 201 tazinst set mode install
domcox@2 202 tazinst set mode install /var/lib/tazinst.conf
domcox@0 203 </pre>
domcox@0 204
al@11 205
al@11 206 <h3 id="unset">unset</h3>
al@11 207
al@11 208 <p>Unset, clears a setting.</p>
al@11 209
domcox@2 210 <h5>Examples:</h5>
al@11 211
domcox@0 212 <pre>
domcox@2 213 tazinst unset mode
domcox@2 214 tazinst unset mode /var/lib/tazinst.conf
domcox@0 215 </pre>
domcox@0 216
al@11 217
al@11 218 <h3 id="get">get</h3>
al@11 219
al@11 220 <p>Get the value of a setting. Without a parameter, gets the values of all
al@11 221 settings.</p>
al@11 222
domcox@2 223 <h5>Examples:</h5>
al@11 224
domcox@0 225 <pre>
domcox@2 226 tazinst get
domcox@2 227 tazinst get mode
domcox@2 228 tazinst get mode /var/lib/tazinst.conf
domcox@0 229 </pre>
domcox@0 230
domcox@2 231
al@11 232 <h3 id="check">check</h3>
al@11 233
al@11 234 <p>Check a setting for errors. Without a parameter, checks all settings.</p>
al@11 235
domcox@2 236 <h5>Examples:</h5>
al@11 237
domcox@0 238 <pre>
domcox@2 239 tazinst check
domcox@2 240 tazinst check mode
domcox@2 241 tazinst check mode /var/lib/tazinst.conf
domcox@2 242 </pre>
domcox@2 243
al@11 244
al@11 245 <h3 id="list">list</h3>
al@11 246
al@11 247 <p>List the system resources. Resources are:</p>
al@11 248
al@11 249 <table>
domcox@2 250 <tr>
al@11 251 <td>mode</td>
al@11 252 <td>Available modes of install</td>
domcox@2 253 </tr>
domcox@2 254 <tr>
al@11 255 <td>media</td>
al@11 256 <td>Available media to install from. Example: cdrom is not listed on
al@11 257 systems with no cdrom drive</td>
domcox@2 258 </tr>
domcox@2 259 <tr>
al@11 260 <td>usb</td>
al@11 261 <td>Partitions of USB disks</td>
domcox@2 262 </tr>
domcox@2 263 <tr>
al@11 264 <td>iso</td>
al@11 265 <td>Iso images located on local drives, in /root, and in all user's home
al@11 266 and first subdirectory</td>
domcox@2 267 </tr>
domcox@2 268 <tr>
al@11 269 <td>web</td>
al@11 270 <td>Predefined names of iso images to download automatically from the
al@11 271 Internet</td>
domcox@2 272 </tr>
domcox@2 273 <tr>
al@11 274 <td>format</td>
al@11 275 <td>Installed filesystems</td>
domcox@2 276 </tr>
domcox@2 277 <tr>
al@11 278 <td>bootloader</td>
al@11 279 <td>Available bootloaders</td>
domcox@2 280 </tr>
domcox@2 281 <tr>
al@11 282 <td>partition_table</td>
al@11 283 <td>Partition table schemes of local disks</td>
domcox@2 284 </tr>
domcox@2 285 <tr>
al@11 286 <td>winboot</td>
al@11 287 <td>Bootable Windows™ partitions</td>
domcox@2 288 </tr>
al@11 289 </table>
al@11 290
domcox@2 291 <h5>Examples:</h5>
al@11 292
domcox@2 293 <pre>
domcox@2 294 tazinst list
domcox@2 295 tazinst list media
domcox@2 296 </pre>
domcox@2 297
al@11 298
al@11 299 <h3 id="execute">execute</h3>
al@11 300
al@11 301 <p>Performs a SliTaz install on a HDD based on data in the install file. If you
al@11 302 selected to format your HDD, all data will be lost. If you do not, all data
al@11 303 except for any existing /home directory will be removed, (the home directory
al@11 304 will be kept as is).</p>
al@11 305
domcox@2 306 <h5>Examples:</h5>
al@11 307
domcox@2 308 <pre>
domcox@2 309 tazinst execute
domcox@2 310 tazinst execute /var/lib/tazinst.conf
domcox@2 311 </pre>
domcox@2 312
al@11 313
al@11 314 <h3 id="clean">clean</h3>
al@11 315
al@11 316 <p>Remove installation and log files.</p>
al@11 317
domcox@2 318 <h5>Examples:</h5>
al@11 319
domcox@2 320 <pre>
domcox@2 321 tazinst clean
domcox@2 322 tazinst clean /var/lib/tazinst.conf
domcox@0 323 </pre>
domcox@0 324
al@11 325
al@11 326 <h3 id="log">log</h3>
al@11 327
al@11 328 <p>Display the last log file contents and exit.</p>
al@11 329
domcox@2 330 <h5>Example:</h5>
al@11 331
domcox@0 332 <pre>
domcox@0 333 tazinst log
domcox@0 334 </pre>
domcox@0 335
al@11 336
al@11 337 <h3 id="version">version</h3>
al@11 338
al@11 339 <p>Print the version information and exit.</p>
al@11 340
domcox@2 341 <h5>Example:</h5>
al@11 342
domcox@0 343 <pre>
domcox@0 344 tazinst version
domcox@0 345 </pre>
domcox@0 346
al@11 347
al@11 348 <h3 id="usage">usage</h3>
al@11 349
al@11 350 <p>Print a short help and exit.</p>
al@11 351
domcox@2 352 <h5>Example:</h5>
al@11 353
domcox@2 354 <pre>
domcox@2 355 tazinst usage
domcox@2 356 </pre>
domcox@2 357
al@11 358
al@11 359 <h3 id="help">help</h3>
al@11 360
al@11 361 <p>Print a short help for a given setting and exit. Without an argument, print a
al@11 362 short help for all settings.</p>
al@11 363
domcox@2 364 <h5>Example:</h5>
al@11 365
domcox@2 366 <pre>
domcox@2 367 tazinst help mode
domcox@2 368 </pre>
domcox@2 369
domcox@2 370
domcox@2 371 <h2>EXAMPLES</h2>
domcox@2 372
al@11 373
domcox@2 374 <h3>Install</h3>
domcox@2 375
al@11 376 <p>How to Install SliTaz on a partition of your hard disk drive. The root
al@11 377 partition is not formatted, all data except for any existing <code>/home</code>
al@11 378 directory will be removed, (the <code>home</code> directory will be kept as
al@11 379 is).</p>
domcox@0 380
domcox@2 381 <ol>
al@11 382 <li>Create an install file:
al@11 383 <pre># tazinst new</pre></li>
al@11 384 <li>Set the mode as install:
al@11 385 <pre># tazinst set mode install</pre></li>
al@11 386 <li>Use a cdrom as source:
al@11 387 <pre># tazinst set media cdrom</pre></li>
al@11 388 <li>Select the partition to install SliTaz on:
al@11 389 <pre># tazinst set root_uuid /dev/hda1</pre></li>
al@11 390 <li>Install a bootloader:
al@11 391 <pre># tazinst set bootloader auto</pre></li>
al@11 392 <li>Execute an installation:
al@11 393 <pre># tazinst execute</pre></li>
domcox@2 394 </ol>
domcox@2 395
al@11 396
domcox@2 397 <h3>Complex Install</h3>
domcox@2 398
al@11 399 <p>How to Install SliTaz on your hard disk drive with a separate home partition
al@11 400 and a Windows™ dual-boot. The /home and root partitions are both formatted, (all
al@11 401 existing data will be lost).</p>
domcox@0 402
domcox@0 403 <ol>
al@11 404 <li>Create an install file:
al@11 405 <pre># tazinst new</pre></li>
al@11 406 <li>Set the mode as install:
al@11 407 <pre># tazinst set mode install</pre></li>
al@11 408 <li>Use a Live USB as source:
al@11 409 <pre># tazinst set media usb</pre></li>
al@11 410 <li>Select a partition on the Live USB:
al@11 411 <pre># tazinst set source /dev/sda1</pre></li>
al@11 412 <li>Select the partition to install SliTaz on:
al@11 413 <pre># tazinst set root_uuid /dev/hda1</pre></li>
al@11 414 <li>Format / as ext4:
al@11 415 <pre># tazinst set root_format ext4</pre></li>
al@11 416 <li>Use a separate /home partition:
al@11 417 <pre># tazinst set home_uuid /dev/hda2</pre></li>
al@11 418 <li>Format /home as ext2:
al@11 419 <pre># tazinst set home_format ext2</pre></li>
al@11 420 <li>Install a bootloader:
al@11 421 <pre># tazinst set bootloader auto</pre></li>
al@11 422 <li>Set up a Windows™ dual-boot:
al@11 423 <pre># tazinst set winboot auto</pre></li>
al@11 424 <li>Execute an installation:
al@11 425 <pre># tazinst execute</pre></li>
al@11 426 <li>Remove any traces behind:
al@11 427 <pre># tazinst clean</pre></li>
domcox@0 428 </ol>
domcox@0 429
al@11 430
domcox@2 431 <h3>Upgrade</h3>
domcox@2 432
al@11 433 <p>How to upgrade an already installed SliTaz system on your hard disk drive.
al@11 434 Your <code>/home /etc /var/www</code> directories will be kept, all other
al@68 435 directories will be removed. Any additional packages added to your old SliTaz
al@11 436 system will be updated as long you have an active internet connection.</p>
domcox@0 437
domcox@0 438 <ol>
al@11 439 <li>Create an install file:
al@11 440 <pre># tazinst new</pre></li>
al@11 441 <li>Set the mode as upgrade:
al@11 442 <pre># tazinst set mode upgrade</pre></li>
al@11 443 <li>Use web as source:
al@11 444 <pre># tazinst set media web</pre></li>
al@11 445 <li>Select the stable image:
al@11 446 <pre># tazinst set source stable</pre></li>
al@68 447 <li>Select the partition containing SliTaz to upgrade:
al@11 448 <pre># tazinst set root_uuid /dev/hda1</pre></li>
al@11 449 <li>Install a bootloader:
al@11 450 <pre># tazinst set bootloader auto</pre></li>
al@11 451 <li>Execute an installation:
al@11 452 <pre># tazinst execute</pre></li>
domcox@0 453 </ol>
domcox@0 454
al@11 455
domcox@2 456 <h3>Tips</h3>
domcox@0 457
domcox@0 458 <ol>
al@11 459 <li>Not all settings are used depending on the mode of install. List all
al@11 460 settings to see which you need to edit:
al@11 461 <pre># tazinst get</pre></li>
al@11 462 <li>Check your settings before executing install:
al@11 463 <pre># tazinst check</pre></li>
domcox@0 464 </ol>
domcox@2 465
al@11 466
domcox@2 467 <h2>FILES</h2>
domcox@2 468
al@11 469
domcox@2 470 <h3>INSTALL FILE</h3>
domcox@2 471
al@11 472 <p>Settings are saved in the install file, then used by tazinst to execute an
Hans-G?nter@93 473 unattended installation. The default file is <code>./tazinst.rc</code>, but an
al@11 474 optional file name may be given as a parameter. The install file is
al@11 475 self-documented. The clean command erases this file.</p>
al@11 476
domcox@2 477
domcox@2 478 <h3>SYSTEM FILE</h3>
domcox@2 479
al@11 480 <p>The <code>/etc/slitaz/tazinst.conf</code> configuration file allows you to
al@11 481 change the default settings of <code>tazinst</code> in case you want to use
al@11 482 default custom values.</p>
al@11 483
al@11 484 <p>All settings are customisable, if a particular setting is missing, just add
al@11 485 the name of the setting in caps and enter the new value.</p>
domcox@2 486
domcox@2 487 <h4>Example:</h4>
domcox@2 488
al@11 489 <p>If you intend to always install SliTaz from the same iso on the web, you just
al@11 490 have to modify or add the following values:</p>
al@11 491
al@11 492 <pre>
al@11 493 MEDIA="web"
al@11 494 SOURCE="stable"
al@11 495 </pre>
domcox@2 496
domcox@2 497 <h3>LOG FILE</h3>
domcox@2 498
al@11 499 <p>The file <code>/var/log/tazinst.log</code> contains a log of the install
al@11 500 process. The clean command erases this file.</p>
al@11 501
domcox@0 502
domcox@0 503 <h2>MAINTAINERS</h2>
al@11 504
al@11 505 <p>Christophe Lincoln &lt;pankso at slitaz.org&gt;<br />
al@11 506 Dominique Corbex &lt;domcox at slitaz.org&gt;</p>
domcox@0 507
domcox@0 508 <!-- End of content -->
domcox@0 509 </div>
domcox@0 510
al@11 511 <footer>
Hans-G?nter@93 512 Copyright © 2017-<span class="year"></span> <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a>
al@11 513 </footer>
domcox@0 514
domcox@0 515 </body>
domcox@0 516 </html>