website rev 575

Update tazlito manual (en)
author Pascal Bellard <pascal.bellard@slitaz.org>
date Wed Feb 10 15:47:30 2010 +0100 (2010-02-10)
parents a8071fd33c18
children fc71738c7469
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 11:22:03 2010 +0100
     1.2 +++ b/en/doc/manuals/tazlito.en.html	Wed Feb 10 15:47:30 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 @@ -60,6 +60,7 @@
    1.13  </p>
    1.14  
    1.15  <h2>COMMANDS</h2>
    1.16 +
    1.17  <a name="usage"></a>
    1.18  <h3><font color="#6c0023">usage</font></h3>
    1.19  <p>
    1.20 @@ -69,6 +70,7 @@
    1.21  <pre>
    1.22   # tazlito usage
    1.23  </pre>
    1.24 +
    1.25  <a name="stats"></a>
    1.26  <h3><font color="#6c0023">stats</font></h3>
    1.27  <p>
    1.28 @@ -78,6 +80,7 @@
    1.29  <pre>
    1.30   # tazlito stats
    1.31  </pre>
    1.32 +
    1.33  <a name="gen-config"></a>
    1.34  <h3><font color="#6c0023">gen-config</font></h3>
    1.35  <p>
    1.36 @@ -90,6 +93,7 @@
    1.37   # tazlito gen-config
    1.38   # tazlito gen-config /path/to/distro
    1.39  </pre>
    1.40 +
    1.41  <a name="configure"></a>
    1.42  <h3><font color="#6c0023">configure</font></h3>
    1.43  <p>
    1.44 @@ -99,6 +103,7 @@
    1.45  <pre>
    1.46   # tazlito configure
    1.47  </pre>
    1.48 +
    1.49  <a name="gen-iso"></a>
    1.50  <h3><font color="#6c0023">gen-iso</font></h3>
    1.51  <p>
    1.52 @@ -112,6 +117,7 @@
    1.53  <pre>
    1.54   # tazlito gen-iso
    1.55  </pre>
    1.56 +
    1.57  <a name="gen-initiso"></a>
    1.58  <h3><font color="#6c0023">gen-initiso</font></h3>
    1.59  <p>
    1.60 @@ -123,6 +129,7 @@
    1.61  <pre>
    1.62   # tazlito gen-initiso
    1.63  </pre>
    1.64 +
    1.65  <a name="list-flavors"></a>
    1.66  <h3><font color="#6c0023">list-flavors</font></h3>
    1.67  <p>
    1.68 @@ -134,6 +141,7 @@
    1.69   # tazlito list-flavors
    1.70   # tazlito list-flavors --recharge
    1.71  </pre>
    1.72 +
    1.73  <a name="get-flavors"></a>
    1.74  <h3><font color="#6c0023">get-flavor</font></h3>
    1.75  <p>
    1.76 @@ -143,6 +151,7 @@
    1.77  <pre>
    1.78   # tazlito get-flavor particular-flavor
    1.79  </pre>
    1.80 +
    1.81  <a name="show-flavors"></a>
    1.82  <h3><font color="#6c0023">show-flavor</font></h3>
    1.83  <p>
    1.84 @@ -155,6 +164,7 @@
    1.85   # tazlito show-flavor particular-flavor --brief
    1.86   # tazlito show-flavor particular-flavor --brief --noheader
    1.87  </pre>
    1.88 +
    1.89  <a name="gen-flavor"></a>
    1.90  <h3><font color="#6c0023">gen-flavor</font></h3>
    1.91  <p>
    1.92 @@ -165,6 +175,7 @@
    1.93  <pre>
    1.94   # tazlito gen-flavor new-flavor
    1.95  </pre>
    1.96 +
    1.97  <a name="gen-liveflavor"></a>
    1.98  <h3><font color="#6c0023">gen-liveflavor</font></h3>
    1.99  <p>
   1.100 @@ -175,6 +186,89 @@
   1.101  <pre> # tazlito gen-liveflavor
   1.102   # tazlito gen-liveflavor --help
   1.103  </pre>
   1.104 +
   1.105 +<a name="upgrade-flavor"></a>
   1.106 +<h3><font color="#6c0023">upgrade-flavor</font></h3>
   1.107 +<p>
   1.108 +The `upgrade-flavor' updates a flavor built for an old Slitaz version.
   1.109 +It updates the package list with the latest version available.
   1.110 +</p>
   1.111 +<pre>
   1.112 + # tazlito upgrade-flavor this-flavor
   1.113 +</pre>
   1.114 +
   1.115 +<a name="extract-flavor"></a>
   1.116 +<h3><font color="#6c0023">extract-flavor</font></h3>
   1.117 +<p>
   1.118 +The `extract-flavor' converts a flavor to a file tree in /home/slitaz/flavors/.
   1.119 +This tree may be store by Mercurial in 
   1.120 +<a href="http://hg.slitaz.org/flavors">http://hg.slitaz.org/flavors</a>.
   1.121 +The file tree is:
   1.122 +<ul>
   1.123 +<li>
   1.124 +The file <b>receipt</b> discribes the flavor with the variables:
   1.125 +  <ul>
   1.126 +  <li>
   1.127 +FLAVOR: the flavor name.
   1.128 +  </li>
   1.129 +  <li>
   1.130 +SHORT_DESC: a one line description.
   1.131 +  </li>
   1.132 +  <li>
   1.133 +VERSION: free format.
   1.134 +  </li>
   1.135 +  <li>
   1.136 +MAINTAINER: email address.
   1.137 +  </li>
   1.138 +  <li>
   1.139 +FRUGAL_RAM: minimum RAM size. Optionnal, may be guessed.
   1.140 +  </li>
   1.141 +  <li>
   1.142 +ROOTFS_SIZE: unpacked rootfs.gz size in RAM. Optionnal, may be guessed.
   1.143 +  </li>
   1.144 +  <li>
   1.145 +INITRAMFS_SIZE: rootfs.gz size in CD-ROM. Optionnal, may be guessed.
   1.146 +  </li>
   1.147 +  <li>
   1.148 +ISO_SIZE: CD-ROM size. Optionnal, may be guessed.
   1.149 +  </li>
   1.150 +  <li>
   1.151 +ROOTFS_SELECTION: Optionnal, see <i>Meta flavor</i> below.
   1.152 +  </li>
   1.153 +  </ul>
   1.154 +</li>
   1.155 +<li>
   1.156 +The file <b>packages.list</b> containts the package name list without
   1.157 +version (tazlito will use the last available version for each package).
   1.158 +This file is missing if ROOTFS_SELECTION is set in receipt.
   1.159 +<li>
   1.160 +The optional file <b>mirrors</b> containts the undigest mirror list
   1.161 +to be able to use personnal packages.
   1.162 +</li>
   1.163 +<li>
   1.164 +The optional directory <b>rootfs</b> stores the file tree to add to the
   1.165 +root filesystem rootfs.gz. Usually configuration files.
   1.166 +</li>
   1.167 +<li>
   1.168 +The optional directory <b>rootcd</b> stores the file tree to add to the
   1.169 +root of the CD-ROM.
   1.170 +</li>
   1.171 +</ul>
   1.172 +</p>
   1.173 +<pre>
   1.174 + # tazlito extract-flavor this-flavor
   1.175 +</pre>
   1.176 +
   1.177 +<a name="pack-flavor"></a>
   1.178 +<h3><font color="#6c0023">pack-flavor</font></h3>
   1.179 +<p>
   1.180 +The `pack-flavor' converts a file tree in /home/slitaz/flavors/ to a 
   1.181 +flavor (.flavor):  The reverse of `extract-flavor'.
   1.182 +</p>
   1.183 +<pre>
   1.184 + # tazlito pack-flavor this-flavor
   1.185 +</pre>
   1.186 +
   1.187  <a name="extract-distro"></a>
   1.188  <h3><font color="#6c0023">extract-distro</font></h3>
   1.189  <p>
   1.190 @@ -187,6 +281,7 @@
   1.191  <pre>
   1.192   # tazlito extract-distro slitaz-cooking.iso
   1.193  </pre>
   1.194 +
   1.195  <a name="gen-distro"></a>
   1.196  <h3><font color="#6c0023">gen-distro</font></h3>
   1.197  <p>
   1.198 @@ -210,6 +305,7 @@
   1.199   # tazlito gen-distro --iso=slitaz.iso
   1.200   # tazlito gen-distro package-list
   1.201  </pre>
   1.202 +
   1.203  <a name="clean-distro"></a>
   1.204  <h3><font color="#6c0023">clean-distro</font></h3>
   1.205  <p>
   1.206 @@ -219,17 +315,7 @@
   1.207  <pre>
   1.208   # tazlito clean-distro
   1.209  </pre>
   1.210 -<a name="addhacker"></a>
   1.211 -<h3><font color="#6c0023">addhacker</font></h3>
   1.212 -<p>
   1.213 -The 'addhacker' command allows the addition of the user 
   1.214 -hacker to the distribution - it helps to have a user account
   1.215 -without a password. Note that this command changes permissions
   1.216 -on all files in <code>/home/hacker</code>:
   1.217 -</p>
   1.218 -<pre>
   1.219 - # tazlito addhacker
   1.220 -</pre>
   1.221 +
   1.222  <a name="check-distro"></a>
   1.223  <h3><font color="#6c0023">check-distro</font></h3>
   1.224  <p>
   1.225 @@ -239,6 +325,68 @@
   1.226  <pre>
   1.227   # tazlito check-distro
   1.228  </pre>
   1.229 +
   1.230 +<a name="writeiso"></a>
   1.231 +<h3><font color="#6c0023">writeiso</font></h3>
   1.232 +<p>
   1.233 +This command will write the current filesystem to a cpio archive 
   1.234 +(rootfs.gz) and then generate a bootable ISO image. Writeiso can 
   1.235 +be used in a HD install or in live mode and will also archive your 
   1.236 +current /home directory. This command lets you easily remaster and 
   1.237 +build your own LiveCD image, just boot, modify any files, and then: 
   1.238 +
   1.239 +</p>
   1.240 +<pre>
   1.241 + # tazlito writeiso [gzip|lzma|none]
   1.242 + # tazlito writeiso gzip
   1.243 + # tazlito writeiso gzip image-name
   1.244 +</pre>
   1.245 +
   1.246 +<a name="frugal-install"></a>
   1.247 +<h3><font color="#6c0023">frugal-install</font></h3>
   1.248 +<p>
   1.249 +Perfom a frugal installation into /boot/frugal and add a GRUB entry 
   1.250 +if needed. Frugal mode will make SliTaz work completely in memory 
   1.251 +(RAM) - useful to test a distro without burning an ISO or to have a 
   1.252 +rescue system ready to use when the computer powers on. To install 
   1.253 +all needed files from a distro tree or an ISO image: 
   1.254 +</p>
   1.255 +<pre>
   1.256 + # tazlito frugal-install
   1.257 + # tazlito -fi slitaz.iso
   1.258 +</pre>
   1.259 +
   1.260 +<a name="check-list"></a>
   1.261 +<h3><font color="#6c0023">check-list</font></h3>
   1.262 +<p>
   1.263 +Check whether distro-packages.list is up to date with latest packages
   1.264 +version.
   1.265 +</p>
   1.266 +<pre>
   1.267 + # tazlito check-list
   1.268 +</pre>
   1.269 +
   1.270 +<a name="repack"></a>
   1.271 +<h3><font color="#6c0023">repack</font></h3>
   1.272 +<p>
   1.273 +Recompress the rootfs(es) with the best compression ratio.
   1.274 +</p>
   1.275 +<pre>
   1.276 + # tazlito repack slitaz.iso
   1.277 +</pre>
   1.278 +
   1.279 +<a name="merge"></a>
   1.280 +<h3><font color="#6c0023">merge</font></h3>
   1.281 +<p>
   1.282 +Add several flavors in a CD-ROM. They are nested like russian dolls.
   1.283 +Each rootfs is a subset of the precedent. The first rootfs comes from the
   1.284 +iso in the 2nd parameter. The booting flavor will be chosen according to
   1.285 +the detected RAM size.
   1.286 +</p>
   1.287 +<pre>
   1.288 + # tazlito merge 160M slitaz-core.iso 96M rootfs-justx.gz 32M rootfs-base.gz
   1.289 +</pre>
   1.290 +
   1.291  <a name="emu-iso"></a>
   1.292  <h3><font color="#6c0023">emu-iso</font></h3>
   1.293  <p>
   1.294 @@ -250,6 +398,7 @@
   1.295   # tazlito emu-iso
   1.296   # tazlito emu-iso path/to/image.iso
   1.297  </pre>
   1.298 +
   1.299  <a name="burn-iso"></a>
   1.300  <h3><font color="#6c0023">burn-iso</font></h3>
   1.301  <p>
   1.302 @@ -264,6 +413,109 @@
   1.303   # tazlito burn-iso slitaz-hacked.iso
   1.304  </pre>
   1.305  
   1.306 +<h2>FLAVORS</h2>
   1.307 +<p>
   1.308 +The .flavors files hold all necessary informations in few Kb to build a
   1.309 +customized SliTaz live CD.
   1.310 +</p>
   1.311 +
   1.312 +<a name="rebuild-flavor"></a>
   1.313 +<h3><font color="#6c0023">Rebuild a flavor</font></h3>
   1.314 +<p>
   1.315 +We choose the flavor to build.
   1.316 +</p>
   1.317 +<pre>
   1.318 +# tazlito list-flavors
   1.319 +
   1.320 +List of flavors
   1.321 +================================================================================
   1.322 +Name              ISO   Rootfs  Description
   1.323 +================================================================================
   1.324 +base               6.9M  13.1M  Minimal set of packages to boot
   1.325 +core-3in1         31.5M 105.6M  SliTaz core system with justX and base alternatives
   1.326 +core              31.5M 104.6M  SliTaz core system
   1.327 +eeepc             31.2M 105.4M  SliTaz eeepc system
   1.328 +justX             16.1M  51.2M  SliTaz with a minimal X environnement
   1.329 +</pre>
   1.330 +<p>
   1.331 +We will rebuild the <i>eeepc</i> flavor. The root filesystem need 105.4M of RAM and
   1.332 +then CD-ROM size is 31.2M.
   1.333 +</p>
   1.334 +<pre>
   1.335 +# tazlito clean-distro
   1.336 +# tazlito get-flavor eeepc
   1.337 +# tazlito gen-distro
   1.338 +</pre>
   1.339 +
   1.340 +<a name="create-flavor"></a>
   1.341 +<h3><font color="#6c0023">Create a flavor</font></h3>
   1.342 +<p>
   1.343 +To create a flavor, you must :
   1.344 +</p>
   1.345 +<ul>
   1.346 +<li>
   1.347 +Either create an ISO image with <b>tazlito gen-distro</b> and create the
   1.348 +flavor file with <b>tazlito gen-flavor</b>.
   1.349 +</li>
   1.350 +<li>
   1.351 +Or create the file tree to define the flavor (see <b>tazlito extract-flavor</b>)
   1.352 +and create the flavor file with <b>tazlito pack-flavor</b>.
   1.353 +</li>
   1.354 +</ul>
   1.355 +
   1.356 +<a name="publish-flavor"></a>
   1.357 +<h3><font color="#6c0023">Publish a flavor</font></h3>
   1.358 +<p>
   1.359 +The .flavor file are generaly few kilobytes long. They can be sent on Slitaz
   1.360 +mailing list.
   1.361 +</p>
   1.362 +<p>
   1.363 +The result of <b>tazlito extract-flavor</b> can be stored in mercurial
   1.364 +(<a href="http://repos.slitaz.org/flavors">http://repos.slitaz.org/flavors</a>).
   1.365 +This is the recommended method because
   1.366 +the file tree can be checked with mercurial web interface.
   1.367 +</p>
   1.368 +
   1.369 +<a name="tune-flavor"></a>
   1.370 +<h3><font color="#6c0023">Tune a flavor</font></h3>
   1.371 +<p>
   1.372 +You can modify an existing flavor rather than create one from scratch.
   1.373 +For example, to tune the eeepc flavor:
   1.374 +</p>
   1.375 +<pre>
   1.376 +# tazpkg get-install mercurial
   1.377 +# cd /home/slitaz
   1.378 +# hg clone http://hg.slitaz.org/flavors
   1.379 +# cd flavors
   1.380 +# cp -a eeepc myslitaz
   1.381 +</pre>
   1.382 +<p>
   1.383 +The files in myslitaz can be modified, and
   1.384 +</p>
   1.385 +<pre>
   1.386 +# tazlito pack-flavor myslitaz
   1.387 +</pre>
   1.388 +<p>
   1.389 +Will create the new flavor.
   1.390 +</p>
   1.391 +
   1.392 +<a name="meta-flavor"></a>
   1.393 +<h3><font color="#6c0023">Meta flavor</font></h3>
   1.394 +<p>
   1.395 +A meta flavor hold several flavor nested like russian dolls.
   1.396 +The booting flavor will be chosen according to the detected RAM size.
   1.397 +The variable <i>ROOTFS_SELECTION</i> defines then couples (minimum RAM size
   1.398 +and according flavor), 
   1.399 +<a href="http://hg.slitaz.org/flavors/file/tip/core-3in1/receipt">example</a>:
   1.400 +</p>
   1.401 +<pre>
   1.402 +ROOTFS_SELECTION="160M core 96M justX 32M base"
   1.403 +</pre>
   1.404 +<p>
   1.405 +A meta flavor has no packages list <i>(packages.list)</i>.
   1.406 +Slitaz kernels prior version 2.6.30 don't support meta flavors.
   1.407 +</p>
   1.408 +
   1.409  <h2>MAINTAINER</h2>
   1.410  <p>
   1.411  Christophe Lincoln &lt;pankso at slitaz.org&gt;
     2.1 --- a/fr/doc/manuals/tazlito.html	Wed Feb 10 11:22:03 2010 +0100
     2.2 +++ b/fr/doc/manuals/tazlito.html	Wed Feb 10 15:47:30 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 @@ -262,7 +262,7 @@
    2.13  </li>
    2.14  <li>
    2.15  Le répertoire optionnel <b>rootfs</b> contenant l'arborescence à ajouter dans
    2.16 -le système de fichier racine rootfs.gz (des fichiers de configuretion 
    2.17 +le système de fichier racine rootfs.gz (des fichiers de configuration 
    2.18  habituellement).
    2.19  </li>
    2.20  <li>
    2.21 @@ -335,13 +335,35 @@
    2.22   # tazlito check-distro
    2.23  </pre>
    2.24  
    2.25 +<a name="writeiso"></a>
    2.26 +<h3><font color="#6c0023">writeiso</font></h3>
    2.27 +<p>
    2.28 +Cette commande sauvegarde le système de fichier dans une archive cpio
    2.29 +(rootfs.gz) et génère une image ISO bootable. Writeiso peut être utilisé
    2.30 +avec une installation sur disque dur ou en mode live. Il sauvegarde aussi
    2.31 +votre répertoire /home. Cette commande vous permet de modifier de refabriquer
    2.32 +facilement votre propre LiveCD. Il suffit de démarrer le LiveCD, de modifier
    2.33 +les fichiers que vous voulez et de faire :
    2.34 +</p>
    2.35 +<pre>
    2.36 + # tazlito writeiso [gzip|lzma|none]
    2.37 + # tazlito writeiso gzip
    2.38 + # tazlito writeiso gzip image-name
    2.39 +</pre>
    2.40 +
    2.41  <a name="frugal-install"></a>
    2.42  <h3><font color="#6c0023">frugal-install</font></h3>
    2.43  <p>
    2.44 -Installe les fichiers nécessaire du CD-ROM dans /boot/frugal.
    2.45 +Installe les fichiers nécessaire du CD-ROM dans /boot/frugal et ajoute
    2.46 +une entée GRUB si nécessaire. En mode frugal, Slitaz fonctionne entièrement
    2.47 +en mémoire (RAM). Cela permet de tester une distribution sans graver d'ISO ou
    2.48 +d'avoir un OS de dépannage prêt lorsque l'ordinateur démarre.
    2.49 +Pour installer tous les fichiers nécessaires à partir d'une arborescence ou
    2.50 +d'une image ISO :
    2.51  </p>
    2.52  <pre>
    2.53   # tazlito frugal-install slitaz.iso
    2.54 + # tazlito -fi slitaz.iso
    2.55  </pre>
    2.56  
    2.57  <a name="check-list"></a>
    2.58 @@ -453,7 +475,7 @@
    2.59  <a name="publish-flavor"></a>
    2.60  <h3><font color="#6c0023">Publier une saveur</font></h3>
    2.61  <p>
    2.62 -Les fichiers .flavor ne font généralement que quelques Ko. Il peuvent être
    2.63 +Les fichiers .flavor ne font généralement que quelques Ko. Ils peuvent être
    2.64  envoyés via la liste de diffusion de SliTaz.
    2.65  </p>
    2.66  <p>
    2.67 @@ -501,7 +523,7 @@
    2.68  <p>
    2.69  Une meta saveur n'a pas de liste de paquets <i>(packages.list)</i>.
    2.70  Les noyaux SliTaz antérieurs à la version 2.6.30 ne supportaient pas les
    2.71 -meta saveur.
    2.72 +meta saveurs.
    2.73  </p>
    2.74  
    2.75  <h2>MAINTENEUR</h2>