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

tazinst: add en docs (feel free to edit)
author Paul Issott <paul@slitaz.org>
date Mon Jun 06 19:00:25 2011 +0100 (2011-06-06)
parents
children a339d3240495
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>
paul@619 26 tazinst [command] [configuration file]
paul@619 27 </pre>
paul@619 28
paul@619 29 <h2>DESCRIPTION</h2>
paul@619 30 <p>
paul@619 31 Tazinst is a lightweight SliTaz HDD installer (~ 29 KB). It installs SliTaz to a hard drive from a
paul@619 32 Live-CD, LiveUSB key, a SliTaz ISO image, or from the web by downloading a stable
paul@619 33 version, a cooking version or by giving the http link of another iso (eg: Development ISO).
paul@619 34 </p>
paul@619 35 <p>
paul@619 36 Tazinst can format the target partition to ext2, ext3, ext4 or other formats if the
paul@619 37 matching packages are installed. The home partition can be installed on another
paul@619 38 partition and if need be formatted before installation into any one of the available
paul@619 39 formats. Tazinst may upon request install the Grub bootloader in the MBR of the target
paul@619 40 disk. A dual-boot with an existing Windows© partition is possible, finding the Windows©
paul@619 41 partition can either be done automatically or manually specified.
paul@619 42 </p>
paul@619 43 <p>
paul@619 44 Tazinst can also update SliTaz installed on a hard disk partition which is handy
paul@619 45 in case of version changes. In this case, Slitaz is updated, data in /home is
paul@619 46 preserved and additional packages are reinstalled on to the new version.
paul@619 47 </p>
paul@619 48 <p>
paul@619 49 Tazinst was created independently for the needs of the SliTaz GNU/Linux mini distribution.
paul@619 50 </p>
paul@619 51 <p>
paul@619 52 Tazinst is written from scratch in shell script and is compatible with Busybox Ash and Bash.
paul@619 53 Tazinst is licensed under the GNU Free gpl v3.
paul@619 54 </p>
paul@619 55
paul@619 56 <h2>COMMANDS</h2>
paul@619 57 <a name="config"></a>
paul@619 58 <h3>config</h3>
paul@619 59 <p>
paul@619 60 Generates a self-documenting configuration file which when edited as required by the user
paul@619 61 will install or update SliTaz to a hard drive using tazinst install [filename].
paul@619 62 </p>
paul@619 63 <pre>
paul@619 64 tazinst config /var/lib/tazinst.conf
paul@619 65 </pre>
paul@619 66
paul@619 67 <p>
paul@619 68 The configuration file contains the following variables:
paul@619 69 </p>
paul@619 70 <ul>
paul@619 71 <li>The variables describing the installation source:</li>
paul@619 72 </ul>
paul@619 73
paul@619 74 <ol>
paul@619 75 <li class="level1"><div class="li"> * INST_TYPE : the type of media containing
paul@619 76 the SliTaz source files, either: cdrom (SliTaz LiveCD), usb
paul@619 77 (SliTaz LiveUSB), iso (ISO image of SliTaz), web (ISO image on the Web),
paul@619 78 weboot, ex : <code>INST_TYPE=web</code></div>
paul@619 79 </li>
paul@619 80 <li class="level1"><div class="li"> * SRC_FILE : the name of the source file containing
paul@619 81 SliTaz. It depends on the type of support:
paul@619 82 <ul>
paul@619 83 <li class="level2"><div class="li">cdrom (SliTaz LiveCD) :
paul@619 84 <i>unused</i></div>
paul@619 85 </li>
paul@619 86 <li class="level2"><div class="li">usb (SliTaz LiveUSB) : name of the
paul@619 87 partition on the host USB device, ex : <code>SRC_FILE=/dev/sdb1</code>
paul@619 88 </div>
paul@619 89 </li>
paul@619 90 <li class="level2"><div class="li">iso (ISO image of SliTaz) : name of the
paul@619 91 ISO file, ex : <code>SRC_FILE=~/slitaz.3.0.iso</code></div>
paul@619 92 </li>
paul@619 93 <li class="level2"><div class="li">web (ISO image on the Web) : name of the
paul@619 94 URL, ex : <code>
paul@619 95 SRC_FILE=http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso</code>.
paul@619 96 Note that 3 URLs are predefined: 'stable', 'cooking, 'rolling', ex :
paul@619 97 <code>SRC_FILE=cooking</code> downloads the latest cooking available
paul@619 98 from the web</div>
paul@619 99 </li>
paul@619 100 <li class="level2"><div class="li">weboot : <i>unused</i></div></li>
paul@619 101 </ul></div>
paul@619 102 </li>
paul@619 103 </ol>
paul@619 104
paul@619 105 <ul>
paul@619 106 <li class="level1"><div class="li"> The variables describing the target
paul@619 107 partition: </div>
paul@619 108 </li>
paul@619 109 </ul>
paul@619 110
paul@619 111 <ol>
paul@619 112 <li class="level1"><div class="li"> * TGT_PARTITION : the name of the target
paul@619 113 partition SliTaz will install to or update, ex : <code>TGT_PARTITION=
paul@619 114 /dev/hda3</code></div>
paul@619 115 </li>
paul@619 116 <li class="level1"><div class="li">TGT_FS : if this variable is entered, the
paul@619 117 target partition will be formatted in the file system specified, otherwise
paul@619 118 the partition will be cleaned and /home will be preserved, ex : <code>
paul@619 119 TGT_FS=ext3</code></div>
paul@619 120 </li>
paul@619 121 <li class="level1"><div class="li">TGT_HOME : this variable indicates if need
paul@619 122 be, the name of the partition to receive the /home directory, ex : <code>
paul@619 123 TGT_HOME=/dev/hda5</code></div>
paul@619 124 </li>
paul@619 125 <li class="level1"><div class="li">TGT_HOME_FS : if this variable is entered,
paul@619 126 the home partition will be formatted in the file system specified,
paul@619 127 ex : <code>TGT_HOME_FS=ext2</code></div>
paul@619 128 </li>
paul@619 129 </ol>
paul@619 130
paul@619 131 <ul>
paul@619 132 <li class="level1"><div class="li"> The configuration variables:
paul@619 133 </div>
paul@619 134 </li>
paul@619 135 </ul>
paul@619 136
paul@619 137 <ol>
paul@619 138 <li class="level1"><div class="li">TGT_HOSTNAME : name of the system, ex : <code>
paul@619 139 TGT_HOSTNAME=hd-slitaz</code>, by default <code>TGT_HOSTNAME=slitaz</code>
paul@619 140 </div>
paul@619 141 </li>
paul@619 142 <li class="level1"><div class="li">TGT_ROOT_PWD : superuser password, ex :
paul@619 143 <code>TGT_ROOT_PWD=toor</code>, by default <code>
paul@619 144 TGT_ROOT_PWD=root</code></div>
paul@619 145 </li>
paul@619 146 <li class="level1"><div class="li">TGT_USER : user name,
paul@619 147 ex : <code>TGT_USER=toto</code>, by default <code>TGT_USER=tux</code></div>
paul@619 148 </li>
paul@619 149 <li class="level1"><div class="li">TGT_USER_PWD : user password,
paul@619 150 ex : <code>TGT_USER_PWD=titi</code>, by default
paul@619 151 <code>TGT_USER_PWD=tux</code></div>
paul@619 152 </li>
paul@619 153 </ol>
paul@619 154
paul@619 155 <ul>
paul@619 156 <li class="level1"><div class="li"> The boot loader (bootloader) configuration variables: </div>
paul@619 157 </li>
paul@619 158 </ul>
paul@619 159
paul@619 160 <ol>
paul@619 161 <li>TGT_GRUB : install the GRUB bootloader (yes or no), ex :
paul@619 162 <code>TGT_GRUB=yes</code>, by default <code>TGT_GRUB=no</code>
paul@619 163 </li>
paul@619 164 <li class="level1"><div class="li">TGT_MENU_PARTITION : name of the partition
paul@619 165 where the GRUB configuration file is installed. Normally, this variable is not
paul@619 166 set, it can be used if GRUB is installed to a dedicated partition, or in a
paul@619 167 multi-os configuration,
paul@619 168 ex : <code>TGT_MENU_PARTITION=/dev/hda4</code></div>
paul@619 169 </li>
paul@619 170 <li class="level1"><div class="li">TGT_WINBOOT : if this variable is entered,
paul@619 171 it indicates the partition containing Windows© to implement a dual-boot. It can
paul@619 172 also be set to 'auto', in this case the dual-boot will be on the first partition
paul@619 173 Windows© detected,
paul@619 174 ex : <code>TGT_WINBOOT=auto</code></div>
paul@619 175 </li>
paul@619 176 </ol>
paul@619 177
paul@619 178 <p>
paul@619 179 Note that only variables preceded by a asterisk are mandatory, others are optional. Thus a minimal configuration file can be:
paul@619 180 </p>
paul@619 181 <pre>
paul@619 182 INST_TYPE=cdrom
paul@619 183 TGT_PARTITION=/dev/hda3
paul@619 184 </pre>
paul@619 185 <p>
paul@619 186 This file will install SliTaz on /dev/hda3 formatting the partition from a LiveCD.
paul@619 187 </p>
paul@619 188
paul@619 189 <a name="install"></a>
paul@619 190 <h3>install</h3>
paul@619 191 <p>
paul@619 192 Launch the SliTaz installer based on data in the configuration file.
paul@619 193 </p>
paul@619 194 <pre>
paul@619 195 tazinst install /var/lib/tazinst.conf
paul@619 196 </pre>
paul@619 197
paul@619 198 <a name="upgrade"></a>
paul@619 199 <h3>upgrade</h3>
paul@619 200 <p>
paul@619 201 Launch and upgrade SliTaz based on data in the configuration file.
paul@619 202 </p>
paul@619 203 <pre>
paul@619 204 tazinst upgrade /var/lib/tazinst.conf
paul@619 205 </pre>
paul@619 206
paul@619 207 <h2>MAINTAINERS</h2>
paul@619 208 <p>
paul@619 209 Christophe Lincoln &lt;pankso at slitaz.org&gt; <br />
paul@619 210 Dominique Corbex &lt;domcox at slitaz.org&gt;
paul@619 211 </p>
paul@619 212
paul@619 213 <!-- End of content -->
paul@619 214 </div>
paul@619 215
paul@619 216 <div id="footer">
paul@619 217 Copyright &copy; 2011 <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a>
paul@619 218 </div>
paul@619 219
paul@619 220 </body>
paul@619 221 </html>