SliTaz Repositories

     1.1 --- a/doc/tazwok.en.html	Sun May 08 10:15:19 2011 +0000
     1.2 +++ b/doc/tazwok.en.html	Sun May 08 12:28:10 2011 +0000
     1.3 @@ -38,7 +38,13 @@
     1.4  <h2>SYNTAX</h2>
     1.5  <pre> tazwok [command] [package|list|category|dir] [--option]
     1.6  </pre>
     1.7 -
     1.8 +<h2>WARNING</h2>
     1.9 +<p>
    1.10 +This version of tazwok (tazwok-3.9 .*) is currently subject to active development and parts of program have 
    1.11 +not yet been completely revised and corrected. In its current state, however you should not encounter major 
    1.12 +problems during use. Any suggestions/comments/contributions are welcome: you will find the email 
    1.13 +address of the maintainer at the end of this document.
    1.14 +</p>
    1.15  <h2>DESCRIPTION</h2>
    1.16  <p>
    1.17  Tazwok is a command line tool to configure and compile a package from source. Tazwok can also create packages
    1.18 @@ -47,7 +53,7 @@
    1.19  Tazpkg and consists of different variables and functions. Tazwok uses a configuration file (/etc/tazwok.conf)
    1.20  to find the path to the wok, the package sources, and any generated .tazpkg packages. Tazwok can also generate
    1.21  a list of packages with their md5, create packages interactively, search for packages in the wok, clean generated files and even 
    1.22 -cook several packages at once (See available commands).
    1.23 +cook several packages at once (See available commands). Tazwok can be used to recompile SliTaz entirely from source.
    1.24  </p>
    1.25  <p>
    1.26  Tazwok is entirely built from scratch using SHell script, compatible with Bash; it runs under Ash - 
    1.27 @@ -55,6 +61,26 @@
    1.28  Cookbook also provides documentation about Tazwok and the package receipts.
    1.29  </p>
    1.30  
    1.31 +<h2>GENERAL OPTIONS</h2>
    1.32 +<p>
    1.33 +Three options can be used with almost all orders tazwok. They are used to define the deposit to 
    1.34 +which to apply the command, ie the folder containing subfolders clean-wok, wok, packages, 
    1.35 +packages, incoming, src, log, optionally chroot. They are: SLITAZ_DIR: the directory in which are 
    1.36 +deposits (default: /home/slitaz as defined in /etc/slitaz/slitaz.conf) SLITAZ_VERSION name of 
    1.37 +the reference version, such stable cooking, ... (default: version that you use as defined 
    1.38 +in /etc/slitaz-release) undigest: Indicates the use of a secondary deposit, for which 
    1.39 +the reference is SLITAZ_VERSION.
    1.40 +</p>
    1.41 +<p>
    1.42 +In the absence of the option undigest, the address used will be depositing 
    1.43 +$SLITAZ_DIR/$SLITAZ_VERSION (example would be /home/slitaz/cooking by default 
    1.44 +if you use cooking) undigest If the option is present, it will $SLITAZ_DIR/$undigest 
    1.45 +undigest option is important for some commands (eg configure-chroot build-depends, etc..), 
    1.46 +when packets are missing from the secondary deposit, or information concerning them must be 
    1.47 +found in the deposit reference. In other cases the use of or undigest SLITAZ_VERSION gives the same result.
    1.48 +</p>
    1.49 +<pre> # tazwok build-depends linux --SLITAZ_DIR=/home/pas-slitaz --SLITAZ_VERSION=cooking --undigest=undigest
    1.50 +</pre>
    1.51  <h2>COMMANDS</h2>
    1.52  <a name="usage"></a>
    1.53  <h3><font color="#6c0023">usage</font></h3>
    1.54 @@ -134,21 +160,63 @@
    1.55  <a name="cook-list"></a>
    1.56  <h3><font color="#6c0023">cook-list</font></h3>
    1.57  <p>
    1.58 -This command will launch 'tazwok cook' on all the packages contained in the list file specified in the argument.
    1.59 -Cook-list is used for example, to cook the base system (base-system) without glibc. On SliTaz, you will find
    1.60 -examples of cooking lists in the directory /usr/share/examples/tazwok.cooklists:
    1.61 +This command will launch 'tazwok cook' on all packages in the list specified as an argument, and 
    1.62 +their dependencies cooking if they are missing or need updating. Cook-list is used, for example, 
    1.63 +to cook the base system, core applications, the X, packets of flavor, etc.. Cooklist can also be 
    1.64 +used on a single package with the option - pkg. The option - Forced can be used to anneal all the 
    1.65 +dependencies required cooking, even if they are already available and current, example toolchain 
    1.66 +(see SLITAZ_TOOLCHAIN ​​in /etc/slitaz/tazwok.conf). Without argument, cook-list uses the 
    1.67 +default list of cooking, located in the folder 'package '.
    1.68  </p>
    1.69 -<pre> # tazwok cook-list packages.cooklist
    1.70 +<pre> # tazwok cook-list 
    1.71 + # tazwok cook-list packages.cooklist --forced
    1.72 + # tazwok cook-list --pkg=firefox
    1.73  </pre>
    1.74  <a name="cook-commit"></a>
    1.75  <h3><font color="#6c0023">cook-commit</font></h3>
    1.76  <p>
    1.77 -This is newer cook commits in repo:
    1.78 +The command 'cook-commit' to look for packages with revenue /stuff/descriptions were modified and updated 
    1.79 +using cook. The research uses data changes md5 (identification by measuring different characteristics 
    1.80 +of files) elements used in the previous cooking packages. This information is stored in the wok, if 
    1.81 +they are absent they are derived from packages already prepared. The option - Forced commit forces to 
    1.82 +check md5 use data from the packages, which is useful for retrieving consistent information if you 
    1.83 +changed the lists commit/cooklist manually (rare). Default check-commit targets only those packages 
    1.84 +which are already present in the package pools. The option - missing can scan the entire wok and 
    1.85 +add all the packages that have not been cooked to the list.
    1.86  </p>
    1.87 -<pre># tazwok cook-commit
    1.88 - # tazwok cook-commit --missing
    1.89 +<pre> # tazwok cook-commit # cook packages that need updating
    1.90 + # tazwok cook-commit --forced # Same, correting any inconsistencies in the data
    1.91 + # tazwok cook-commit --missing # Cook packages that need updating + the missing packets
    1.92   # tazwok cook-commit --missing --forced
    1.93  </pre>
    1.94 +<a name "cook-all"></a>
    1.95 +<h3><font color="#6c0023">cook-all</font></h3>
    1.96 +<p>
    1.97 +The command 'cook-all ' anneal allows all packets from wok. Without options, it is identical to cook-commit: 
    1.98 +annealing only packets with receipts / description.txt / stuffs have been modified. The option - missing 
    1.99 +also has the same effect as in cook-commit: add all the packages that have not yet been prepared. 
   1.100 +The difference lies in the - Forced: here it means anneal all packets, even if they have not been 
   1.101 +updated since the last firing. As explained below, the core of the tool chain will never be annealed 
   1.102 +by this command.
   1.103 +</p>
   1.104 +<pre> # tazwok cook-all # identical to tazwok cook-commit
   1.105 +# tazwok cook-all --missing # identical to tazwok cook-commit --missing
   1.106 +# tazowk cook-all --forced # annealing all existing packages in your repository except the toolchain
   1.107 +# tazwok cook-all --forced --missing # annealing all packages of the wok execpt the toolchain
   1.108 +</pre>
   1.109 +<a name="cook-toolchain"></a>
   1.110 +<h3><font color="#6c0023">cook-toolchain</font></h3>
   1.111 +<p> Cook-toolchain is dedicated to controlling the firing of packages that allow all other preparations.
   1.112 + Indeed, the packets in the heart of the tool chain (for SliTaz linux-api-headers/glibc/binutils/gcc) 
   1.113 + can not / should not be cooked differently in SliTaz. The preparation process of the tool chain is 
   1.114 + unique, and uses the script 'cook-toolchain' from 'tazchroot'. The method used is an adaptation of 
   1.115 + that presented in the book Linux From Scratch: a first toolchain temporary and unrelated to the 
   1.116 + equipment / system used is prepared and used in cooking packages from the "real" chain tools. It 
   1.117 + should be noted that this operation is quite long (several hours to several tens of hours depending 
   1.118 + on hardware). This is the first step to fully realize SliTaz to compile from source.
   1.119 +</p>
   1.120 +<pre> # tazwok cook-toolchain
   1.121 +</pre>
   1.122  <a name="clean"></a>
   1.123  <h3><font color="#6c0023">clean</font></h3>
   1.124  <p>
   1.125 @@ -180,6 +248,33 @@
   1.126   # tazwok gen-list --text
   1.127   # tazwok gen-list /path/to/repository
   1.128  </pre>
   1.129 +<a name="check-list"></a>
   1.130 +<h3><font color="#6c0023">check-list</font></h3>
   1.131 +<p>
   1.132 +The command 'checklist' fulfills the same function as 'gen-list', but it looks for packages that information 
   1.133 +must be updated. For this reason it is generally faster, particularly when few packets have been modified. 
   1.134 +Commands automatically use the cook. As for 'gen-list', if you do not specify a target, 'packages'and 
   1.135 +'packages-incoming' will both be updated.
   1.136 +</p>
   1.137 +<pre> # tazwok check-list
   1.138 + # tazwok check-list /path/to/repository
   1.139 +</pre>
   1.140 +<a name="gen-wok-db"></a>
   1.141 +<h3><font color="#6c0023">gen-wok-db</font></h3>
   1.142 +<p>
   1.143 +'wok-db' means files used to quickly obtain the dependency relationships between revenue. This information is usually 
   1.144 +added whenever necessary, and automatically, by tazwok. 'gen-wok-db ' is used to re-generate them in case of file corruption 
   1.145 +(eg you killed tazwok while automatically generating these files).
   1.146 +</p>
   1.147 +<pre> # tazwok gen-wok-db
   1.148 +</pre>
   1.149 +<a name="report"></a>
   1.150 +<h3><font color="#6c0023">report</font></h3>
   1.151 +<p>Displays the contents of lists: commit / cooklist / broken / blocked, or only the requested list argument.
   1.152 +</p>
   1.153 +<pre> # tazwok report
   1.154 + # tazwok report cooklist
   1.155 +</pre>
   1.156  <a name="gen-clean-wok"></a>
   1.157  <h3><font color="#6c0023">gen-clean-wok and clean-wok</font></h3>
   1.158  <p>
   1.159 @@ -215,6 +310,16 @@
   1.160   # tazwok compare --remove
   1.161   # tazwok compare --cook
   1.162  </pre> 
   1.163 +<a name="check-commit"></a>
   1.164 +<h3><font color="#6c0023">check-commit</font></h3>
   1.165 +<p>
   1.166 +'check-commit' scans the wok to find recipes that have been modified and added to the cooklist default. 
   1.167 +Options --forced and --missing here play the same role for cook-commit.
   1.168 +</p>
   1.169 +<pre> # tazwok check-commit
   1.170 +# tazwok check-commit --forced
   1.171 +# tazwok check-commit --missing
   1.172 +</pre>
   1.173  <a name="check"></a>
   1.174  <h3><font color="#6c0023">check</font></h3>
   1.175  <p>
   1.176 @@ -222,13 +327,32 @@
   1.177  </p>
   1.178  <pre> # tazwok check
   1.179  </pre>
   1.180 +<a name="update-wok"></a>
   1.181  <h3><font color="#6c0023">update-wok</font></h3>
   1.182  <p>
   1.183 -Copies receipts from clean-wok to wok:
   1.184 +'update-wok' downloads or updates the contents in the wok-wok clean record of the deposit. Then it copies 
   1.185 +the new elements in the cooking wok (wok folder) and remove those that no longer exist in the new version. 
   1.186 +The addresses and the method (or tarball hg) used by this command are defined in tazwok.conf. The --local 
   1.187 +option allows for only the second operation (copy files to the wok). This is useful if you have make changes
   1.188 +in the local clean-wok and want to add to wok cooking. This is especially useful for users of 
   1.189 +mercurial (hg), since this tool is much faster with a wok that contains no files associated with the 
   1.190 +compilation. In this case, make changes in the clean-wok then: tazwok update-wok --local.
   1.191  </p>
   1.192  <pre> # tazwok update-wok
   1.193   # tazwok update-wok --local
   1.194  </pre>
   1.195 +<a name="webserver"></a>
   1.196 +<h3><font color="#6c0023">webserver</font></h3>
   1.197 +<p>
   1.198 +'webserver' is the command that creates a PHP interface that provides information about the status 
   1.199 +of deposits. Several deposits can be added/removed by using the options --SLITAZ_VERSION/--undigest. 
   1.200 +The argument 'on ' you can add a deposit to the web interface, while the 'off' withdraw (in each case). 
   1.201 +Using the default configuration, the interface will be available in your browser address 
   1.202 +http://localhost/vhosts/bb/. Package 'php' should be installed to use this command.
   1.203 +</p>
   1.204 +<pre> # tazwok webserver on
   1.205 + # tazwok webserver off
   1.206 +</pre>
   1.207  <h3><font color="#6c0023">chroot</font></h3>
   1.208  <p>
   1.209  Gen and Chroot into /home/slitaz/VERSION/chroot for building packages