tazinst view doc/tazinst.en.html @ rev 93

slight modifications in tazinst manual
author Hans-G?nter Theisgen
date Fri Oct 06 17:15:36 2017 +0100 (2017-10-06)
parents f9a876208b66
line source
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="UTF-8">
5 <title>Tazinst Manual — Manual for “tazinst” installer</title>
6 <link rel="shortcut icon" href="favicon.ico">
7 <link rel="stylesheet" href="../slitaz-doc.css">
8 <script src="../slitaz-doc.js"></script>
9 </head>
10 <body>
12 <header>
13 <h1>Tazinst Manual</h1>
14 </header>
16 <!-- Start content -->
17 <div id="content">
19 <h2>NAME</h2>
21 <p>Tazinst — Tiny autonomous zone installer manager</p>
24 <h2>SYNTAX</h2>
26 <pre>
27 tazinst [command] &lt;setting&gt; &lt;value&gt; &lt;file&gt;
28 </pre>
31 <h2>DESCRIPTION</h2>
33 <p>Tazinst is a lightweight SliTaz HDD installer. It installs SliTaz to a hard
34 drive from any local media such as a Live-CD, a LiveUSB key, an ISO image
35 located on one of your disks, or from the web by automatically downloading a
36 SliTaz image.</p>
37 <p>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 before
39 installation into any one of the available formats. Tazinst may upon request
40 install a bootloader on the target disk. A dual-boot with an existing Windows™
41 partition is possible—finding the Windows™ partition can either be done
42 automatically or manually specified.</p>
43 <p>Tazinst can also update SliTaz installed on a hard disk partition which is
44 handy in case of version changes. In this case, SliTaz is updated, any data in
45 /home is preserved and additional packages are reinstalled on to the new
46 version.</p>
47 <p>Tazinst was created independently for the needs of the SliTaz GNU/Linux mini
48 distribution.</p>
49 <p>Tazinst is written from scratch in shell script and is compatible with
50 Busybox Ash and Bash. Tazinst is licensed under the GNU Free GPL v3.</p>
53 <h3>Known limitations</h3>
55 <p>Tazinst doesn't allow SliTaz to boot on (U)EFI systems (mostly Windows™ 8
56 systems), except in BIOS compatibility mode.</p>
59 <h2>SETTINGS</h2>
61 <p>Tazinst installer is able to perform an installation automatically based on a
62 few settings.</p>
65 <h3 id="mode">mode</h3>
67 <p>Installation mode that will be performed by tazinst. Type <code>tazinst help
68 mode</code> in order to have a list of supported modes.</p>
71 <h3 id="media">media</h3>
73 <p>The media containing the SliTaz source files, either <strong>cdrom</strong>
74 (SliTaz LiveCD), <strong>usb</strong> (SliTaz LiveUSB), <strong>iso</strong>
75 (ISO image of SliTaz), or <strong>web</strong> (ISO image on the Web).</p>
78 <h3 id="source">source</h3>
80 <p>The name of the source file containing SliTaz. It depends on the type of
81 <strong>media</strong>:</p>
83 <table>
84 <tr>
85 <td>cdrom:</td>
86 <td><i>unused</i></td>
87 </tr>
88 <tr>
89 <td>usb:</td>
90 <td>name of the partition on the host USB device. Type <code>tazinst
91 list usb</code></strong> to list USB partitions.</td>
92 </tr>
93 <tr>
94 <td>iso</td>
95 <td>name of the ISO file, example: <code>~/slitaz-rolling.iso</code>.
96 Type <code>tazinst list iso</code> to list iso files on your
97 disks.</td>
98 </tr>
99 <tr>
100 <td>web</td>
101 <td>name of the image on the web, example: <code>stable cooking rolling
102 base core gtkonly justx</code>, for a full list type <code>tazinst
103 list web</code>, or enter the full URL of the image, example:
104 <code>http://mirror.slitaz.org/iso/cooking/slitaz-cooking.iso</code>.
105 </td>
106 </tr>
107 </table>
110 <h3 id="root_uuid">root_uuid</h3>
112 <p>The name of the target partition SliTaz will install to. Type <code>tazinst
113 list uuid</code> to list partitions on your disks.</p>
116 <h3 id="root_format">root_format</h3>
118 <p>Optional. If this setting is used, the target partition will be formatted in
119 the file system specified, otherwise the partition will be cleaned and /home
120 will be preserved. Type <code>tazinst help format</code> to get the list of all
121 supported filesystems, and <code>tazinst list root_format</code> to see
122 filesystems already installed on your system.</p>
125 <h3 id="home_uuid">home_uuid</h3>
127 <p>Optional. A separate home partition may be created if needed. This setting
128 indicates if need be, the name of the partition to receive the /home
129 directory.</p>
132 <h3 id="home_format">home_format</h3>
134 <p>Optional. If this setting is used, a separate /home partition will be
135 created, this partition will be formatted in the file system specified.</p>
138 <h3 id="hostname">hostname</h3>
140 <p>Optional. Hostname of the system, <code>slitaz</code> by default.</p>
143 <h3 id="root_pwd">root_pwd</h3>
145 <p>Optional. Superuser [root] password, <code>root</code>, by default.</p>
148 <h3 id="user_login">user_login</h3>
150 <p>Optional. First user name, <code>tux</code> by default.</p>
153 <h3 id="user_pwd">user_pwd</h3>
155 <p>Optional. First user password, <code>tux</code> by default.</p>
158 <h3 id="bootloader">bootloader</h3>
160 <p>Optional. Install a bootloader. Usually you should set it to
161 <code>auto</code> unless you want to use an already installed bootloader on your
162 system, install a bootloader by hand yourself or install a specific bootloader.
163 In this case type <code>tazinst help bootloader</code> to list supported
164 bootloaders.</p>
167 <h3 id="winboot">winboot</h3>
169 <p>Optional. If a bootloader is installed, this setting indicates the partition
170 containing Windows™ to implement a dual-boot. It can also be set to
171 <code>auto</code>, in this case the dual-boot will be on the first Windows™
172 partition. Type <code>tazinst list winboot</code> to see values tazinst
173 automatically detects.</p>
176 <h2>COMMANDS</h2>
179 <h3 id="new">new</h3>
181 <p>Generates a new self-documenting install file containing settings which, when
182 set up as required by the user, will allow tazinst to execute an unattended
183 installation. The default file is <code>./tazinst.rc</code>, but an optional file
184 name may be given as a parameter.</p>
186 <h5>Examples:</h5>
188 <pre>
189 tazinst new
190 tazinst new /var/lib/tazinst.conf
191 </pre>
194 <h3 id="set">set</h3>
196 <p>Assign a new value to a given setting.</p>
198 <h5>Examples:</h5>
200 <pre>
201 tazinst set mode install
202 tazinst set mode install /var/lib/tazinst.conf
203 </pre>
206 <h3 id="unset">unset</h3>
208 <p>Unset, clears a setting.</p>
210 <h5>Examples:</h5>
212 <pre>
213 tazinst unset mode
214 tazinst unset mode /var/lib/tazinst.conf
215 </pre>
218 <h3 id="get">get</h3>
220 <p>Get the value of a setting. Without a parameter, gets the values of all
221 settings.</p>
223 <h5>Examples:</h5>
225 <pre>
226 tazinst get
227 tazinst get mode
228 tazinst get mode /var/lib/tazinst.conf
229 </pre>
232 <h3 id="check">check</h3>
234 <p>Check a setting for errors. Without a parameter, checks all settings.</p>
236 <h5>Examples:</h5>
238 <pre>
239 tazinst check
240 tazinst check mode
241 tazinst check mode /var/lib/tazinst.conf
242 </pre>
245 <h3 id="list">list</h3>
247 <p>List the system resources. Resources are:</p>
249 <table>
250 <tr>
251 <td>mode</td>
252 <td>Available modes of install</td>
253 </tr>
254 <tr>
255 <td>media</td>
256 <td>Available media to install from. Example: cdrom is not listed on
257 systems with no cdrom drive</td>
258 </tr>
259 <tr>
260 <td>usb</td>
261 <td>Partitions of USB disks</td>
262 </tr>
263 <tr>
264 <td>iso</td>
265 <td>Iso images located on local drives, in /root, and in all user's home
266 and first subdirectory</td>
267 </tr>
268 <tr>
269 <td>web</td>
270 <td>Predefined names of iso images to download automatically from the
271 Internet</td>
272 </tr>
273 <tr>
274 <td>format</td>
275 <td>Installed filesystems</td>
276 </tr>
277 <tr>
278 <td>bootloader</td>
279 <td>Available bootloaders</td>
280 </tr>
281 <tr>
282 <td>partition_table</td>
283 <td>Partition table schemes of local disks</td>
284 </tr>
285 <tr>
286 <td>winboot</td>
287 <td>Bootable Windows™ partitions</td>
288 </tr>
289 </table>
291 <h5>Examples:</h5>
293 <pre>
294 tazinst list
295 tazinst list media
296 </pre>
299 <h3 id="execute">execute</h3>
301 <p>Performs a SliTaz install on a HDD based on data in the install file. If you
302 selected to format your HDD, all data will be lost. If you do not, all data
303 except for any existing /home directory will be removed, (the home directory
304 will be kept as is).</p>
306 <h5>Examples:</h5>
308 <pre>
309 tazinst execute
310 tazinst execute /var/lib/tazinst.conf
311 </pre>
314 <h3 id="clean">clean</h3>
316 <p>Remove installation and log files.</p>
318 <h5>Examples:</h5>
320 <pre>
321 tazinst clean
322 tazinst clean /var/lib/tazinst.conf
323 </pre>
326 <h3 id="log">log</h3>
328 <p>Display the last log file contents and exit.</p>
330 <h5>Example:</h5>
332 <pre>
333 tazinst log
334 </pre>
337 <h3 id="version">version</h3>
339 <p>Print the version information and exit.</p>
341 <h5>Example:</h5>
343 <pre>
344 tazinst version
345 </pre>
348 <h3 id="usage">usage</h3>
350 <p>Print a short help and exit.</p>
352 <h5>Example:</h5>
354 <pre>
355 tazinst usage
356 </pre>
359 <h3 id="help">help</h3>
361 <p>Print a short help for a given setting and exit. Without an argument, print a
362 short help for all settings.</p>
364 <h5>Example:</h5>
366 <pre>
367 tazinst help mode
368 </pre>
371 <h2>EXAMPLES</h2>
374 <h3>Install</h3>
376 <p>How to Install SliTaz on a partition of your hard disk drive. The root
377 partition is not formatted, all data except for any existing <code>/home</code>
378 directory will be removed, (the <code>home</code> directory will be kept as
379 is).</p>
381 <ol>
382 <li>Create an install file:
383 <pre># tazinst new</pre></li>
384 <li>Set the mode as install:
385 <pre># tazinst set mode install</pre></li>
386 <li>Use a cdrom as source:
387 <pre># tazinst set media cdrom</pre></li>
388 <li>Select the partition to install SliTaz on:
389 <pre># tazinst set root_uuid /dev/hda1</pre></li>
390 <li>Install a bootloader:
391 <pre># tazinst set bootloader auto</pre></li>
392 <li>Execute an installation:
393 <pre># tazinst execute</pre></li>
394 </ol>
397 <h3>Complex Install</h3>
399 <p>How to Install SliTaz on your hard disk drive with a separate home partition
400 and a Windows™ dual-boot. The /home and root partitions are both formatted, (all
401 existing data will be lost).</p>
403 <ol>
404 <li>Create an install file:
405 <pre># tazinst new</pre></li>
406 <li>Set the mode as install:
407 <pre># tazinst set mode install</pre></li>
408 <li>Use a Live USB as source:
409 <pre># tazinst set media usb</pre></li>
410 <li>Select a partition on the Live USB:
411 <pre># tazinst set source /dev/sda1</pre></li>
412 <li>Select the partition to install SliTaz on:
413 <pre># tazinst set root_uuid /dev/hda1</pre></li>
414 <li>Format / as ext4:
415 <pre># tazinst set root_format ext4</pre></li>
416 <li>Use a separate /home partition:
417 <pre># tazinst set home_uuid /dev/hda2</pre></li>
418 <li>Format /home as ext2:
419 <pre># tazinst set home_format ext2</pre></li>
420 <li>Install a bootloader:
421 <pre># tazinst set bootloader auto</pre></li>
422 <li>Set up a Windows™ dual-boot:
423 <pre># tazinst set winboot auto</pre></li>
424 <li>Execute an installation:
425 <pre># tazinst execute</pre></li>
426 <li>Remove any traces behind:
427 <pre># tazinst clean</pre></li>
428 </ol>
431 <h3>Upgrade</h3>
433 <p>How to upgrade an already installed SliTaz system on your hard disk drive.
434 Your <code>/home /etc /var/www</code> directories will be kept, all other
435 directories will be removed. Any additional packages added to your old SliTaz
436 system will be updated as long you have an active internet connection.</p>
438 <ol>
439 <li>Create an install file:
440 <pre># tazinst new</pre></li>
441 <li>Set the mode as upgrade:
442 <pre># tazinst set mode upgrade</pre></li>
443 <li>Use web as source:
444 <pre># tazinst set media web</pre></li>
445 <li>Select the stable image:
446 <pre># tazinst set source stable</pre></li>
447 <li>Select the partition containing SliTaz to upgrade:
448 <pre># tazinst set root_uuid /dev/hda1</pre></li>
449 <li>Install a bootloader:
450 <pre># tazinst set bootloader auto</pre></li>
451 <li>Execute an installation:
452 <pre># tazinst execute</pre></li>
453 </ol>
456 <h3>Tips</h3>
458 <ol>
459 <li>Not all settings are used depending on the mode of install. List all
460 settings to see which you need to edit:
461 <pre># tazinst get</pre></li>
462 <li>Check your settings before executing install:
463 <pre># tazinst check</pre></li>
464 </ol>
467 <h2>FILES</h2>
470 <h3>INSTALL FILE</h3>
472 <p>Settings are saved in the install file, then used by tazinst to execute an
473 unattended installation. The default file is <code>./tazinst.rc</code>, but an
474 optional file name may be given as a parameter. The install file is
475 self-documented. The clean command erases this file.</p>
478 <h3>SYSTEM FILE</h3>
480 <p>The <code>/etc/slitaz/tazinst.conf</code> configuration file allows you to
481 change the default settings of <code>tazinst</code> in case you want to use
482 default custom values.</p>
484 <p>All settings are customisable, if a particular setting is missing, just add
485 the name of the setting in caps and enter the new value.</p>
487 <h4>Example:</h4>
489 <p>If you intend to always install SliTaz from the same iso on the web, you just
490 have to modify or add the following values:</p>
492 <pre>
493 MEDIA="web"
494 SOURCE="stable"
495 </pre>
497 <h3>LOG FILE</h3>
499 <p>The file <code>/var/log/tazinst.log</code> contains a log of the install
500 process. The clean command erases this file.</p>
503 <h2>MAINTAINERS</h2>
505 <p>Christophe Lincoln &lt;pankso at slitaz.org&gt;<br />
506 Dominique Corbex &lt;domcox at slitaz.org&gt;</p>
508 <!-- End of content -->
509 </div>
511 <footer>
512 Copyright © 2017-<span class="year"></span> <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a>
513 </footer>
515 </body>
516 </html>