website rev 576
Fix tazlito manual (thanks Paul)
| author | Pascal Bellard <pascal.bellard@slitaz.org> |
|---|---|
| date | Thu Feb 11 15:41:14 2010 +0100 (2010-02-11) |
| parents | 24352975e3f2 |
| children | 6b37e1716092 |
| files | en/doc/manuals/tazlito.en.html fr/doc/manuals/tazlito.html |
line diff
1.1 --- a/en/doc/manuals/tazlito.en.html Wed Feb 10 15:47:30 2010 +0100 1.2 +++ b/en/doc/manuals/tazlito.en.html Thu Feb 11 15:41:14 2010 +0100 1.3 @@ -190,8 +190,8 @@ 1.4 <a name="upgrade-flavor"></a> 1.5 <h3><font color="#6c0023">upgrade-flavor</font></h3> 1.6 <p> 1.7 -The `upgrade-flavor' updates a flavor built for an old Slitaz version. 1.8 -It updates the package list with the latest version available. 1.9 +The `upgrade-flavor' command refreshes a flavor file by updating the 1.10 +list of packages with the latest versions available: 1.11 </p> 1.12 <pre> 1.13 # tazlito upgrade-flavor this-flavor 1.14 @@ -200,60 +200,10 @@ 1.15 <a name="extract-flavor"></a> 1.16 <h3><font color="#6c0023">extract-flavor</font></h3> 1.17 <p> 1.18 -The `extract-flavor' converts a flavor to a file tree in /home/slitaz/flavors/. 1.19 -This tree may be store by Mercurial in 1.20 +The 'extract-flavor' command converts a flavor into an easily modifiable 1.21 +tree structure in /home/slitaz/flavors which can be managed with 1.22 +mercurial: 1.23 <a href="http://hg.slitaz.org/flavors">http://hg.slitaz.org/flavors</a>. 1.24 -The file tree is: 1.25 -<ul> 1.26 -<li> 1.27 -The file <b>receipt</b> discribes the flavor with the variables: 1.28 - <ul> 1.29 - <li> 1.30 -FLAVOR: the flavor name. 1.31 - </li> 1.32 - <li> 1.33 -SHORT_DESC: a one line description. 1.34 - </li> 1.35 - <li> 1.36 -VERSION: free format. 1.37 - </li> 1.38 - <li> 1.39 -MAINTAINER: email address. 1.40 - </li> 1.41 - <li> 1.42 -FRUGAL_RAM: minimum RAM size. Optionnal, may be guessed. 1.43 - </li> 1.44 - <li> 1.45 -ROOTFS_SIZE: unpacked rootfs.gz size in RAM. Optionnal, may be guessed. 1.46 - </li> 1.47 - <li> 1.48 -INITRAMFS_SIZE: rootfs.gz size in CD-ROM. Optionnal, may be guessed. 1.49 - </li> 1.50 - <li> 1.51 -ISO_SIZE: CD-ROM size. Optionnal, may be guessed. 1.52 - </li> 1.53 - <li> 1.54 -ROOTFS_SELECTION: Optionnal, see <i>Meta flavor</i> below. 1.55 - </li> 1.56 - </ul> 1.57 -</li> 1.58 -<li> 1.59 -The file <b>packages.list</b> containts the package name list without 1.60 -version (tazlito will use the last available version for each package). 1.61 -This file is missing if ROOTFS_SELECTION is set in receipt. 1.62 -<li> 1.63 -The optional file <b>mirrors</b> containts the undigest mirror list 1.64 -to be able to use personnal packages. 1.65 -</li> 1.66 -<li> 1.67 -The optional directory <b>rootfs</b> stores the file tree to add to the 1.68 -root filesystem rootfs.gz. Usually configuration files. 1.69 -</li> 1.70 -<li> 1.71 -The optional directory <b>rootcd</b> stores the file tree to add to the 1.72 -root of the CD-ROM. 1.73 -</li> 1.74 -</ul> 1.75 </p> 1.76 <pre> 1.77 # tazlito extract-flavor this-flavor 1.78 @@ -262,8 +212,8 @@ 1.79 <a name="pack-flavor"></a> 1.80 <h3><font color="#6c0023">pack-flavor</font></h3> 1.81 <p> 1.82 -The `pack-flavor' converts a file tree in /home/slitaz/flavors/ to a 1.83 -flavor (.flavor): The reverse of `extract-flavor'. 1.84 +The 'pack-flavor' command converts a tree structure in /home/slitaz/flavors 1.85 + into a flavor file (.flavor). It is inverse of 'tazlito extract-flavor': 1.86 </p> 1.87 <pre> 1.88 # tazlito pack-flavor this-flavor 1.89 @@ -359,8 +309,8 @@ 1.90 <a name="check-list"></a> 1.91 <h3><font color="#6c0023">check-list</font></h3> 1.92 <p> 1.93 -Check whether distro-packages.list is up to date with latest packages 1.94 -version. 1.95 +Checks if the distro-packages.list is updated with the latest package 1.96 +versions. 1.97 </p> 1.98 <pre> 1.99 # tazlito check-list 1.100 @@ -369,7 +319,7 @@ 1.101 <a name="repack"></a> 1.102 <h3><font color="#6c0023">repack</font></h3> 1.103 <p> 1.104 -Recompress the rootfs(es) with the best compression ratio. 1.105 +Recompresses the rootfs with the best possible compression: 1.106 </p> 1.107 <pre> 1.108 # tazlito repack slitaz.iso 1.109 @@ -378,10 +328,10 @@ 1.110 <a name="merge"></a> 1.111 <h3><font color="#6c0023">merge</font></h3> 1.112 <p> 1.113 -Add several flavors in a CD-ROM. They are nested like russian dolls. 1.114 -Each rootfs is a subset of the precedent. The first rootfs comes from the 1.115 -iso in the 2nd parameter. The booting flavor will be chosen according to 1.116 -the detected RAM size. 1.117 +Combines several flavors like nested Russian dolls. Each rootfs is a 1.118 +subset of the previous. The first rootfs is extracted from the ISO image 1.119 +used in the third argument. The flavor will then be chosen to launch at 1.120 +startup according to the amount of RAM available: 1.121 </p> 1.122 <pre> 1.123 # tazlito merge 160M slitaz-core.iso 96M rootfs-justx.gz 32M rootfs-base.gz 1.124 @@ -392,7 +342,7 @@ 1.125 <p> 1.126 The emu-iso command uses the Qemu emulator to start and run SliTaz. 1.127 Qemu is used to test the newly built ISO image without burning to a 1.128 -cdrom or booting into frugal mode. 1.129 +cdrom or booting into frugal mode: 1.130 </p> 1.131 <pre> 1.132 # tazlito emu-iso 1.133 @@ -415,14 +365,14 @@ 1.134 1.135 <h2>FLAVORS</h2> 1.136 <p> 1.137 -The .flavors files hold all necessary informations in few Kb to build a 1.138 -customized SliTaz live CD. 1.139 +A <i>.flavor</i> file contains just a few KB of information needed to 1.140 +(re)manufacture a custom LiveCD of SliTaz. 1.141 </p> 1.142 1.143 <a name="rebuild-flavor"></a> 1.144 -<h3><font color="#6c0023">Rebuild a flavor</font></h3> 1.145 +<h3><font color="#6c0023">Manufacture a flavor</font></h3> 1.146 <p> 1.147 -We choose the flavor to build. 1.148 +You can choose the flavor to (re)manufacture from among those available: 1.149 </p> 1.150 <pre> 1.151 # tazlito list-flavors 1.152 @@ -438,8 +388,8 @@ 1.153 justX 16.1M 51.2M SliTaz with a minimal X environnement 1.154 </pre> 1.155 <p> 1.156 -We will rebuild the <i>eeepc</i> flavor. The root filesystem need 105.4M of RAM and 1.157 -then CD-ROM size is 31.2M. 1.158 +We will start by remanufacturing the <i>eeepc</i> flavor which uses 105.4M of RAM 1.159 +and has a CD-ROM size of 31.2M. 1.160 </p> 1.161 <pre> 1.162 # tazlito clean-distro 1.163 @@ -450,37 +400,86 @@ 1.164 <a name="create-flavor"></a> 1.165 <h3><font color="#6c0023">Create a flavor</font></h3> 1.166 <p> 1.167 -To create a flavor, you must : 1.168 +To create a flavor, you must: 1.169 </p> 1.170 <ul> 1.171 -<li> 1.172 -Either create an ISO image with <b>tazlito gen-distro</b> and create the 1.173 -flavor file with <b>tazlito gen-flavor</b>. 1.174 -</li> 1.175 -<li> 1.176 -Or create the file tree to define the flavor (see <b>tazlito extract-flavor</b>) 1.177 -and create the flavor file with <b>tazlito pack-flavor</b>. 1.178 -</li> 1.179 + <li>Either create an ISO image with <b>tazlito gen-distro</b> and then create 1.180 + a flavor file with <b>tazlito gen-flavor</b></li> 1.181 + <li>Either directly create the tree structure that defines the flavor 1.182 + (see <b>tazlito extract-flavor</b>) and then create the flavor with 1.183 + <b>tazlito pack-flavor</b></li> 1.184 </ul> 1.185 1.186 <a name="publish-flavor"></a> 1.187 -<h3><font color="#6c0023">Publish a flavor</font></h3> 1.188 +<h3><font color="#6c0023">Post a flavor</font></h3> 1.189 <p> 1.190 -The .flavor file are generaly few kilobytes long. They can be sent on Slitaz 1.191 +Because a .flavor file contains just a few KB; it can be easily sent via the 1.192 mailing list. 1.193 </p> 1.194 <p> 1.195 -The result of <b>tazlito extract-flavor</b> can be stored in mercurial 1.196 -(<a href="http://repos.slitaz.org/flavors">http://repos.slitaz.org/flavors</a>). 1.197 -This is the recommended method because 1.198 -the file tree can be checked with mercurial web interface. 1.199 +The results of <b>tazlito extract flavor</b> can also be put in mercurial 1.200 +(http://repos.slitaz.org/flavors). This method is preferred because the 1.201 +tree will be directly visible with the mercurial web interface. 1.202 +</p> 1.203 +<p> 1.204 +This tree includes: 1.205 +<ul> 1.206 +<li> 1.207 +A <b>receipt</b> file discribing the flavor thanks to the variables: 1.208 + <ul> 1.209 + <li> 1.210 +FLAVOR: The flavor name. 1.211 + </li> 1.212 + <li> 1.213 +SHORT_DESC: Short description. 1.214 + </li> 1.215 + <li> 1.216 +VERSION: Free format. 1.217 + </li> 1.218 + <li> 1.219 +MAINTAINER: Email address of maintainer. 1.220 + </li> 1.221 + <li> 1.222 +FRUGAL_RAM: Minimum RAM required (optionnal). 1.223 + </li> 1.224 + <li> 1.225 +ROOTFS_SIZE: Size of rootfs.gz decompressed into RAM (optionnal). 1.226 + </li> 1.227 + <li> 1.228 +INITRAMFS_SIZE: Size of rootfs.gz on the CD-ROM (optionnal). 1.229 + </li> 1.230 + <li> 1.231 +ISO_SIZE: Size of CD-ROM (optionnal). 1.232 + </li> 1.233 + <li> 1.234 +ROOTFS_SELECTION: Optionnal, see <i>Meta flavor</i> below. 1.235 + </li> 1.236 + </ul> 1.237 +</li> 1.238 +<li> 1.239 +The file <b>packages.list</b> containting the list of packages without 1.240 +specifying the version (tazlito uses the lastest available). 1.241 +This file is missing if ROOTFS_SELECTION exits in receipt. 1.242 +<li> 1.243 +The optional <b>mirrors</b> file containing the list of unofficial mirrors 1.244 +(undigest) to be added to include personnal packages. 1.245 +</li> 1.246 +<li> 1.247 +The optional directory <b>rootfs</b> containing the tree to add to the 1.248 +root filesystem rootfs.gz (configuration files usually). 1.249 +</li> 1.250 +<li> 1.251 +The optional directory <b>rootcd</b> containing the tree to add to the 1.252 +root of the CD-ROM. 1.253 +</li> 1.254 +</ul> 1.255 </p> 1.256 1.257 <a name="tune-flavor"></a> 1.258 -<h3><font color="#6c0023">Tune a flavor</font></h3> 1.259 +<h3><font color="#6c0023">Adapt a flavor</font></h3> 1.260 <p> 1.261 -You can modify an existing flavor rather than create one from scratch. 1.262 -For example, to tune the eeepc flavor: 1.263 +It is often easier to modify an existing flavor than to create one from 1.264 +scratch. To adapt the eeepc flavor for example: 1.265 </p> 1.266 <pre> 1.267 # tazpkg get-install mercurial 1.268 @@ -490,30 +489,30 @@ 1.269 # cp -a eeepc myslitaz 1.270 </pre> 1.271 <p> 1.272 -The files in myslitaz can be modified, and 1.273 +Files in my-slitaz can then be adapted, and 1.274 </p> 1.275 <pre> 1.276 # tazlito pack-flavor myslitaz 1.277 </pre> 1.278 <p> 1.279 -Will create the new flavor. 1.280 +Will simply create the new flavor. 1.281 </p> 1.282 1.283 <a name="meta-flavor"></a> 1.284 <h3><font color="#6c0023">Meta flavor</font></h3> 1.285 <p> 1.286 -A meta flavor hold several flavor nested like russian dolls. 1.287 -The booting flavor will be chosen according to the detected RAM size. 1.288 -The variable <i>ROOTFS_SELECTION</i> defines then couples (minimum RAM size 1.289 -and according flavor), 1.290 -<a href="http://hg.slitaz.org/flavors/file/tip/core-3in1/receipt">example</a>: 1.291 +A meta flavor contains several flavors like nested Russian dolls. The flavor 1.292 +will be launched at startup according to the amount of RAM available. 1.293 +The ROOTFS_SELECTION variable defines the minimim RAM and corresponding 1.294 +flavor parameters, <a href="http://hg.slitaz.org/flavors/file/tip/core-3in1/receipt"> 1.295 +example</a>: 1.296 </p> 1.297 <pre> 1.298 ROOTFS_SELECTION="160M core 96M justX 32M base" 1.299 </pre> 1.300 <p> 1.301 -A meta flavor has no packages list <i>(packages.list)</i>. 1.302 -Slitaz kernels prior version 2.6.30 don't support meta flavors. 1.303 +A meta flavor doesn't contain a list of packages (packages.list). SliTaz 1.304 +kernels prior to 2.6.30 do not support meta flavors. 1.305 </p> 1.306 1.307 <h2>MAINTAINER</h2>
2.1 --- a/fr/doc/manuals/tazlito.html Wed Feb 10 15:47:30 2010 +0100 2.2 +++ b/fr/doc/manuals/tazlito.html Thu Feb 11 15:41:14 2010 +0100 2.3 @@ -215,61 +215,6 @@ 2.4 facilement modifiable dans /home/slitaz/flavors/<saveur> qui pourra être gérée 2.5 avec Mercurial dans http://hg.slitaz.org/flavors. 2.6 </p> 2.7 -<p> 2.8 -Cette arborescence comprend : 2.9 -</p> 2.10 -<ul> 2.11 -<li> 2.12 -Le fichier <b>receipt</b> décrit la saveur grâce aux variables : 2.13 - <ul> 2.14 - <li> 2.15 - <i>FLAVOR</i> : le nom de la saveur. 2.16 - </li> 2.17 - <li> 2.18 - <i>SHORT_DESC</i> : la description en une ligne. 2.19 - </li> 2.20 - <li> 2.21 - <i>VERSION</i> : format libre. 2.22 - </li> 2.23 - <li> 2.24 - <i>MAINTAINER</i> : adresse email. 2.25 - </li> 2.26 - <li> 2.27 - <i>FRUGAL_RAM</i> : optionnel (peut être estimé), RAM minimum nécessaire. 2.28 - </li> 2.29 - <li> 2.30 - <i>ROOTFS_SIZE</i> : optionnel (peut être estimé). Taille de rootfs.gz décompressé en RAM. 2.31 - </li> 2.32 - <li> 2.33 - <i>INITRAMFS_SIZE</i> : optionnel (peut être estimé). Taille de rootfs.gz sur le CD-ROM. 2.34 - </li> 2.35 - <li> 2.36 - <i>ISO_SIZE</i> : optionnel (peut être estimé). Taille du CD-ROM. 2.37 - </li> 2.38 - <li> 2.39 - <i>ROOTFS_SELECTION</i> : optionnel, voir <i>Meta saveur</i> plus bas. 2.40 - </li> 2.41 - </ul> 2.42 -</li> 2.43 -<li> 2.44 -Le fichier <b>packages.list</b> contenant la liste des paquets sans 2.45 -préciser leur version (tazlito utilisera la dernière disponible) 2.46 -Ce fichier est absent si ROOTFS_SELECTION est précisé dans receipt. 2.47 -</li> 2.48 -<li> 2.49 -Le fichier optionnel <b>mirrors</b> contenant la liste des miroirs non 2.50 -officiels (undigest) à ajouter pour inclure des paquets personnels. 2.51 -</li> 2.52 -<li> 2.53 -Le répertoire optionnel <b>rootfs</b> contenant l'arborescence à ajouter dans 2.54 -le système de fichier racine rootfs.gz (des fichiers de configuration 2.55 -habituellement). 2.56 -</li> 2.57 -<li> 2.58 -Le répertoire optionnel <b>rootcd</b> contenant l'arborescence à ajouter dans 2.59 -la racine du CD-ROM. 2.60 -</li> 2.61 -</ul> 2.62 <pre> 2.63 # tazlito extract-flavor une-saveur 2.64 </pre> 2.65 @@ -389,7 +334,7 @@ 2.66 <p> 2.67 Réunit plusieurs saveurs imbriquées comme des poupées russes. Chaque rootfs 2.68 est un sous ensemble du précédent. Le premier rootfs est extrait de l'image 2.69 -ISO en 2e paramètre. 2.70 +ISO en 3e paramètre. 2.71 La saveur à lancer sera choisie au démarrage suivant la quantité de RAM 2.72 disponible. 2.73 </p> 2.74 @@ -483,6 +428,61 @@ 2.75 (http://repos.slitaz.org/flavors). Cette méthode est préférable car l'arborescence 2.76 sera directement visible avec l'interface web de mercurial. 2.77 </p> 2.78 +<p> 2.79 +Cette arborescence comprend : 2.80 +</p> 2.81 +<ul> 2.82 +<li> 2.83 +Le fichier <b>receipt</b> décrit la saveur grâce aux variables : 2.84 + <ul> 2.85 + <li> 2.86 + <i>FLAVOR</i> : le nom de la saveur. 2.87 + </li> 2.88 + <li> 2.89 + <i>SHORT_DESC</i> : la description en une ligne. 2.90 + </li> 2.91 + <li> 2.92 + <i>VERSION</i> : format libre. 2.93 + </li> 2.94 + <li> 2.95 + <i>MAINTAINER</i> : adresse email. 2.96 + </li> 2.97 + <li> 2.98 + <i>FRUGAL_RAM</i> : optionnel (peut être estimé), RAM minimum nécessaire. 2.99 + </li> 2.100 + <li> 2.101 + <i>ROOTFS_SIZE</i> : optionnel (peut être estimé). Taille de rootfs.gz décompressé en RAM. 2.102 + </li> 2.103 + <li> 2.104 + <i>INITRAMFS_SIZE</i> : optionnel (peut être estimé). Taille de rootfs.gz sur le CD-ROM. 2.105 + </li> 2.106 + <li> 2.107 + <i>ISO_SIZE</i> : optionnel (peut être estimé). Taille du CD-ROM. 2.108 + </li> 2.109 + <li> 2.110 + <i>ROOTFS_SELECTION</i> : optionnel, voir <i>Meta saveur</i> plus bas. 2.111 + </li> 2.112 + </ul> 2.113 +</li> 2.114 +<li> 2.115 +Le fichier <b>packages.list</b> contenant la liste des paquets sans 2.116 +préciser leur version (tazlito utilisera la dernière disponible) 2.117 +Ce fichier est absent si ROOTFS_SELECTION est précisé dans receipt. 2.118 +</li> 2.119 +<li> 2.120 +Le fichier optionnel <b>mirrors</b> contenant la liste des miroirs non 2.121 +officiels (undigest) à ajouter pour inclure des paquets personnels. 2.122 +</li> 2.123 +<li> 2.124 +Le répertoire optionnel <b>rootfs</b> contenant l'arborescence à ajouter dans 2.125 +le système de fichier racine rootfs.gz (des fichiers de configuration 2.126 +habituellement). 2.127 +</li> 2.128 +<li> 2.129 +Le répertoire optionnel <b>rootcd</b> contenant l'arborescence à ajouter dans 2.130 +la racine du CD-ROM. 2.131 +</li> 2.132 +</ul> 2.133 2.134 <a name="tune-flavor"></a> 2.135 <h3><font color="#6c0023">Adapter une saveur</font></h3>