tazinst diff doc/tazinst.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 | 256a06ea3d55 |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/doc/tazinst.html Thu Feb 14 12:48:04 2013 +0100 1.3 @@ -0,0 +1,355 @@ 1.4 +<!DOCTYPE html> 1.5 +<html xmlns="http://www.w3.org/1999/xhtml"> 1.6 +<head> 1.7 + <title>Tazinst Manual - Manual for 'tazinst' installer</title> 1.8 + <meta charset="utf-8" /> 1.9 + <link rel="shortcut icon" href="favicon.ico" /> 1.10 + <link rel="stylesheet" type="text/css" href="style.css" /> 1.11 +</head> 1.12 +<body> 1.13 + 1.14 +<!-- Header --> 1.15 +<div id="header"> 1.16 + <h1>Tazinst Manual</h1> 1.17 +</div> 1.18 + 1.19 +<!-- Start content --> 1.20 +<div id="content"> 1.21 + 1.22 +<h2>NAME</h2> 1.23 +<p> 1.24 + Tazinst - Tiny autonomous zone installer manager 1.25 +</p> 1.26 + 1.27 +<h2>SYNTAX</h2> 1.28 +<pre> 1.29 +tazinst [command] [option] 1.30 +</pre> 1.31 + 1.32 +<h2>DESCRIPTION</h2> 1.33 +<p> 1.34 + Tazinst is a lightweight SliTaz HDD installer (~ 31 KB). It installs SliTaz 1.35 + to a hard drive from a Live-CD, a LiveUSB key, a SliTaz ISO image, or from 1.36 + the web by downloading a stable, cooking or rolling version or by giving 1.37 + the http link of another iso (eg: Development ISO). 1.38 +</p> 1.39 +<p> 1.40 + Tazinst can format the target partition to ext2, ext3, ext4 or other formats 1.41 + if the matching packages are installed. The home partition can be installed 1.42 + on another partition and if need be, formatted before installation into any 1.43 + one of the available formats. Tazinst may upon request install the Grub 1.44 + bootloader in the MBR of the target disk. A dual-boot with an existing 1.45 + Windows© partition is possible, finding the Windows© partition can either be 1.46 + done automatically or manually specified. 1.47 +</p> 1.48 +<p> 1.49 + Tazinst can also update SliTaz installed on a hard disk partition which is 1.50 + handy in case of version changes. In this case, Slitaz is updated, data in 1.51 + /home is preserved and additional packages are reinstalled on to the new 1.52 + version. 1.53 +</p> 1.54 +<p> 1.55 + Tazinst was created independently for the needs of the SliTaz GNU/Linux mini 1.56 + distribution. 1.57 +</p> 1.58 +<p> 1.59 + Tazinst is written from scratch in shell script and is compatible with 1.60 + Busybox Ash and Bash. Tazinst is licensed under the GNU Free gpl v3. 1.61 +</p> 1.62 + 1.63 +<h2>SETUP FILE</h2> 1.64 +<p> 1.65 + Tazinst installer is able to perform an installation automatically based on 1.66 + a simple setup file with clear variables such as: 1.67 + <code>INST_TYPE="iso"</code>, <code>TGT_PARTITION="/dev/hda1"</code>. 1.68 + 1.69 + With this way, it allows developers to create a different kind of frontend: 1.70 + Dialog, GTK and CGI/web in TazPanel. The frontend just has to create a 1.71 + setup file and start the cmdline installer and report steps in a nice way 1.72 + (progress bar or/and messages). 1.73 +</p> 1.74 +<p> 1.75 + The setup file contains the following variables: 1.76 +</p> 1.77 +<ul> 1.78 + <li class="level1"><div class="li"> 1.79 + The variables describing the installation source: 1.80 + 1.81 +<ol> 1.82 + <li class="level1"><div class="li"> 1.83 + <strong>*INST_TYPE</strong>: the type of media containing the SliTaz source 1.84 + files, either: <strong>cdrom</strong> (SliTaz LiveCD), <strong>usb</strong> 1.85 + (SliTaz LiveUSB), <strong>iso</strong> (ISO image of SliTaz), 1.86 + <strong>web</strong> (ISO image on the Web), <strong>weboot</strong>, 1.87 + ex: <code>INST_TYPE=web</code> 1.88 + </div></li> 1.89 + <li class="level1"><div class="li"> 1.90 + <strong>SRC_FILE</strong>: the name of the source file containing SliTaz. 1.91 + It depends on the type of support: 1.92 + <ul> 1.93 + <li class="level2"><div class="li">cdrom (SliTaz LiveCD): 1.94 + <i>unused</i> 1.95 + </div></li> 1.96 + <li class="level2"><div class="li">usb (SliTaz LiveUSB): name of the 1.97 + partition on the host USB device, ex: <code>SRC_FILE=/dev/sdb1</code> 1.98 + </div></li> 1.99 + <li class="level2"><div class="li">iso (ISO image of SliTaz): name of the 1.100 + ISO file, ex: <code>SRC_FILE=~/slitaz.3.0.iso</code> 1.101 + </div></li> 1.102 + <li class="level2"><div class="li">web (ISO image on the Web): name of the 1.103 + URL, ex: <code> 1.104 + SRC_FILE=http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso</code>. 1.105 + Note that 3 URLs are predefined: 'stable', 'cooking, 'rolling', ex: 1.106 + <code>SRC_FILE=cooking</code> downloads the latest cooking available 1.107 + from the web 1.108 + </div></li> 1.109 + <li class="level2"><div class="li">weboot: <i>unused</i> 1.110 + </div></li> 1.111 + </ul> 1.112 + </div></li> 1.113 +</ol> 1.114 +</div></li> 1.115 +</ul> 1.116 + 1.117 +<ul> 1.118 + <li class="level1"><div class="li">The variables describing the target 1.119 + partition: 1.120 + 1.121 +<ol> 1.122 + <li class="level1"><div class="li"> 1.123 + <strong>*TGT_PARTITION</strong>: the name of the target partition SliTaz 1.124 + will install to or update, 1.125 + ex: <code>TGT_PARTITION=/dev/hda3</code> 1.126 + </div></li> 1.127 + <li class="level1"><div class="li"> 1.128 + <strong>TGT_FS</strong>: if this variable is entered, the target partition 1.129 + will be formatted in the file system specified, otherwise the partition will 1.130 + be cleaned and /home will be preserved, ex: <code>TGT_FS=ext3</code> 1.131 + </div></li> 1.132 + <li class="level1"><div class="li"> 1.133 + <strong>TGT_HOME</strong>: this variable indicates if need be, the name of 1.134 + the partition to receive the /home directory, 1.135 + ex: <code>TGT_HOME=/dev/hda5</code> 1.136 + </div></li> 1.137 + <li class="level1"><div class="li"> 1.138 + <strong>TGT_HOME_FS</strong>: if this variable is entered, the home 1.139 + partition will be formatted in the file system specified, 1.140 + ex: <code>TGT_HOME_FS=ext2</code> 1.141 + </div></li> 1.142 +</ol> 1.143 +</div></li> 1.144 +</ul> 1.145 + 1.146 +<ul> 1.147 + <li class="level1"><div class="li">The system settings: 1.148 + 1.149 +<ol> 1.150 + <li class="level1"><div class="li"> 1.151 + <strong>TGT_HOSTNAME</strong>: name of the system, 1.152 + ex: <code>TGT_HOSTNAME=hd-slitaz</code>, by default 1.153 + <code>TGT_HOSTNAME=slitaz</code> 1.154 + </div></li> 1.155 + <li class="level1"><div class="li"> 1.156 + <strong>TGT_ROOT_PWD</strong>: superuser password, 1.157 + ex: <code>TGT_ROOT_PWD=toor</code>, by default 1.158 + <code>TGT_ROOT_PWD=root</code> 1.159 + </div></li> 1.160 + <li class="level1"><div class="li"> 1.161 + <strong>TGT_USER</strong>: user name, 1.162 + ex: <code>TGT_USER=toto</code>, by default <code>TGT_USER=tux</code> 1.163 + </div></li> 1.164 + <li class="level1"><div class="li"> 1.165 + <strong>TGT_USER_PWD</strong>: user password, 1.166 + ex: <code>TGT_USER_PWD=titi</code>, by default 1.167 + <code>TGT_USER_PWD=tux</code> 1.168 + </div></li> 1.169 +</ol> 1.170 +</div></li> 1.171 +</ul> 1.172 + 1.173 +<ul> 1.174 + <li class="level1"><div class="li"> The boot loader (bootloader) 1.175 + configuration variables: 1.176 + 1.177 +<ol> 1.178 + <li class="level1"><div class="li"> 1.179 + <strong>TGT_GRUB</strong>: install the GRUB bootloader (yes or no), 1.180 + ex: <code>TGT_GRUB=yes</code>, by default <code>TGT_GRUB=no</code> 1.181 + </div></li> 1.182 + <li class="level1"><div class="li"> 1.183 + <strong>TGT_WINBOOT</strong>: if this variable is entered, it indicates the 1.184 + partition containing Windows© to implement a dual-boot. It can also be set 1.185 + to 'auto', in this case the dual-boot will be on the first partition 1.186 + Windows© detects, 1.187 + ex: <code>TGT_WINBOOT=auto</code> 1.188 + </div></li> 1.189 +</ol> 1.190 +</div></li> 1.191 +</ul> 1.192 + 1.193 +<p> 1.194 + Note that only variables preceded by a asterisk are mandatory, others are 1.195 + optional. Thus a minimal setup file can be: 1.196 +</p> 1.197 +<pre> 1.198 +INST_TYPE=cdrom 1.199 +TGT_PARTITION=/dev/hda3 1.200 +</pre> 1.201 +<p> 1.202 + This file will install SliTaz on /dev/hda3 formatting the partition from a 1.203 + LiveCD. 1.204 +</p> 1.205 + 1.206 +<h2>COMMANDS</h2> 1.207 + 1.208 +<a id="new"></a> 1.209 +<h3>new</h3> 1.210 +<p> 1.211 + Generates a new self-documenting setup file which when edited as required 1.212 + by the user will install or update SliTaz to a hard drive. 1.213 +</p> 1.214 +<pre> 1.215 +tazinst new /var/lib/tazinst.conf 1.216 +</pre> 1.217 + 1.218 + 1.219 +<a id="install"></a> 1.220 +<h3>install</h3> 1.221 +<p> 1.222 + Performs a SliTaz install on a HDD based on data in the setup file. 1.223 + If you decide to format your HDD, all data will be lost. If you do not 1.224 + format, all data except for any existing /home directory will be removed, 1.225 + the home directory will be kept as is. 1.226 +</p> 1.227 +<pre> 1.228 +tazinst install /var/lib/tazinst.conf 1.229 +</pre> 1.230 + 1.231 +<a id="upgrade"></a> 1.232 +<h3>upgrade</h3> 1.233 +<p> 1.234 + Upgrade an existing SliTaz system on a HDD based on data in the setup file. 1.235 + Your /home /etc /var/www directories will be kept, all other directories 1.236 + will be removed. Any additional package added to your old Slitaz system 1.237 + will be updated as long you have an active internet connection. 1.238 +</p> 1.239 +<pre> 1.240 +tazinst upgrade /var/lib/tazinst.conf 1.241 +</pre> 1.242 + 1.243 +<a id="showurl"></a> 1.244 +<h3>showurl</h3> 1.245 +<p> 1.246 + Display the full URL of the predefined shortcuts: 'stable', 'cooking, 1.247 + 'rolling'. 1.248 +</p> 1.249 +<p> 1.250 + Note: You may overwrite these shortcuts in the system file: 1.251 + /etc/slitaz/tazinst.conf. 1.252 +</p> 1.253 +<pre> 1.254 +tazinst showurl stable 1.255 +</pre> 1.256 + 1.257 +<a id="check"></a> 1.258 +<h3>check</h3> 1.259 +<p> 1.260 + Check a setup file for errors. 1.261 +</p> 1.262 +<pre> 1.263 +tazinst check /var/lib/tazinst.conf 1.264 +</pre> 1.265 + 1.266 +<a id="log"></a> 1.267 +<h3>log</h3> 1.268 +<p> 1.269 + Display the last log file contents and exit. 1.270 +</p> 1.271 +<pre> 1.272 +tazinst log 1.273 +</pre> 1.274 + 1.275 +<a id="version"></a> 1.276 +<h3>version</h3> 1.277 +<p> 1.278 + Print the version information and exit. 1.279 +</p> 1.280 +<pre> 1.281 +tazinst version 1.282 +</pre> 1.283 + 1.284 +<h2>SYSTEM FILE</h2> 1.285 +<p> 1.286 + The /etc/slitaz/tazinst.conf configuration file allows you to change the default 1.287 + settings of tazinst, if you want to use custom values for URLs, directories 1.288 + and files, you'll have to create one and modify the following variables: 1.289 +</p> 1.290 + 1.291 +<ul> 1.292 +<li class="level1"><div class="li">Predefined urls: 1.293 + 1.294 +<ol> 1.295 + <li class="level1"><div class="li">URL of the current stable version:<br /> 1.296 + <code>URL_STABLE="http://mirror.slitaz.org/iso/stable/slitaz-4.0.iso" 1.297 + </code> 1.298 + </div></li> 1.299 + <li class="level1"><div class="li">URL of the current cooking version:<br /> 1.300 + <code>URL_COOKING="http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso" 1.301 + </code> 1.302 + </div></li> 1.303 + <li class="level1"><div class="li">URL of the current rolling version:<br /> 1.304 + <code>URL_ROLLING="http://mirror.slitaz.org/iso/rolling/slitaz-core.iso" 1.305 + </code> 1.306 + </div></li> 1.307 +</ol> 1.308 +</div></li> 1.309 +</ul> 1.310 + 1.311 +<ul> 1.312 +<li class="level1"><div class="li">Mount points: 1.313 + 1.314 +<ol> 1.315 + <li class="level1"><div class="li"> 1.316 + Source partition mount point:<br /> 1.317 + <code>SOURCE_ROOT="/media/source"</code> 1.318 + </div></li> 1.319 + <li class="level1"><div class="li"> 1.320 + Target partition mount point:<br /> 1.321 + <code>TARGET_ROOT="/mnt/target"</code> 1.322 + </div></li> 1.323 +</ol> 1.324 +</div></li> 1.325 +</ul> 1.326 + 1.327 +<ul> 1.328 +<li class="level1"><div class="li">Log and Debug: 1.329 + 1.330 +<ol> 1.331 + <li class="level1"><div class="li">Log File Location:<br /> 1.332 + <code>LOG="/var/log/tazinst.log"</code> 1.333 + </div></li> 1.334 + <li class="level1"><div class="li">Debugging: (quiet => 0, debug => 1)<br /> 1.335 + <code>DEBUG=0</code><br /> 1.336 + It is highly recommended to set <code>DEBUG=1</code> and attach the 1.337 + contents of the resulting Log file when sending a bug report to 1.338 + developers. 1.339 + </div></li> 1.340 +</ol> 1.341 +</div></li> 1.342 +</ul> 1.343 + 1.344 +<h2>MAINTAINERS</h2> 1.345 +<p> 1.346 + Christophe Lincoln <pankso at slitaz.org> <br /> 1.347 + Dominique Corbex <domcox at slitaz.org> 1.348 +</p> 1.349 + 1.350 +<!-- End of content --> 1.351 +</div> 1.352 + 1.353 +<div id="footer"> 1.354 + Copyright © 2012 <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a> 1.355 +</div> 1.356 + 1.357 +</body> 1.358 +</html>