tazlito rev 158
Update tazlito manual
author | Pascal Bellard <pascal.bellard@slitaz.org> |
---|---|
date | Thu Feb 11 15:39:38 2010 +0100 (2010-02-11) |
parents | 1ac8968de994 |
children | 3fac8978f618 |
files | doc/tazlito.en.html doc/tazlito.fr.html |
line diff
1.1 --- a/doc/tazlito.en.html Tue Feb 02 22:41:44 2010 +0100 1.2 +++ b/doc/tazlito.en.html Thu Feb 11 15:39:38 2010 +0100 1.3 @@ -45,7 +45,7 @@ 1.4 ISO image and regenerate the root filesystem of the LiveCD. 1.5 Tazlito can also generate a distribution from a list of packages 1.6 previously downloaded. To run, Tazlito uses the configuration file 1.7 -/etc/slitaz-tools/tazlito.conf or a tazlito.conf found in the 1.8 +/etc/tazlito/tazlito.conf or a tazlito.conf found in the 1.9 current directory that can be easily generated. 1.10 It specifies the name of the ISO, volume, maintainer and 1.11 the paths of the packages to distribute and the generated ISO. 1.12 @@ -187,6 +187,38 @@ 1.13 # tazlito gen-liveflavor --help 1.14 </pre> 1.15 1.16 +<a name="upgrade-flavor"></a> 1.17 +<h3><font color="#6c0023">upgrade-flavor</font></h3> 1.18 +<p> 1.19 +The `upgrade-flavor' command refreshes a flavor file by updating the 1.20 +list of packages with the latest versions available: 1.21 +</p> 1.22 +<pre> 1.23 + # tazlito upgrade-flavor this-flavor 1.24 +</pre> 1.25 + 1.26 +<a name="extract-flavor"></a> 1.27 +<h3><font color="#6c0023">extract-flavor</font></h3> 1.28 +<p> 1.29 +The 'extract-flavor' command converts a flavor into an easily modifiable 1.30 +tree structure in /home/slitaz/flavors which can be managed with 1.31 +mercurial: 1.32 +<a href="http://hg.slitaz.org/flavors">http://hg.slitaz.org/flavors</a>. 1.33 +</p> 1.34 +<pre> 1.35 + # tazlito extract-flavor this-flavor 1.36 +</pre> 1.37 + 1.38 +<a name="pack-flavor"></a> 1.39 +<h3><font color="#6c0023">pack-flavor</font></h3> 1.40 +<p> 1.41 +The 'pack-flavor' command converts a tree structure in /home/slitaz/flavors 1.42 + into a flavor file (.flavor). It is inverse of 'tazlito extract-flavor': 1.43 +</p> 1.44 +<pre> 1.45 + # tazlito pack-flavor this-flavor 1.46 +</pre> 1.47 + 1.48 <a name="extract-distro"></a> 1.49 <h3><font color="#6c0023">extract-distro</font></h3> 1.50 <p> 1.51 @@ -274,12 +306,43 @@ 1.52 # tazlito -fi slitaz.iso 1.53 </pre> 1.54 1.55 +<a name="check-list"></a> 1.56 +<h3><font color="#6c0023">check-list</font></h3> 1.57 +<p> 1.58 +Checks if the distro-packages.list is updated with the latest package 1.59 +versions. 1.60 +</p> 1.61 +<pre> 1.62 + # tazlito check-list 1.63 +</pre> 1.64 + 1.65 +<a name="repack"></a> 1.66 +<h3><font color="#6c0023">repack</font></h3> 1.67 +<p> 1.68 +Recompresses the rootfs with the best possible compression: 1.69 +</p> 1.70 +<pre> 1.71 + # tazlito repack slitaz.iso 1.72 +</pre> 1.73 + 1.74 +<a name="merge"></a> 1.75 +<h3><font color="#6c0023">merge</font></h3> 1.76 +<p> 1.77 +Combines several flavors like nested Russian dolls. Each rootfs is a 1.78 +subset of the previous. The first rootfs is extracted from the ISO image 1.79 +used in the third argument. The flavor will then be chosen to launch at 1.80 +startup according to the amount of RAM available: 1.81 +</p> 1.82 +<pre> 1.83 + # tazlito merge 160M slitaz-core.iso 96M rootfs-justx.gz 32M rootfs-base.gz 1.84 +</pre> 1.85 + 1.86 <a name="emu-iso"></a> 1.87 <h3><font color="#6c0023">emu-iso</font></h3> 1.88 <p> 1.89 The emu-iso command uses the Qemu emulator to start and run SliTaz. 1.90 Qemu is used to test the newly built ISO image without burning to a 1.91 -cdrom or booting into frugal mode. 1.92 +cdrom or booting into frugal mode: 1.93 </p> 1.94 <pre> 1.95 # tazlito emu-iso 1.96 @@ -300,6 +363,158 @@ 1.97 # tazlito burn-iso slitaz-hacked.iso 1.98 </pre> 1.99 1.100 +<h2>FLAVORS</h2> 1.101 +<p> 1.102 +A <i>.flavor</i> file contains just a few KB of information needed to 1.103 +(re)manufacture a custom LiveCD of SliTaz. 1.104 +</p> 1.105 + 1.106 +<a name="rebuild-flavor"></a> 1.107 +<h3><font color="#6c0023">Manufacture a flavor</font></h3> 1.108 +<p> 1.109 +You can choose the flavor to (re)manufacture from among those available: 1.110 +</p> 1.111 +<pre> 1.112 +# tazlito list-flavors 1.113 + 1.114 +List of flavors 1.115 +================================================================================ 1.116 +Name ISO Rootfs Description 1.117 +================================================================================ 1.118 +base 6.9M 13.1M Minimal set of packages to boot 1.119 +core-3in1 31.5M 105.6M SliTaz core system with justX and base alternatives 1.120 +core 31.5M 104.6M SliTaz core system 1.121 +eeepc 31.2M 105.4M SliTaz eeepc system 1.122 +justX 16.1M 51.2M SliTaz with a minimal X environnement 1.123 +</pre> 1.124 +<p> 1.125 +We will start by remanufacturing the <i>eeepc</i> flavor which uses 105.4M of RAM 1.126 +and has a CD-ROM size of 31.2M. 1.127 +</p> 1.128 +<pre> 1.129 +# tazlito clean-distro 1.130 +# tazlito get-flavor eeepc 1.131 +# tazlito gen-distro 1.132 +</pre> 1.133 + 1.134 +<a name="create-flavor"></a> 1.135 +<h3><font color="#6c0023">Create a flavor</font></h3> 1.136 +<p> 1.137 +To create a flavor, you must: 1.138 +</p> 1.139 +<ul> 1.140 + <li>Either create an ISO image with <b>tazlito gen-distro</b> and then create 1.141 + a flavor file with <b>tazlito gen-flavor</b></li> 1.142 + <li>Either directly create the tree structure that defines the flavor 1.143 + (see <b>tazlito extract-flavor</b>) and then create the flavor with 1.144 + <b>tazlito pack-flavor</b></li> 1.145 +</ul> 1.146 + 1.147 +<a name="publish-flavor"></a> 1.148 +<h3><font color="#6c0023">Post a flavor</font></h3> 1.149 +<p> 1.150 +Because a .flavor file contains just a few KB; it can be easily sent via the 1.151 +mailing list. 1.152 +</p> 1.153 +<p> 1.154 +The results of <b>tazlito extract flavor</b> can also be put in mercurial 1.155 +(http://repos.slitaz.org/flavors). This method is preferred because the 1.156 +tree will be directly visible with the mercurial web interface. 1.157 +</p> 1.158 +<p> 1.159 +This tree includes: 1.160 +<ul> 1.161 +<li> 1.162 +A <b>receipt</b> file discribing the flavor thanks to the variables: 1.163 + <ul> 1.164 + <li> 1.165 +FLAVOR: The flavor name. 1.166 + </li> 1.167 + <li> 1.168 +SHORT_DESC: Short description. 1.169 + </li> 1.170 + <li> 1.171 +VERSION: Free format. 1.172 + </li> 1.173 + <li> 1.174 +MAINTAINER: Email address of maintainer. 1.175 + </li> 1.176 + <li> 1.177 +FRUGAL_RAM: Minimum RAM required (optionnal). 1.178 + </li> 1.179 + <li> 1.180 +ROOTFS_SIZE: Size of rootfs.gz decompressed into RAM (optionnal). 1.181 + </li> 1.182 + <li> 1.183 +INITRAMFS_SIZE: Size of rootfs.gz on the CD-ROM (optionnal). 1.184 + </li> 1.185 + <li> 1.186 +ISO_SIZE: Size of CD-ROM (optionnal). 1.187 + </li> 1.188 + <li> 1.189 +ROOTFS_SELECTION: Optionnal, see <i>Meta flavor</i> below. 1.190 + </li> 1.191 + </ul> 1.192 +</li> 1.193 +<li> 1.194 +The file <b>packages.list</b> containting the list of packages without 1.195 +specifying the version (tazlito uses the lastest available). 1.196 +This file is missing if ROOTFS_SELECTION exits in receipt. 1.197 +<li> 1.198 +The optional <b>mirrors</b> file containing the list of unofficial mirrors 1.199 +(undigest) to be added to include personnal packages. 1.200 +</li> 1.201 +<li> 1.202 +The optional directory <b>rootfs</b> containing the tree to add to the 1.203 +root filesystem rootfs.gz (configuration files usually). 1.204 +</li> 1.205 +<li> 1.206 +The optional directory <b>rootcd</b> containing the tree to add to the 1.207 +root of the CD-ROM. 1.208 +</li> 1.209 +</ul> 1.210 +</p> 1.211 + 1.212 +<a name="tune-flavor"></a> 1.213 +<h3><font color="#6c0023">Adapt a flavor</font></h3> 1.214 +<p> 1.215 +It is often easier to modify an existing flavor than to create one from 1.216 +scratch. To adapt the eeepc flavor for example: 1.217 +</p> 1.218 +<pre> 1.219 +# tazpkg get-install mercurial 1.220 +# cd /home/slitaz 1.221 +# hg clone http://hg.slitaz.org/flavors 1.222 +# cd flavors 1.223 +# cp -a eeepc myslitaz 1.224 +</pre> 1.225 +<p> 1.226 +Files in my-slitaz can then be adapted, and 1.227 +</p> 1.228 +<pre> 1.229 +# tazlito pack-flavor myslitaz 1.230 +</pre> 1.231 +<p> 1.232 +Will simply create the new flavor. 1.233 +</p> 1.234 + 1.235 +<a name="meta-flavor"></a> 1.236 +<h3><font color="#6c0023">Meta flavor</font></h3> 1.237 +<p> 1.238 +A meta flavor contains several flavors like nested Russian dolls. The flavor 1.239 +will be launched at startup according to the amount of RAM available. 1.240 +The ROOTFS_SELECTION variable defines the minimim RAM and corresponding 1.241 +flavor parameters, <a href="http://hg.slitaz.org/flavors/file/tip/core-3in1/receipt"> 1.242 +example</a>: 1.243 +</p> 1.244 +<pre> 1.245 +ROOTFS_SELECTION="160M core 96M justX 32M base" 1.246 +</pre> 1.247 +<p> 1.248 +A meta flavor doesn't contain a list of packages (packages.list). SliTaz 1.249 +kernels prior to 2.6.30 do not support meta flavors. 1.250 +</p> 1.251 + 1.252 <h2>MAINTAINER</h2> 1.253 <p> 1.254 Christophe Lincoln <pankso at slitaz.org>
2.1 --- a/doc/tazlito.fr.html Tue Feb 02 22:41:44 2010 +0100 2.2 +++ b/doc/tazlito.fr.html Thu Feb 11 15:39:38 2010 +0100 2.3 @@ -46,7 +46,7 @@ 2.4 aussi la possibilité de générer une distribution depuis une liste de paquets 2.5 préalablements téléchargés et stockés dans un répertoire. Pour fonctionner, 2.6 l'application Tazlito utilise un fichier de configuration système 2.7 -/etc/slitaz-tools/tazlito.conf ou un fichier tazlito.conf se trouvant dans le 2.8 +/etc/tazlito/tazlito.conf ou un fichier tazlito.conf se trouvant dans le 2.9 répertoire courant. Ce fichier de configuration peut facilement être généré 2.10 automatiquement par Tazlito, il spécifie le nom de l'image ISO, le nom du 2.11 volume, le préparateur, le chemin vers le repositoire des paquets et celui 2.12 @@ -215,61 +215,6 @@ 2.13 facilement modifiable dans /home/slitaz/flavors/<saveur> qui pourra être gérée 2.14 avec Mercurial dans http://hg.slitaz.org/flavors. 2.15 </p> 2.16 -<p> 2.17 -Cette arborescence comprend : 2.18 -</p> 2.19 -<ul> 2.20 -<li> 2.21 -Le fichier <b>receipt</b> décrit la saveur grâce aux variables : 2.22 - <ul> 2.23 - <li> 2.24 - <i>FLAVOR</i> : le nom de la saveur. 2.25 - </li> 2.26 - <li> 2.27 - <i>SHORT_DESC</i> : la description en une ligne. 2.28 - </li> 2.29 - <li> 2.30 - <i>VERSION</i> : format libre. 2.31 - </li> 2.32 - <li> 2.33 - <i>MAINTAINER</i> : adresse email. 2.34 - </li> 2.35 - <li> 2.36 - <i>FRUGAL_RAM</i> : optionnel (peut être estimé), RAM minimum nécessaire. 2.37 - </li> 2.38 - <li> 2.39 - <i>ROOTFS_SIZE</i> : optionnel (peut être estimé). Taille de rootfs.gz décompressé en RAM. 2.40 - </li> 2.41 - <li> 2.42 - <i>INITRAMFS_SIZE</i> : optionnel (peut être estimé). Taille de rootfs.gz sur le CD-ROM. 2.43 - </li> 2.44 - <li> 2.45 - <i>ISO_SIZE</i> : optionnel (peut être estimé). Taille du CD-ROM. 2.46 - </li> 2.47 - <li> 2.48 - <i>ROOTFS_SELECTION</i> : optionnel, voir <i>Meta saveur</i> plus bas. 2.49 - </li> 2.50 - </ul> 2.51 -</li> 2.52 -<li> 2.53 -Le fichier <b>packages.list</b> contenant la liste des paquets sans 2.54 -préciser leur version (tazlito utilisera la dernière disponible) 2.55 -Ce fichier est absent si ROOTFS_SELECTION est précisé dans receipt. 2.56 -</li> 2.57 -<li> 2.58 -Le fichier optionnel <b>mirrors</b> contenant la liste des miroirs non 2.59 -officiels (undigest) à ajouter pour inclure des paquets personnels. 2.60 -</li> 2.61 -<li> 2.62 -Le répertoire optionnel <b>rootfs</b> contenant l'arborescence à ajouter dans 2.63 -le système de fichier racine rootfs.gz (des fichiers de configuretion 2.64 -habituellement). 2.65 -</li> 2.66 -<li> 2.67 -Le répertoire optionnel <b>rootcd</b> contenant l'arborescence à ajouter dans 2.68 -la racine du CD-ROM. 2.69 -</li> 2.70 -</ul> 2.71 <pre> 2.72 # tazlito extract-flavor une-saveur 2.73 </pre> 2.74 @@ -335,13 +280,35 @@ 2.75 # tazlito check-distro 2.76 </pre> 2.77 2.78 +<a name="writeiso"></a> 2.79 +<h3><font color="#6c0023">writeiso</font></h3> 2.80 +<p> 2.81 +Cette commande sauvegarde le système de fichier dans une archive cpio 2.82 +(rootfs.gz) et génère une image ISO bootable. Writeiso peut être utilisé 2.83 +avec une installation sur disque dur ou en mode live. Il sauvegarde aussi 2.84 +votre répertoire /home. Cette commande vous permet de modifier de refabriquer 2.85 +facilement votre propre LiveCD. Il suffit de démarrer le LiveCD, de modifier 2.86 +les fichiers que vous voulez et de faire : 2.87 +</p> 2.88 +<pre> 2.89 + # tazlito writeiso [gzip|lzma|none] 2.90 + # tazlito writeiso gzip 2.91 + # tazlito writeiso gzip image-name 2.92 +</pre> 2.93 + 2.94 <a name="frugal-install"></a> 2.95 <h3><font color="#6c0023">frugal-install</font></h3> 2.96 <p> 2.97 -Installe les fichiers nécessaire du CD-ROM dans /boot/frugal. 2.98 +Installe les fichiers nécessaire du CD-ROM dans /boot/frugal et ajoute 2.99 +une entée GRUB si nécessaire. En mode frugal, Slitaz fonctionne entièrement 2.100 +en mémoire (RAM). Cela permet de tester une distribution sans graver d'ISO ou 2.101 +d'avoir un OS de dépannage prêt lorsque l'ordinateur démarre. 2.102 +Pour installer tous les fichiers nécessaires à partir d'une arborescence ou 2.103 +d'une image ISO : 2.104 </p> 2.105 <pre> 2.106 # tazlito frugal-install slitaz.iso 2.107 + # tazlito -fi slitaz.iso 2.108 </pre> 2.109 2.110 <a name="check-list"></a> 2.111 @@ -367,7 +334,7 @@ 2.112 <p> 2.113 Réunit plusieurs saveurs imbriquées comme des poupées russes. Chaque rootfs 2.114 est un sous ensemble du précédent. Le premier rootfs est extrait de l'image 2.115 -ISO en 2e paramètre. 2.116 +ISO en 3e paramètre. 2.117 La saveur à lancer sera choisie au démarrage suivant la quantité de RAM 2.118 disponible. 2.119 </p> 2.120 @@ -453,7 +420,7 @@ 2.121 <a name="publish-flavor"></a> 2.122 <h3><font color="#6c0023">Publier une saveur</font></h3> 2.123 <p> 2.124 -Les fichiers .flavor ne font généralement que quelques Ko. Il peuvent être 2.125 +Les fichiers .flavor ne font généralement que quelques Ko. Ils peuvent être 2.126 envoyés via la liste de diffusion de SliTaz. 2.127 </p> 2.128 <p> 2.129 @@ -461,6 +428,61 @@ 2.130 (http://repos.slitaz.org/flavors). Cette méthode est préférable car l'arborescence 2.131 sera directement visible avec l'interface web de mercurial. 2.132 </p> 2.133 +<p> 2.134 +Cette arborescence comprend : 2.135 +</p> 2.136 +<ul> 2.137 +<li> 2.138 +Le fichier <b>receipt</b> décrit la saveur grâce aux variables : 2.139 + <ul> 2.140 + <li> 2.141 + <i>FLAVOR</i> : le nom de la saveur. 2.142 + </li> 2.143 + <li> 2.144 + <i>SHORT_DESC</i> : la description en une ligne. 2.145 + </li> 2.146 + <li> 2.147 + <i>VERSION</i> : format libre. 2.148 + </li> 2.149 + <li> 2.150 + <i>MAINTAINER</i> : adresse email. 2.151 + </li> 2.152 + <li> 2.153 + <i>FRUGAL_RAM</i> : optionnel (peut être estimé), RAM minimum nécessaire. 2.154 + </li> 2.155 + <li> 2.156 + <i>ROOTFS_SIZE</i> : optionnel (peut être estimé). Taille de rootfs.gz décompressé en RAM. 2.157 + </li> 2.158 + <li> 2.159 + <i>INITRAMFS_SIZE</i> : optionnel (peut être estimé). Taille de rootfs.gz sur le CD-ROM. 2.160 + </li> 2.161 + <li> 2.162 + <i>ISO_SIZE</i> : optionnel (peut être estimé). Taille du CD-ROM. 2.163 + </li> 2.164 + <li> 2.165 + <i>ROOTFS_SELECTION</i> : optionnel, voir <i>Meta saveur</i> plus bas. 2.166 + </li> 2.167 + </ul> 2.168 +</li> 2.169 +<li> 2.170 +Le fichier <b>packages.list</b> contenant la liste des paquets sans 2.171 +préciser leur version (tazlito utilisera la dernière disponible) 2.172 +Ce fichier est absent si ROOTFS_SELECTION est précisé dans receipt. 2.173 +</li> 2.174 +<li> 2.175 +Le fichier optionnel <b>mirrors</b> contenant la liste des miroirs non 2.176 +officiels (undigest) à ajouter pour inclure des paquets personnels. 2.177 +</li> 2.178 +<li> 2.179 +Le répertoire optionnel <b>rootfs</b> contenant l'arborescence à ajouter dans 2.180 +le système de fichier racine rootfs.gz (des fichiers de configuration 2.181 +habituellement). 2.182 +</li> 2.183 +<li> 2.184 +Le répertoire optionnel <b>rootcd</b> contenant l'arborescence à ajouter dans 2.185 +la racine du CD-ROM. 2.186 +</li> 2.187 +</ul> 2.188 2.189 <a name="tune-flavor"></a> 2.190 <h3><font color="#6c0023">Adapter une saveur</font></h3> 2.191 @@ -501,7 +523,7 @@ 2.192 <p> 2.193 Une meta saveur n'a pas de liste de paquets <i>(packages.list)</i>. 2.194 Les noyaux SliTaz antérieurs à la version 2.6.30 ne supportaient pas les 2.195 -meta saveur. 2.196 +meta saveurs. 2.197 </p> 2.198 2.199 <h2>MAINTENEUR</h2>