slitaz-tools diff 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 |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/doc/tazinst.en.html Mon Jun 06 19:00:25 2011 +0100 1.3 @@ -0,0 +1,221 @@ 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] [configuration file] 1.30 +</pre> 1.31 + 1.32 +<h2>DESCRIPTION</h2> 1.33 +<p> 1.34 + Tazinst is a lightweight SliTaz HDD installer (~ 29 KB). It installs SliTaz to a hard drive from a 1.35 + Live-CD, LiveUSB key, a SliTaz ISO image, or from the web by downloading a stable 1.36 + version, a cooking version or by giving the http link of another iso (eg: Development ISO). 1.37 +</p> 1.38 +<p> 1.39 + Tazinst can format the target partition to ext2, ext3, ext4 or other formats if the 1.40 + matching packages are installed. The home partition can be installed on another 1.41 + partition and if need be formatted before installation into any one of the available 1.42 + formats. Tazinst may upon request install the Grub bootloader in the MBR of the target 1.43 + disk. A dual-boot with an existing Windows© partition is possible, finding the Windows© 1.44 + partition can either be done automatically or manually specified. 1.45 +</p> 1.46 +<p> 1.47 + Tazinst can also update SliTaz installed on a hard disk partition which is handy 1.48 + in case of version changes. In this case, Slitaz is updated, data in /home is 1.49 + preserved and additional packages are reinstalled on to the new version. 1.50 +</p> 1.51 +<p> 1.52 + Tazinst was created independently for the needs of the SliTaz GNU/Linux mini distribution. 1.53 +</p> 1.54 +<p> 1.55 + Tazinst is written from scratch in shell script and is compatible with Busybox Ash and Bash. 1.56 + Tazinst is licensed under the GNU Free gpl v3. 1.57 +</p> 1.58 + 1.59 +<h2>COMMANDS</h2> 1.60 +<a name="config"></a> 1.61 +<h3>config</h3> 1.62 +<p> 1.63 + Generates a self-documenting configuration file which when edited as required by the user 1.64 + will install or update SliTaz to a hard drive using tazinst install [filename]. 1.65 +</p> 1.66 +<pre> 1.67 +tazinst config /var/lib/tazinst.conf 1.68 +</pre> 1.69 + 1.70 +<p> 1.71 + The configuration file contains the following variables: 1.72 +</p> 1.73 +<ul> 1.74 + <li>The variables describing the installation source:</li> 1.75 +</ul> 1.76 + 1.77 +<ol> 1.78 + <li class="level1"><div class="li"> * INST_TYPE : the type of media containing 1.79 + the SliTaz source files, either: cdrom (SliTaz LiveCD), usb 1.80 + (SliTaz LiveUSB), iso (ISO image of SliTaz), web (ISO image on the Web), 1.81 + weboot, ex : <code>INST_TYPE=web</code></div> 1.82 + </li> 1.83 + <li class="level1"><div class="li"> * SRC_FILE : the name of the source file containing 1.84 + SliTaz. It depends on the type of support: 1.85 + <ul> 1.86 + <li class="level2"><div class="li">cdrom (SliTaz LiveCD) : 1.87 + <i>unused</i></div> 1.88 + </li> 1.89 + <li class="level2"><div class="li">usb (SliTaz LiveUSB) : name of the 1.90 + partition on the host USB device, ex : <code>SRC_FILE=/dev/sdb1</code> 1.91 + </div> 1.92 + </li> 1.93 + <li class="level2"><div class="li">iso (ISO image of SliTaz) : name of the 1.94 + ISO file, ex : <code>SRC_FILE=~/slitaz.3.0.iso</code></div> 1.95 + </li> 1.96 + <li class="level2"><div class="li">web (ISO image on the Web) : name of the 1.97 + URL, ex : <code> 1.98 + SRC_FILE=http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso</code>. 1.99 + Note that 3 URLs are predefined: 'stable', 'cooking, 'rolling', ex : 1.100 + <code>SRC_FILE=cooking</code> downloads the latest cooking available 1.101 + from the web</div> 1.102 + </li> 1.103 + <li class="level2"><div class="li">weboot : <i>unused</i></div></li> 1.104 + </ul></div> 1.105 + </li> 1.106 +</ol> 1.107 + 1.108 +<ul> 1.109 + <li class="level1"><div class="li"> The variables describing the target 1.110 + partition: </div> 1.111 + </li> 1.112 +</ul> 1.113 + 1.114 +<ol> 1.115 + <li class="level1"><div class="li"> * TGT_PARTITION : the name of the target 1.116 + partition SliTaz will install to or update, ex : <code>TGT_PARTITION= 1.117 + /dev/hda3</code></div> 1.118 + </li> 1.119 + <li class="level1"><div class="li">TGT_FS : if this variable is entered, the 1.120 + target partition will be formatted in the file system specified, otherwise 1.121 + the partition will be cleaned and /home will be preserved, ex : <code> 1.122 + TGT_FS=ext3</code></div> 1.123 + </li> 1.124 + <li class="level1"><div class="li">TGT_HOME : this variable indicates if need 1.125 + be, the name of the partition to receive the /home directory, ex : <code> 1.126 + TGT_HOME=/dev/hda5</code></div> 1.127 + </li> 1.128 + <li class="level1"><div class="li">TGT_HOME_FS : if this variable is entered, 1.129 + the home partition will be formatted in the file system specified, 1.130 + ex : <code>TGT_HOME_FS=ext2</code></div> 1.131 + </li> 1.132 +</ol> 1.133 + 1.134 +<ul> 1.135 + <li class="level1"><div class="li"> The configuration variables: 1.136 + </div> 1.137 + </li> 1.138 +</ul> 1.139 + 1.140 +<ol> 1.141 + <li class="level1"><div class="li">TGT_HOSTNAME : name of the system, ex : <code> 1.142 + TGT_HOSTNAME=hd-slitaz</code>, by default <code>TGT_HOSTNAME=slitaz</code> 1.143 + </div> 1.144 + </li> 1.145 + <li class="level1"><div class="li">TGT_ROOT_PWD : superuser password, ex : 1.146 + <code>TGT_ROOT_PWD=toor</code>, by default <code> 1.147 + TGT_ROOT_PWD=root</code></div> 1.148 + </li> 1.149 + <li class="level1"><div class="li">TGT_USER : user name, 1.150 + ex : <code>TGT_USER=toto</code>, by default <code>TGT_USER=tux</code></div> 1.151 + </li> 1.152 + <li class="level1"><div class="li">TGT_USER_PWD : user password, 1.153 + ex : <code>TGT_USER_PWD=titi</code>, by default 1.154 + <code>TGT_USER_PWD=tux</code></div> 1.155 + </li> 1.156 +</ol> 1.157 + 1.158 +<ul> 1.159 + <li class="level1"><div class="li"> The boot loader (bootloader) configuration variables: </div> 1.160 + </li> 1.161 +</ul> 1.162 + 1.163 +<ol> 1.164 + <li>TGT_GRUB : install the GRUB bootloader (yes or no), ex : 1.165 + <code>TGT_GRUB=yes</code>, by default <code>TGT_GRUB=no</code> 1.166 + </li> 1.167 + <li class="level1"><div class="li">TGT_MENU_PARTITION : name of the partition 1.168 + where the GRUB configuration file is installed. Normally, this variable is not 1.169 + set, it can be used if GRUB is installed to a dedicated partition, or in a 1.170 + multi-os configuration, 1.171 + ex : <code>TGT_MENU_PARTITION=/dev/hda4</code></div> 1.172 + </li> 1.173 + <li class="level1"><div class="li">TGT_WINBOOT : if this variable is entered, 1.174 + it indicates the partition containing Windows© to implement a dual-boot. It can 1.175 + also be set to 'auto', in this case the dual-boot will be on the first partition 1.176 + Windows© detected, 1.177 + ex : <code>TGT_WINBOOT=auto</code></div> 1.178 + </li> 1.179 +</ol> 1.180 + 1.181 +<p> 1.182 + Note that only variables preceded by a asterisk are mandatory, others are optional. Thus a minimal configuration file can be: 1.183 +</p> 1.184 +<pre> 1.185 +INST_TYPE=cdrom 1.186 +TGT_PARTITION=/dev/hda3 1.187 +</pre> 1.188 +<p> 1.189 + This file will install SliTaz on /dev/hda3 formatting the partition from a LiveCD. 1.190 +</p> 1.191 + 1.192 +<a name="install"></a> 1.193 +<h3>install</h3> 1.194 +<p> 1.195 + Launch the SliTaz installer based on data in the configuration file. 1.196 +</p> 1.197 +<pre> 1.198 +tazinst install /var/lib/tazinst.conf 1.199 +</pre> 1.200 + 1.201 +<a name="upgrade"></a> 1.202 +<h3>upgrade</h3> 1.203 +<p> 1.204 + Launch and upgrade SliTaz based on data in the configuration file. 1.205 +</p> 1.206 +<pre> 1.207 +tazinst upgrade /var/lib/tazinst.conf 1.208 +</pre> 1.209 + 1.210 +<h2>MAINTAINERS</h2> 1.211 +<p> 1.212 + Christophe Lincoln <pankso at slitaz.org> <br /> 1.213 + Dominique Corbex <domcox at slitaz.org> 1.214 +</p> 1.215 + 1.216 +<!-- End of content --> 1.217 +</div> 1.218 + 1.219 +<div id="footer"> 1.220 + Copyright © 2011 <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a> 1.221 +</div> 1.222 + 1.223 +</body> 1.224 +</html>