tazinst view doc/tazinst.en.html @ rev 2
Use UUIDs, boot delay on mobile disks, GPT support, boot flag, new slitaz-installer and web frontends
| author | Dominique Corbex <domcox@slitaz.org> |
|---|---|
| date | Thu Feb 14 13:12:12 2013 +0100 (2013-02-14) |
| parents | ced519734730 |
| children | e7584908ff07 |
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] <setting> <value> <file>
27 </pre>
29 <h2>DESCRIPTION</h2>
30 <p>
31 Tazinst is a lightweight SliTaz HDD installer. It installs SliTaz
32 to a hard drive from a local media like a Live-CD, a LiveUSB key, an ISO
33 image located on one of your disks, or from the web by automatically
34 downloading a SliTaz image.
35 </p>
36 <p>
37 Tazinst can format the target partition to ext2, ext3 or ext4. The home
38 partition can be installed on another partition and if need be, formatted
39 before installation into any one of the available formats. Tazinst may
40 upon request install a bootloader on the target disk. A dual-boot with an
41 existing Windows<sup>™</sup> partition is possible, finding the
42 Windows<sup>™</sup> partition can either be done automatically or
43 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
53 mini 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 <h3>Known limitations</h3>
60 <p>
61 Tazinst doesn't allow SliTaz to boot on (U)EFI systems (mostly
62 Windows<sup>™ </sup>8 systems), except in BIOS compatibility mode.
63 </p>
67 <h2>SETTINGS</h2>
69 <p>
70 Tazinst installer is able to perform an installation automatically based on
71 a few settings.
72 </p>
74 <a id="mode"></a>
75 <h3>mode</h3>
76 <p>
77 Mode of install that will be performed by tazinst. Type <strong><code>
78 tazinst help mode</code></strong> in order to have a list of supported
79 modes.
80 </p>
82 <a id="media"></a>
83 <h3>media</h3>
84 <p>
85 The media containing the SliTaz source files, either: <strong>cdrom</strong>
86 (SliTaz LiveCD), <strong>usb</strong> (SliTaz LiveUSB), <strong>iso</strong>
87 (ISO image of SliTaz), <strong>web</strong> (ISO image on the Web).
88 </p>
90 <a id="source"></a>
91 <h3>source</h3>
92 <p>
93 The name of the source file containing SliTaz.
94 It depends on the type of <strong>media</strong>:
95 <table>
96 <tr>
97 <td>cdrom:</td>
98 <td><i>unused</i></td>
99 </tr>
100 <tr>
101 <td>usb:</td>
102 <td>name of the partition on the host USB device. Type <strong><code>
103 tazinst list usb</code></strong> to list USB partitions.</td>
104 </tr>
105 <tr>
106 <td>iso</td>
107 <td>name of the ISO file, ex: <strong><code>~/slitaz-rolling.iso</code>
108 </strong>. Type <code><strong>tazinst list iso</code></strong> to list
109 iso files on your disks.</code></strong></td>
110 </tr>
111 <tr>
112 <td>web</td>
113 <td>name of the image on the web, ex: <strong><code>stable cooking rolling
114 base core gtkonly justx</code></strong>, for a full list type <strong>
115 <code>tazinst list web</code></strong>, or enter the full URL of the image,
116 ex: <strong><code>
117 http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso</code></strong>.
118 </td>
119 </tr>
120 </table>
121 </ul>
122 </p>
124 <a id="root_uuid"></a>
125 <h3>root_uuid</h3>
126 <p>
127 The name of the target partition SliTaz will install to. Type <strong>
128 <code>tazinst list uuid</code></strong> to list partitions on your disks.
129 </p>
131 <a id="root_format"></a>
132 <h3>root_format</h3>
133 <p>
134 Optional. If this setting is used, the target partition will be formatted
135 in the file system specified, otherwise the partition will be cleaned and
136 /home will be preserved. Type <strong><code>tazinst help format</code>
137 </strong> to get the list of all supported filesystems, and <strong><code>
138 tazinst list root_format</code></strong> to see filesystems already
139 installed on your system.
140 </p>
142 <a id="home_uuid"></a>
143 <h3>home_uuid</h3>
144 <p>
145 Optional. A separate home partition may be created if needed. This setting
146 indicates if need be, the name of the partition to receive the /home
147 directory.
148 </p>
150 <a id="home_format"></a>
151 <h3>home_format</h3>
152 <p>
153 Optional. If this setting is used, and a separate /home partition will be
154 created, this partition will be formatted in the file system specified.
155 </p>
157 <a id="hostname"></a>
158 <h3>hostname</h3>
159 <p>
160 Optional. Name of the system, <strong><code>slitaz</code></strong> by
161 default.
162 </p>
164 <a id="root_pwd"></a>
165 <h3>root_pwd</h3>
166 <p>
167 Optional. Superuser password, <strong><code>root</code></strong>, by
168 default.
169 </p>
171 <a id="user_login"></a>
172 <h3>user_login</h3>
173 <p>
174 Optional. First user name, <strong><code>tux</code></strong> by default.
175 </p>
177 <a id="user_pwd"></a>
178 <h3>user_pwd</h3>
179 <p>
180 Optional. First user password, <strong><code>tux</code></strong> by default.
181 </p>
183 <a id="bootloader"></a>
184 <h3>bootloader</h3>
185 <p>
186 Optional. Install a bootloader. Usually you should set it to <strong><code>
187 auto</code></strong> unless you want to use an already installed bootloader
188 on your system, install a bootloader by hand yourself or install a specific
189 bootloader. In this case type <strong><code>tazinst help bootloader</code>
190 </strong> to list supported bootloaders.
191 </p>
193 <a id="winboot"></a>
194 <h3>winboot</h3>
195 <p>
196 Optional. If a bootloader is installed, this setting indicates the
197 partition containing Windows<sup>™</sup> to implement a dual-boot. It can
198 also be set to <strong><code>auto</code></strong>, in this case the
199 dual-boot will be on the first Windows<sup>™</sup> partition. Type <code>
200 <strong>tazinst list winboot</code></strong> to see values tazinst
201 automatically detects.
202 </p>
204 <h2>COMMANDS</h2>
206 <a id="new"></a>
207 <h3>new</h3>
208 <p>
209 Generates a new self-documenting install file, containing settings, which
210 when set up as required by the user, will allow tazinst to execute an
211 unattended installation. The default file is <code>./tazint.rc</code>, but
212 an optional file name may be given as a parameter.
213 </p>
214 <h5>Examples:</h5>
215 <pre>
216 tazinst new
217 tazinst new /var/lib/tazinst.conf
218 </pre>
220 <a id="set"></a>
221 <h3>set</h3>
222 <p>
223 Assign a new value to a given setting.
224 </p>
225 <h5>Examples:</h5>
226 <pre>
227 tazinst set mode install
228 tazinst set mode install /var/lib/tazinst.conf
229 </pre>
231 <a id="unset"></a>
232 <h3>unset</h3>
233 <p>
234 Unset, clear a setting.
235 </p>
236 <h5>Examples:</h5>
237 <pre>
238 tazinst unset mode
239 tazinst unset mode /var/lib/tazinst.conf
240 </pre>
242 <a id="get"></a>
243 <h3>get</h3>
244 <p>
245 Get the value of a setting. Without parameter, get the values of all
246 settings.
247 </p>
248 <h5>Examples:</h5>
249 <pre>
250 tazinst get
251 tazinst get mode
252 tazinst get mode /var/lib/tazinst.conf
253 </pre>
255 <a id="check"></a>
256 <h3>check</h3>
257 <p>
258 Check a setting for errors. Without parameter, check all settings.
260 </p>
261 <h5>Examples:</h5>
262 <pre>
263 tazinst check
264 tazinst check mode
265 tazinst check mode /var/lib/tazinst.conf
266 </pre>
268 <a id="list"></a>
269 <h3>list</h3>
270 <p>
271 List system ressources. Ressources are:
272 <table>
273 <tr>
274 <td>mode</td>
275 <td>Available modes of install</td>
276 </tr>
277 <tr>
278 <td>media</td>
279 <td>Available media to install from. Ex: cdrom is not listed on systems
280 with no cdrom drive</td>
281 </tr>
282 <tr>
283 <td>usb</td>
284 <td>Partitions of USB disks</td>
285 </tr>
286 <tr>
287 <td>iso</td>
288 <td>Iso images located on local drives, in /root, all user's home and
289 first subdir of all user's home</td>
290 </tr>
291 <tr>
292 <td>web</td>
293 <td>Predefined names of iso images to download automatically from the
294 Internet.</td>
295 </tr>
296 <tr>
297 <td>format</td>
298 <td>Installed filesystems</td>
299 </tr>
300 <tr>
301 <td>bootloader</td>
302 <td>Available bootloaders</td>
303 </tr>
304 <tr>
305 <td>partition_table</td>
306 <td>Partition tables scheme of local disks</td>
307 </tr>
308 <tr>
309 <td>winboot</td>
310 <td>Bootable Windows<sup>™</sup> partitions</td>
311 </tr>
312 </table>
313 </p>
314 <h5>Examples:</h5>
315 <pre>
316 tazinst list
317 tazinst list media
318 </pre>
320 <a id="execute"></a>
321 <h3>execute</h3>
322 <p>
323 Performs a SliTaz install on a HDD based on data in the install file.
324 If you selected to format your HDD, all data will be lost. If you do not,
325 all data except for any existing /home directory will be removed,
326 the home directory will be kept as is.
327 </p>
328 <h5>Examples:</h5>
329 <pre>
330 tazinst execute
331 tazinst execute /var/lib/tazinst.conf
332 </pre>
334 <a id="clean"></a>
335 <h3>clean</h3>
336 <p>
337 Remove install and log files.
338 </p>
339 <h5>Examples:</h5>
340 <pre>
341 tazinst clean
342 tazinst clean /var/lib/tazinst.conf
343 </pre>
345 <a id="log"></a>
346 <h3>log</h3>
347 <p>
348 Display the last log file contents and exit.
349 </p>
350 <h5>Example:</h5>
351 <pre>
352 tazinst log
353 </pre>
355 <a id="version"></a>
356 <h3>version</h3>
357 <p>
358 Print the version information and exit.
359 </p>
360 <h5>Example:</h5>
361 <pre>
362 tazinst version
363 </pre>
365 <a id="usage"></a>
366 <h3>usage</h3>
367 <p>
368 Print a short help and exit
369 </p>
370 <h5>Example:</h5>
371 <pre>
372 tazinst usage
373 </pre>
375 <a id="help"></a>
376 <h3>help</h3>
377 <p>
378 Print a short help for a given setting and exit. Without an argument, print
379 a short help for all settings.
380 </p>
381 <h5>Example:</h5>
382 <pre>
383 tazinst help mode
384 </pre>
387 <h2>EXAMPLES</h2>
389 <h3>Install</h3>
391 <p>
392 How to Install SliTaz on one partition of your hard disk drive. The root
393 partition is not formatted, all data except for any existing <code>/home
394 </code> directory will be removed, the <code>home</code> directory will be
395 kept as is.
396 </p>
398 <ol>
399 <li>Create an install file:<pre># tazinst new</pre></li>
400 <li>Set mode as install:<pre># tazinst set mode install</pre></li>
401 <li>Use a cdrom as source:<pre># tazinst set media cdrom</pre></li>
402 <li>Select the partition to install SliTaz on:
403 <pre># tazinst set root_uuid /dev/hda1</pre></li>
404 <li>Install a bootloader:<pre># tazinst set bootloader auto</pre>
405 <li>Execute installation:<pre># tazinst execute</pre>
406 </ol>
408 <h3>Complex Install</h3>
410 <p>
411 How to Install SliTaz on your hard disk drive, with a separate home
412 partition, and a Windows<sup>™</sup> dual-boot. /home and root partitions
413 are both formatted, all existing data will be lost.
414 </p>
416 <ol>
417 <li>Create an install file:<pre># tazinst new</pre></li>
418 <li>Set mode as install:<pre># tazinst set mode install</pre></li>
419 <li>Use a Live USB as source:<pre># tazinst set media usb</pre></li>
420 <li>Select a partition on the Live USB:
421 <pre># tazinst set source /dev/sda1</pre></li>
422 <li>Select the partition to install SliTaz on:
423 <pre># tazinst set root_uuid /dev/hda1</pre></li>
424 <li>Format / as ext4:
425 <pre># tazinst set root_format ext4</pre></li>
426 <li>Use a separate /home partition:
427 <pre># tazinst set home_uuid /dev/hda2</pre></li>
428 <li>Format /home as ext2:
429 <pre># tazinst set home_format ext2</pre></li>
430 <li>Install a bootloader:<pre># tazinst set bootloader auto</pre>
431 <li>Set up a Windows<sup>™</sup> dual-boot:
432 <pre># tazinst set winboot auto</pre></li>
433 <li>Execute installation:<pre># tazinst execute</pre>
434 <li>Don't let traces behind:<pre># tazinst clean</pre>
435 </ol>
437 <h3>Upgrade</h3>
439 <p>
440 How to upgrade an already installed SliTaz system on your hard disk drive.
441 Your <code>/home /etc /var/www</code> directories will be kept, all other
442 directories will be removed. Any additional packages added to your old
443 Slitaz system will be updated as long you have an active internet
444 connection.
445 </p>
447 <ol>
448 <li>Create an install file:<pre># tazinst new</pre></li>
449 <li>Set mode as upgrade:<pre># tazinst set mode upgrade</pre></li>
450 <li>Use web as source:<pre># tazinst set media web</pre></li>
451 <li>Select the stable image:
452 <pre># tazinst set source stable</pre></li>
453 <li>Select the partition containing Slitaz to upgrade:
454 <pre># tazinst set root_uuid /dev/hda1</pre></li>
455 <li>Install a bootloader:<pre># tazinst set bootloader auto</pre>
456 <li>Execute installation:<pre># tazinst execute</pre>
457 </ol>
459 <h3>Tips</h3>
461 <ol>
462 <li>Not all settings are used depending on the mode of install. List all
463 settings to see which you need to edit:
464 <pre># tazinst get</pre></li>
465 <li>Check your settings before executing install:
466 <pre># tazinst check</pre></li>
467 </ol>
469 <h2>FILES</h2>
471 <h3>INSTALL FILE</h3>
473 <p>
474 Settings are saved in the install file, then used by tazinst to execute
475 an unattended installation. The default file is <code>./tazint.rc</code>,
476 but an optional file name may be given as a parameter. The install file is
477 self-documented. The clean command erases this file.
478 </p>
480 <h3>SYSTEM FILE</h3>
481 <p>
482 The <code>/etc/slitaz/tazinst.conf</code> configuration file allows you to
483 change the default settings of <code>tazinst</code>, in the case you want
484 to use default custom values.
485 </p>
487 <p>
488 All settings are customisable, if a particular setting is missing, just add
489 the name of the setting in caps and enter the new value.
490 </p>
492 <h4>Example:</h4>
494 <p>
495 If you intend to allways install SliTaz from the same iso on the web, you
496 just have to modify or add the following values:
497 <pre>MEDIA="web"
498 SOURCE="stable"</pre>
499 </p>
501 <h3>LOG FILE</h3>
503 <p>
504 The file <code>/var/log/tazinst.log</log> contains a log of the install
505 process. The clean command erases this file.
506 </p>
508 <h2>MAINTAINERS</h2>
509 <p>
510 Christophe Lincoln <pankso at slitaz.org> <br />
511 Dominique Corbex <domcox at slitaz.org>
512 </p>
514 <!-- End of content -->
515 </div>
517 <div id="footer">
518 Copyright © 2007-2013 <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a>
519 </div>
521 </body>
522 </html>