tazinst view 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 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>
10
11 <!-- Header -->
12 <div id="header">
13 <h1>Tazinst Manual</h1>
14 </div>
15
16 <!-- Start content -->
17 <div id="content">
18
19 <h2>NAME</h2>
20 <p>
21 Tazinst - Tiny autonomous zone installer manager
22 </p>
23
24 <h2>SYNTAX</h2>
25 <pre>
26 tazinst [command] [option]
27 </pre>
28
29 <h2>DESCRIPTION</h2>
30 <p>
31 Tazinst is a lightweight SliTaz HDD installer (~ 31 KB). It installs SliTaz
32 to a hard drive from a Live-CD, a LiveUSB key, a SliTaz ISO image, or from
33 the web by downloading a stable, cooking or rolling version or by giving
34 the http link of another iso (eg: Development ISO).
35 </p>
36 <p>
37 Tazinst can format the target partition to ext2, ext3, ext4 or other formats
38 if the matching packages are installed. The home partition can be installed
39 on another partition and if need be, formatted before installation into any
40 one of the available formats. Tazinst may upon request install the Grub
41 bootloader in the MBR of the target disk. A dual-boot with an existing
42 Windows© partition is possible, finding the Windows© partition can either be
43 done automatically or manually specified.
44 </p>
45 <p>
46 Tazinst can also update SliTaz installed on a hard disk partition which is
47 handy in case of version changes. In this case, Slitaz is updated, data in
48 /home is preserved and additional packages are reinstalled on to the new
49 version.
50 </p>
51 <p>
52 Tazinst was created independently for the needs of the SliTaz GNU/Linux mini
53 distribution.
54 </p>
55 <p>
56 Tazinst is written from scratch in shell script and is compatible with
57 Busybox Ash and Bash. Tazinst is licensed under the GNU Free gpl v3.
58 </p>
59
60 <h2>SETUP FILE</h2>
61 <p>
62 Tazinst installer is able to perform an installation automatically based on
63 a simple setup file with clear variables such as:
64 <code>INST_TYPE="iso"</code>, <code>TGT_PARTITION="/dev/hda1"</code>.
65
66 With this way, it allows developers to create a different kind of frontend:
67 Dialog, GTK and CGI/web in TazPanel. The frontend just has to create a
68 setup file and start the cmdline installer and report steps in a nice way
69 (progress bar or/and messages).
70 </p>
71 <p>
72 The setup file contains the following variables:
73 </p>
74 <ul>
75 <li class="level1"><div class="li">
76 The variables describing the installation source:
77
78 <ol>
79 <li class="level1"><div class="li">
80 <strong>*INST_TYPE</strong>: the type of media containing the SliTaz source
81 files, either: <strong>cdrom</strong> (SliTaz LiveCD), <strong>usb</strong>
82 (SliTaz LiveUSB), <strong>iso</strong> (ISO image of SliTaz),
83 <strong>web</strong> (ISO image on the Web), <strong>weboot</strong>,
84 ex: <code>INST_TYPE=web</code>
85 </div></li>
86 <li class="level1"><div class="li">
87 <strong>SRC_FILE</strong>: the name of the source file containing SliTaz.
88 It depends on the type of support:
89 <ul>
90 <li class="level2"><div class="li">cdrom (SliTaz LiveCD):
91 <i>unused</i>
92 </div></li>
93 <li class="level2"><div class="li">usb (SliTaz LiveUSB): name of the
94 partition on the host USB device, ex: <code>SRC_FILE=/dev/sdb1</code>
95 </div></li>
96 <li class="level2"><div class="li">iso (ISO image of SliTaz): name of the
97 ISO file, ex: <code>SRC_FILE=~/slitaz.3.0.iso</code>
98 </div></li>
99 <li class="level2"><div class="li">web (ISO image on the Web): name of the
100 URL, ex: <code>
101 SRC_FILE=http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso</code>.
102 Note that 3 URLs are predefined: 'stable', 'cooking, 'rolling', ex:
103 <code>SRC_FILE=cooking</code> downloads the latest cooking available
104 from the web
105 </div></li>
106 <li class="level2"><div class="li">weboot: <i>unused</i>
107 </div></li>
108 </ul>
109 </div></li>
110 </ol>
111 </div></li>
112 </ul>
113
114 <ul>
115 <li class="level1"><div class="li">The variables describing the target
116 partition:
117
118 <ol>
119 <li class="level1"><div class="li">
120 <strong>*TGT_PARTITION</strong>: the name of the target partition SliTaz
121 will install to or update,
122 ex: <code>TGT_PARTITION=/dev/hda3</code>
123 </div></li>
124 <li class="level1"><div class="li">
125 <strong>TGT_FS</strong>: if this variable is entered, the target partition
126 will be formatted in the file system specified, otherwise the partition will
127 be cleaned and /home will be preserved, ex: <code>TGT_FS=ext3</code>
128 </div></li>
129 <li class="level1"><div class="li">
130 <strong>TGT_HOME</strong>: this variable indicates if need be, the name of
131 the partition to receive the /home directory,
132 ex: <code>TGT_HOME=/dev/hda5</code>
133 </div></li>
134 <li class="level1"><div class="li">
135 <strong>TGT_HOME_FS</strong>: if this variable is entered, the home
136 partition will be formatted in the file system specified,
137 ex: <code>TGT_HOME_FS=ext2</code>
138 </div></li>
139 </ol>
140 </div></li>
141 </ul>
142
143 <ul>
144 <li class="level1"><div class="li">The system settings:
145
146 <ol>
147 <li class="level1"><div class="li">
148 <strong>TGT_HOSTNAME</strong>: name of the system,
149 ex: <code>TGT_HOSTNAME=hd-slitaz</code>, by default
150 <code>TGT_HOSTNAME=slitaz</code>
151 </div></li>
152 <li class="level1"><div class="li">
153 <strong>TGT_ROOT_PWD</strong>: superuser password,
154 ex: <code>TGT_ROOT_PWD=toor</code>, by default
155 <code>TGT_ROOT_PWD=root</code>
156 </div></li>
157 <li class="level1"><div class="li">
158 <strong>TGT_USER</strong>: user name,
159 ex: <code>TGT_USER=toto</code>, by default <code>TGT_USER=tux</code>
160 </div></li>
161 <li class="level1"><div class="li">
162 <strong>TGT_USER_PWD</strong>: user password,
163 ex: <code>TGT_USER_PWD=titi</code>, by default
164 <code>TGT_USER_PWD=tux</code>
165 </div></li>
166 </ol>
167 </div></li>
168 </ul>
169
170 <ul>
171 <li class="level1"><div class="li"> The boot loader (bootloader)
172 configuration variables:
173
174 <ol>
175 <li class="level1"><div class="li">
176 <strong>TGT_GRUB</strong>: install the GRUB bootloader (yes or no),
177 ex: <code>TGT_GRUB=yes</code>, by default <code>TGT_GRUB=no</code>
178 </div></li>
179 <li class="level1"><div class="li">
180 <strong>TGT_WINBOOT</strong>: if this variable is entered, it indicates the
181 partition containing Windows© to implement a dual-boot. It can also be set
182 to 'auto', in this case the dual-boot will be on the first partition
183 Windows© detects,
184 ex: <code>TGT_WINBOOT=auto</code>
185 </div></li>
186 </ol>
187 </div></li>
188 </ul>
189
190 <p>
191 Note that only variables preceded by a asterisk are mandatory, others are
192 optional. Thus a minimal setup file can be:
193 </p>
194 <pre>
195 INST_TYPE=cdrom
196 TGT_PARTITION=/dev/hda3
197 </pre>
198 <p>
199 This file will install SliTaz on /dev/hda3 formatting the partition from a
200 LiveCD.
201 </p>
202
203 <h2>COMMANDS</h2>
204
205 <a id="new"></a>
206 <h3>new</h3>
207 <p>
208 Generates a new self-documenting setup file which when edited as required
209 by the user will install or update SliTaz to a hard drive.
210 </p>
211 <pre>
212 tazinst new /var/lib/tazinst.conf
213 </pre>
214
215
216 <a id="install"></a>
217 <h3>install</h3>
218 <p>
219 Performs a SliTaz install on a HDD based on data in the setup file.
220 If you decide to format your HDD, all data will be lost. If you do not
221 format, all data except for any existing /home directory will be removed,
222 the home directory will be kept as is.
223 </p>
224 <pre>
225 tazinst install /var/lib/tazinst.conf
226 </pre>
227
228 <a id="upgrade"></a>
229 <h3>upgrade</h3>
230 <p>
231 Upgrade an existing SliTaz system on a HDD based on data in the setup file.
232 Your /home /etc /var/www directories will be kept, all other directories
233 will be removed. Any additional package added to your old Slitaz system
234 will be updated as long you have an active internet connection.
235 </p>
236 <pre>
237 tazinst upgrade /var/lib/tazinst.conf
238 </pre>
239
240 <a id="showurl"></a>
241 <h3>showurl</h3>
242 <p>
243 Display the full URL of the predefined shortcuts: 'stable', 'cooking,
244 'rolling'.
245 </p>
246 <p>
247 Note: You may overwrite these shortcuts in the system file:
248 /etc/slitaz/tazinst.conf.
249 </p>
250 <pre>
251 tazinst showurl stable
252 </pre>
253
254 <a id="check"></a>
255 <h3>check</h3>
256 <p>
257 Check a setup file for errors.
258 </p>
259 <pre>
260 tazinst check /var/lib/tazinst.conf
261 </pre>
262
263 <a id="log"></a>
264 <h3>log</h3>
265 <p>
266 Display the last log file contents and exit.
267 </p>
268 <pre>
269 tazinst log
270 </pre>
271
272 <a id="version"></a>
273 <h3>version</h3>
274 <p>
275 Print the version information and exit.
276 </p>
277 <pre>
278 tazinst version
279 </pre>
280
281 <h2>SYSTEM FILE</h2>
282 <p>
283 The /etc/slitaz/tazinst.conf configuration file allows you to change the default
284 settings of tazinst, if you want to use custom values for URLs, directories
285 and files, you'll have to create one and modify the following variables:
286 </p>
287
288 <ul>
289 <li class="level1"><div class="li">Predefined urls:
290
291 <ol>
292 <li class="level1"><div class="li">URL of the current stable version:<br />
293 <code>URL_STABLE="http://mirror.slitaz.org/iso/stable/slitaz-4.0.iso"
294 </code>
295 </div></li>
296 <li class="level1"><div class="li">URL of the current cooking version:<br />
297 <code>URL_COOKING="http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso"
298 </code>
299 </div></li>
300 <li class="level1"><div class="li">URL of the current rolling version:<br />
301 <code>URL_ROLLING="http://mirror.slitaz.org/iso/rolling/slitaz-core.iso"
302 </code>
303 </div></li>
304 </ol>
305 </div></li>
306 </ul>
307
308 <ul>
309 <li class="level1"><div class="li">Mount points:
310
311 <ol>
312 <li class="level1"><div class="li">
313 Source partition mount point:<br />
314 <code>SOURCE_ROOT="/media/source"</code>
315 </div></li>
316 <li class="level1"><div class="li">
317 Target partition mount point:<br />
318 <code>TARGET_ROOT="/mnt/target"</code>
319 </div></li>
320 </ol>
321 </div></li>
322 </ul>
323
324 <ul>
325 <li class="level1"><div class="li">Log and Debug:
326
327 <ol>
328 <li class="level1"><div class="li">Log File Location:<br />
329 <code>LOG="/var/log/tazinst.log"</code>
330 </div></li>
331 <li class="level1"><div class="li">Debugging: (quiet => 0, debug => 1)<br />
332 <code>DEBUG=0</code><br />
333 It is highly recommended to set <code>DEBUG=1</code> and attach the
334 contents of the resulting Log file when sending a bug report to
335 developers.
336 </div></li>
337 </ol>
338 </div></li>
339 </ul>
340
341 <h2>MAINTAINERS</h2>
342 <p>
343 Christophe Lincoln &lt;pankso at slitaz.org&gt; <br />
344 Dominique Corbex &lt;domcox at slitaz.org&gt;
345 </p>
346
347 <!-- End of content -->
348 </div>
349
350 <div id="footer">
351 Copyright &copy; 2012 <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a>
352 </div>
353
354 </body>
355 </html>