tazwok rev 4
Add the manual page
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Wed Dec 12 18:52:19 2007 +0100 (2007-12-12) |
| parents | f3ba34f0ea97 |
| children | a9502fdd734b |
| files | doc/tazwok.html |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/doc/tazwok.html Wed Dec 12 18:52:19 2007 +0100 1.3 @@ -0,0 +1,224 @@ 1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 1.5 + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1.6 +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr" lang="fr"> 1.7 +<head> 1.8 + <title>Tazwok Manual</title> 1.9 + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> 1.10 + <meta name="description" content="" /> 1.11 + <meta name="expires" content="never" /> 1.12 + <meta name="modified" content="2007-08-03 13:26:42" /> 1.13 + <style type="text/css"><!-- 1.14 + body { font: 90% sans-serif, vernada, arial; margin: 0; } 1.15 + #header { background: #BFB06B; color: black; height: 50px; 1.16 + border-top: 1px solid black; border-bottom: 1px solid black; } 1.17 + #content { margin: 0px 50px 26px 50px; } 1.18 + h1 { margin: 14px 0px 0px 16px; } 1.19 + li { line-height: 1.4em; } 1.20 + pre { padding: 5px; color: black; background: #e1e0b0; } 1.21 + pre.script { padding: 10px; color: black; background: #e8e8e8; 1.22 + border: 1px inset #333333; } 1.23 + code { font-size: 100%; color: #669900; background: transparent; } 1.24 + hr { color: white; background: white; height: 1px; border: 0; } 1.25 + --></style> 1.26 +</head> 1.27 +<body bgcolor="#ffffff"> 1.28 +<div id="header"> 1.29 +<h1><font color="#3e1220">Tazwok Manual</font></h1> 1.30 +</div> 1.31 +<hr /> 1.32 +<!-- Start content --> 1.33 +<div id="content"> 1.34 + 1.35 +<h2>NOM</h2> 1.36 +<p> 1.37 +Tazwok - SliTaz sources and packages cooker. 1.38 +</p> 1.39 + 1.40 +<h2>SYNTAXE</h2> 1.41 +<pre> 1.42 + tazwok [command] [package|list|category|dir] [--option] 1.43 +</pre> 1.44 + 1.45 +<h2>DESCRIPTION</h2> 1.46 +<p> 1.47 +Tazwok est un outils en ligne de commande permettant de configurer et de 1.48 +compiler un paquet depuis les sources. Tazwok permet aussi de créer des 1.49 +paquets prêts à être utilisé par Tazpkg, le gestionnaire de paquets créer 1.50 +pour SliTaz. Pour fonctionner Tazwok utilise un fichier contenant la recette 1.51 +et toutes les informations nécessaires à la construction du paquet, cette 1.52 +recette est aussi utilisée par Tazpkg et se compose de différentes variables 1.53 +et fonctions. Tazwok utilise un fichier de configuration (/etc/tazwok.conf) 1.54 +pour connaître le chemin vers le wok, les paquets sources et les paquets 1.55 +(.tazpkg) générés. Il est aussi capable de générer une liste paquets avec 1.56 +leurs sommes md5, des créer un nouveau paquet de manière interactive, de faire 1.57 +une recherche, de nettoyer les fichiers générés ou encore de cuire plusieurs 1.58 +paquets en une seule fois (Voir les commandes disponibles). 1.59 +</p> 1.60 +<p> 1.61 +Tazwok est écript en script shell depuis rien (from scratch), compatible Bash, 1.62 +et fonctionnant avec Ash du projet Busybox. Tazwok est distribué sous license 1.63 +libre GNU gpl v3. Les recettes avec leures commades sont basée sur le livre 1.64 +de cuisine de SliTaz, le Cookbook fournit aussi de la documentation au sujet 1.65 +de Tazwok et du dévellopement de SliTaz. 1.66 +</p> 1.67 + 1.68 +<h2>COMMANDES</h2> 1.69 +<h3><font color="#6c0023">usage</font></h3> 1.70 +<p> 1.71 +La commande 'usage' affiche la liste des commandes diponibles avec une petite 1.72 +description en English : 1.73 +</p> 1.74 +<pre> 1.75 + # tazwok usage 1.76 +</pre> 1.77 +<h3><font color="#6c0023">stats</font></h3> 1.78 +<p> 1.79 +Stats affiche les informations contenue dans le fichier de configuration et 1.80 +le nombre de paquets disponibles dans le wok : 1.81 +</p> 1.82 +<pre> 1.83 + # tazwok stats 1.84 +</pre> 1.85 +<h3><font color="#6c0023">list</font></h3> 1.86 +<p> 1.87 +La commande 'list' permet de lister l'ensemble des paquets contenus dans le 1.88 +wok ou de lister les catégories par défauts (vous pouvez créer la votre). Elle 1.89 +permet aussi de lister les paquets d'une catégorie : 1.90 +</p> 1.91 +<pre> 1.92 + # tazwok list 1.93 + # tazwok list category 1.94 +</pre> 1.95 +<h3><font color="#6c0023">info</font></h3> 1.96 +<p> 1.97 +Cette commande donne des informations sur le paquet, nom, version, etc. Info 1.98 +ce base sur la recette du paquet pour connaître les informations, c'est les 1.99 +mêmes infos affichées par Tazpkg et les paquets installés : 1.100 +</p> 1.101 +<pre> 1.102 + # tazwok info package 1.103 +</pre> 1.104 +<h3><font color="#6c0023">check-log</font></h3> 1.105 +<p> 1.106 +Lors de la compilation et génération du paquet binaire, Tazwok génére quelques 1.107 +messages de log stockés dans un fichier 'process.log'. Pour les afficher : 1.108 +</p> 1.109 +<pre> 1.110 + # tazwok check-log package 1.111 +</pre> 1.112 +<h3><font color="#6c0023">search</font></h3> 1.113 +<p> 1.114 +Search permet de faire une recherche de paquet dans le wok. Vous pouvez 1.115 +spécifier un terme ou un nom de paquet : 1.116 +</p> 1.117 +<pre> 1.118 + # tazwok search name 1.119 +</pre> 1.120 +<h3><font color="#6c0023">compile</font></h3> 1.121 +<p> 1.122 +Compile va compiler. Cette commande utilise les régles de compilation 1.123 +(compile_rules) spécifiées dans la recette du paquet en question, pour 1.124 +compiler les sources. A noter qu'il n'y a pas forcement de régles de 1.125 +compilation, des paquets sont directement généré par 'genpkg' et que la 1.126 +commande 'cook' permet de compiler les sources et générer le paquet binaire 1.127 +en une seule fois. Exemple : 1.128 +</p> 1.129 +<pre> 1.130 + # tazwok compile package 1.131 +</pre> 1.132 +<h3><font color="#6c0023">genpkg</font></h3> 1.133 +<p> 1.134 +Genpkg pour <em>Generate package</em>, va générer le paquet (.tazpkg) en 1.135 +utilisant la fonction 'genpkg_rules' trouvée dans sa recette et compresser 1.136 +les fichiers. Une fois le paquet généré, il est stocké dans le repositoire 1.137 +des paquetss spécifié dans le fichier de configuration ('tazwok stats' pour 1.138 +afficher la configuration courante). Le paquet peut ensuite facilement 1.139 +s'installer via Tazpkg ou être utilisé par Tazlito pour générer une 1.140 +distribution LiveCD automatiquement. Utilisation de 'genpkg' : 1.141 +</p> 1.142 +<pre> 1.143 + # tazwok genpkg package 1.144 +</pre> 1.145 +<h3><font color="#6c0023">cook</font></h3> 1.146 +<p> 1.147 +Cook va simplement compiler et empaqueter les paquet en une seule fois : 1.148 +</p> 1.149 +<pre> 1.150 + # tazwok cook package 1.151 +</pre> 1.152 +<h3><font color="#6c0023">cook-list</font></h3> 1.153 +<p> 1.154 +Cette commade va lancer 'tazwok cook' sur tous les paquets contenus dans la 1.155 +liste spécifiées en argument. Cook-list est utilisés par exemple, pour cuire 1.156 +le système de base, les applications de base, le système X, etc. Avant de 1.157 +lancer cette commande avec un grand nombre de paquets, il est conseillé de 1.158 +cuire une fois le système de base (base-system) sans la glibc. Sur SliTaz, 1.159 +vous trouverez des exemples de liste de cuisson (cooklist) dans le répertoire 1.160 +des exemples /usr/share/examples/tazwok/cooklists : 1.161 +</p> 1.162 +<pre> 1.163 + # tazwok cook-list packages.cooklist 1.164 +</pre> 1.165 +<h3><font color="#6c0023">clean</font></h3> 1.166 +<p> 1.167 +Clean permet simplement de supprimer tous les fichiers générés par la 1.168 +compilation et l'empaquetage, pour recommencer à cuire (cook) : 1.169 +</p> 1.170 +<pre> 1.171 + # tazwok clean package 1.172 +</pre> 1.173 +<h3><font color="#6c0023">new-tree</font></h3> 1.174 +<p> 1.175 +La commande 'new-tree' permet de créer un nouveau paquet dans le wok et 1.176 +peut s'utiliser de manière interactive. New-tree va créer le répertoire du 1.177 +paquet et une recette modèle (receipt), cette recette peur être éditée avec 1.178 +votre éditeur de texte préféré et peut se configurer via l'option 1.179 +'--interactive'. Pour vous aider vous pouvez regarder des recettes existantes 1.180 +et lire la documentation du Cookbook. Exemple d'utilisation : 1.181 +</p> 1.182 +<pre> 1.183 + # tazwok new-tree package 1.184 + # tazwok new-tree package --interactive 1.185 +</pre> 1.186 +<h3><font color="#6c0023">gen-list</font></h3> 1.187 +<p> 1.188 +La commande 'gen-list' permet de générer une liste de paquets (packages.list) 1.189 +et leurs sommes md5 (packages.md5), en se basant sur les paquets contenus 1.190 +dans un répertoire. Le répertoire des paquets par défaut est celui spécifié 1.191 +dans le fichier de configuration, vous avez aussi la possibilité de spécifier 1.192 +le répertoire à utiliser sur la ligne de commande : 1.193 +</p> 1.194 +<pre> 1.195 + # tazwok gen-list 1.196 + # tazwok gen-list /path/to/packages-repository 1.197 +</pre> 1.198 +<h3><font color="#6c0023">gen-clean-wok et clean-wok</font></h3> 1.199 +<p> 1.200 +La commande 'gen-clean-wok' permet de générer un wok propre depuis le wok 1.201 +courant. Cette commande est utile pour sauvegarder un version du wok ou copier 1.202 +un wok pour tester avec un autre. Quand à la commande 'clean-wok', elle va 1.203 +nettoyer tous les paquets du wok courant et supprimer tous les fichiers 1.204 +générés. Pour récupérer un wok propre ou nettoyer le wok actuel : 1.205 +</p> 1.206 +<pre> 1.207 + # tazwok gen-clean-wok path/to/new-wok 1.208 + # tazwok clean-wok 1.209 +</pre> 1.210 +<h3><font color="#6c0023">remove</font></h3> 1.211 +<p> 1.212 +Supprime le paquet spécifié du wok, avec tous les fichiers, stuff et recette 1.213 +y compris : 1.214 +</p> 1.215 +<pre> 1.216 + # tazwok remove package 1.217 +</pre> 1.218 + 1.219 +<h2>MAINTENEUR</h2> 1.220 +<p> 1.221 +Christophe Lincoln <pankso at slitaz.org> 1.222 +</p> 1.223 + 1.224 +<!-- End content --> 1.225 +</div> 1.226 +</body> 1.227 +</html>