SliTaz Repositories

     1.1 --- a/doc/tazlito.en.html	Tue Jan 26 21:30:03 2010 +0000
     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 &lt;pankso at slitaz.org&gt;