slitaz-tools view doc/tazinst.en.html @ rev 656
tazinst: showurl+check commands added
| author | Dominique Corbex <domcox@slitaz.org> |
|---|---|
| date | Mon Jul 25 12:03:18 2011 +0200 (2011-07-25) |
| parents | d6b5ad962895 |
| children | aba8290691e2 |
line source
1 <!DOCTYPE html>
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <title>Tazinst Manual - Manual for 'tazinst' installer</title>
5 <meta charset="utf-8" />
6 <link rel="shortcut icon" href="favicon.ico" />
7 <link rel="stylesheet" type="text/css" href="style.css" />
8 </head>
9 <body>
11 <!-- Header -->
12 <div id="header">
13 <h1>Tazinst Manual</h1>
14 </div>
16 <!-- Start content -->
17 <div id="content">
19 <h2>NAME</h2>
20 <p>
21 Tazinst - Tiny autonomous zone installer manager
22 </p>
24 <h2>SYNTAX</h2>
25 <pre>
26 tazinst [command] [configuration file]
27 </pre>
29 <h2>DESCRIPTION</h2>
30 <p>
31 Tazinst is a lightweight SliTaz HDD installer (~ 29 KB). It installs SliTaz to a hard drive from a
32 Live-CD, LiveUSB key, a SliTaz ISO image, or from the web by downloading a stable
33 version, a cooking version or by giving the http link of another iso (eg: Development ISO).
34 </p>
35 <p>
36 Tazinst can format the target partition to ext2, ext3, ext4 or other formats if the
37 matching packages are installed. The home partition can be installed on another
38 partition and if need be formatted before installation into any one of the available
39 formats. Tazinst may upon request install the Grub bootloader in the MBR of the target
40 disk. A dual-boot with an existing Windows© partition is possible, finding the Windows©
41 partition can either be done automatically or manually specified.
42 </p>
43 <p>
44 Tazinst can also update SliTaz installed on a hard disk partition which is handy
45 in case of version changes. In this case, Slitaz is updated, data in /home is
46 preserved and additional packages are reinstalled on to the new version.
47 </p>
48 <p>
49 Tazinst was created independently for the needs of the SliTaz GNU/Linux mini distribution.
50 </p>
51 <p>
52 Tazinst is written from scratch in shell script and is compatible with Busybox Ash and Bash.
53 Tazinst is licensed under the GNU Free gpl v3.
54 </p>
56 <h2>COMMANDS</h2>
57 <a name="config"></a>
58 <h3>config</h3>
59 <p>
60 Generates a self-documenting configuration file which when edited as required by the user
61 will install or update SliTaz to a hard drive using tazinst install [filename].
62 </p>
63 <pre>
64 tazinst config /var/lib/tazinst.conf
65 </pre>
67 <p>
68 The configuration file contains the following variables:
69 </p>
70 <ul>
71 <li>The variables describing the installation source:</li>
72 </ul>
74 <ol>
75 <li class="level1"><div class="li"> * INST_TYPE: the type of media containing
76 the SliTaz source files, either: cdrom (SliTaz LiveCD), usb
77 (SliTaz LiveUSB), iso (ISO image of SliTaz), web (ISO image on the Web),
78 weboot, ex: <code>INST_TYPE=web</code></div>
79 </li>
80 <li class="level1"><div class="li"> * SRC_FILE: the name of the source file containing
81 SliTaz. It depends on the type of support:
82 <ul>
83 <li class="level2"><div class="li">cdrom (SliTaz LiveCD):
84 <i>unused</i></div>
85 </li>
86 <li class="level2"><div class="li">usb (SliTaz LiveUSB): name of the
87 partition on the host USB device, ex: <code>SRC_FILE=/dev/sdb1</code>
88 </div>
89 </li>
90 <li class="level2"><div class="li">iso (ISO image of SliTaz): name of the
91 ISO file, ex: <code>SRC_FILE=~/slitaz.3.0.iso</code></div>
92 </li>
93 <li class="level2"><div class="li">web (ISO image on the Web): name of the
94 URL, ex: <code>
95 SRC_FILE=http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso</code>.
96 Note that 3 URLs are predefined: 'stable', 'cooking, 'rolling', ex:
97 <code>SRC_FILE=cooking</code> downloads the latest cooking available
98 from the web</div>
99 </li>
100 <li class="level2"><div class="li">weboot: <i>unused</i></div></li>
101 </ul></div>
102 </li>
103 </ol>
105 <ul>
106 <li class="level1"><div class="li"> The variables describing the target
107 partition: </div>
108 </li>
109 </ul>
111 <ol>
112 <li class="level1"><div class="li"> * TGT_PARTITION: the name of the target
113 partition SliTaz will install to or update, ex: <code>TGT_PARTITION=
114 /dev/hda3</code></div>
115 </li>
116 <li class="level1"><div class="li">TGT_FS: if this variable is entered, the
117 target partition will be formatted in the file system specified, otherwise
118 the partition will be cleaned and /home will be preserved, ex: <code>
119 TGT_FS=ext3</code></div>
120 </li>
121 <li class="level1"><div class="li">TGT_HOME: this variable indicates if need
122 be, the name of the partition to receive the /home directory, ex: <code>
123 TGT_HOME=/dev/hda5</code></div>
124 </li>
125 <li class="level1"><div class="li">TGT_HOME_FS: if this variable is entered,
126 the home partition will be formatted in the file system specified,
127 ex: <code>TGT_HOME_FS=ext2</code></div>
128 </li>
129 </ol>
131 <ul>
132 <li class="level1"><div class="li"> The configuration variables:
133 </div>
134 </li>
135 </ul>
137 <ol>
138 <li class="level1"><div class="li">TGT_HOSTNAME: name of the system, ex: <code>
139 TGT_HOSTNAME=hd-slitaz</code>, by default <code>TGT_HOSTNAME=slitaz</code>
140 </div>
141 </li>
142 <li class="level1"><div class="li">TGT_ROOT_PWD: superuser password, ex:
143 <code>TGT_ROOT_PWD=toor</code>, by default <code>
144 TGT_ROOT_PWD=root</code></div>
145 </li>
146 <li class="level1"><div class="li">TGT_USER: user name,
147 ex: <code>TGT_USER=toto</code>, by default <code>TGT_USER=tux</code></div>
148 </li>
149 <li class="level1"><div class="li">TGT_USER_PWD: user password,
150 ex: <code>TGT_USER_PWD=titi</code>, by default
151 <code>TGT_USER_PWD=tux</code></div>
152 </li>
153 </ol>
155 <ul>
156 <li class="level1"><div class="li"> The boot loader (bootloader) configuration variables: </div>
157 </li>
158 </ul>
160 <ol>
161 <li>TGT_GRUB: install the GRUB bootloader (yes or no), ex:
162 <code>TGT_GRUB=yes</code>, by default <code>TGT_GRUB=no</code>
163 </li>
164 <li class="level1"><div class="li">TGT_WINBOOT: if this variable is entered,
165 it indicates the partition containing Windows© to implement a dual-boot. It can
166 also be set to 'auto', in this case the dual-boot will be on the first partition
167 Windows© detected,
168 ex: <code>TGT_WINBOOT=auto</code></div>
169 </li>
170 </ol>
172 <p>
173 Note that only variables preceded by a asterisk are mandatory, others are optional. Thus a minimal configuration file can be:
174 </p>
175 <pre>
176 INST_TYPE=cdrom
177 TGT_PARTITION=/dev/hda3
178 </pre>
179 <p>
180 This file will install SliTaz on /dev/hda3 formatting the partition from a LiveCD.
181 </p>
183 <a name="install"></a>
184 <h3>install</h3>
185 <p>
186 Launch the SliTaz installer based on data in the configuration file.
187 </p>
188 <pre>
189 tazinst install /var/lib/tazinst.conf
190 </pre>
192 <a name="upgrade"></a>
193 <h3>upgrade</h3>
194 <p>
195 Launch and upgrade SliTaz based on data in the configuration file.
196 </p>
197 <pre>
198 tazinst upgrade /var/lib/tazinst.conf
199 </pre>
201 <a name="showurl"></a>
202 <h3>showurl</h3>
203 <p>Display the full URL of the predefined shortcuts: 'stable', 'cooking, 'rolling'.</p>
204 <p>You may overwrite these shortcuts in /etc/slitaz/tazinst.conf:</p>
205 <ul>
206 <li>URL_STABLE="http://mirror.slitaz.org/iso/stable/slitaz...." for 'stable'</li>
207 <li>URL_COOKING="http://mirror.slitaz.org/iso/cooking/slitaz..." for 'cooking'</li>
208 <li>URL_ROLLING="http://mirror.slitaz.org/iso/rolling/slitaz..." for 'rolling'</li>
209 </ul>
210 <pre>
211 tazinst showurl stable
212 </pre>
214 <a name="check"></a>
215 <h3>check</h3>
216 <p>Check a configuration file for errors.</p>
217 <pre>
218 tazinst check /var/lib/tazinst.conf
219 </pre>
222 <h2>MAINTAINERS</h2>
223 <p>
224 Christophe Lincoln <pankso at slitaz.org> <br />
225 Dominique Corbex <domcox at slitaz.org>
226 </p>
228 <!-- End of content -->
229 </div>
231 <div id="footer">
232 Copyright © 2011 <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a>
233 </div>
235 </body>
236 </html>