tazwok view doc/tazwok.html @ 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 | |
| children | c1f521073999 |
line source
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr" lang="fr">
4 <head>
5 <title>Tazwok Manual</title>
6 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
7 <meta name="description" content="" />
8 <meta name="expires" content="never" />
9 <meta name="modified" content="2007-08-03 13:26:42" />
10 <style type="text/css"><!--
11 body { font: 90% sans-serif, vernada, arial; margin: 0; }
12 #header { background: #BFB06B; color: black; height: 50px;
13 border-top: 1px solid black; border-bottom: 1px solid black; }
14 #content { margin: 0px 50px 26px 50px; }
15 h1 { margin: 14px 0px 0px 16px; }
16 li { line-height: 1.4em; }
17 pre { padding: 5px; color: black; background: #e1e0b0; }
18 pre.script { padding: 10px; color: black; background: #e8e8e8;
19 border: 1px inset #333333; }
20 code { font-size: 100%; color: #669900; background: transparent; }
21 hr { color: white; background: white; height: 1px; border: 0; }
22 --></style>
23 </head>
24 <body bgcolor="#ffffff">
25 <div id="header">
26 <h1><font color="#3e1220">Tazwok Manual</font></h1>
27 </div>
28 <hr />
29 <!-- Start content -->
30 <div id="content">
32 <h2>NOM</h2>
33 <p>
34 Tazwok - SliTaz sources and packages cooker.
35 </p>
37 <h2>SYNTAXE</h2>
38 <pre>
39 tazwok [command] [package|list|category|dir] [--option]
40 </pre>
42 <h2>DESCRIPTION</h2>
43 <p>
44 Tazwok est un outils en ligne de commande permettant de configurer et de
45 compiler un paquet depuis les sources. Tazwok permet aussi de créer des
46 paquets prêts à être utilisé par Tazpkg, le gestionnaire de paquets créer
47 pour SliTaz. Pour fonctionner Tazwok utilise un fichier contenant la recette
48 et toutes les informations nécessaires à la construction du paquet, cette
49 recette est aussi utilisée par Tazpkg et se compose de différentes variables
50 et fonctions. Tazwok utilise un fichier de configuration (/etc/tazwok.conf)
51 pour connaître le chemin vers le wok, les paquets sources et les paquets
52 (.tazpkg) générés. Il est aussi capable de générer une liste paquets avec
53 leurs sommes md5, des créer un nouveau paquet de manière interactive, de faire
54 une recherche, de nettoyer les fichiers générés ou encore de cuire plusieurs
55 paquets en une seule fois (Voir les commandes disponibles).
56 </p>
57 <p>
58 Tazwok est écript en script shell depuis rien (from scratch), compatible Bash,
59 et fonctionnant avec Ash du projet Busybox. Tazwok est distribué sous license
60 libre GNU gpl v3. Les recettes avec leures commades sont basée sur le livre
61 de cuisine de SliTaz, le Cookbook fournit aussi de la documentation au sujet
62 de Tazwok et du dévellopement de SliTaz.
63 </p>
65 <h2>COMMANDES</h2>
66 <h3><font color="#6c0023">usage</font></h3>
67 <p>
68 La commande 'usage' affiche la liste des commandes diponibles avec une petite
69 description en English :
70 </p>
71 <pre>
72 # tazwok usage
73 </pre>
74 <h3><font color="#6c0023">stats</font></h3>
75 <p>
76 Stats affiche les informations contenue dans le fichier de configuration et
77 le nombre de paquets disponibles dans le wok :
78 </p>
79 <pre>
80 # tazwok stats
81 </pre>
82 <h3><font color="#6c0023">list</font></h3>
83 <p>
84 La commande 'list' permet de lister l'ensemble des paquets contenus dans le
85 wok ou de lister les catégories par défauts (vous pouvez créer la votre). Elle
86 permet aussi de lister les paquets d'une catégorie :
87 </p>
88 <pre>
89 # tazwok list
90 # tazwok list category
91 </pre>
92 <h3><font color="#6c0023">info</font></h3>
93 <p>
94 Cette commande donne des informations sur le paquet, nom, version, etc. Info
95 ce base sur la recette du paquet pour connaître les informations, c'est les
96 mêmes infos affichées par Tazpkg et les paquets installés :
97 </p>
98 <pre>
99 # tazwok info package
100 </pre>
101 <h3><font color="#6c0023">check-log</font></h3>
102 <p>
103 Lors de la compilation et génération du paquet binaire, Tazwok génére quelques
104 messages de log stockés dans un fichier 'process.log'. Pour les afficher :
105 </p>
106 <pre>
107 # tazwok check-log package
108 </pre>
109 <h3><font color="#6c0023">search</font></h3>
110 <p>
111 Search permet de faire une recherche de paquet dans le wok. Vous pouvez
112 spécifier un terme ou un nom de paquet :
113 </p>
114 <pre>
115 # tazwok search name
116 </pre>
117 <h3><font color="#6c0023">compile</font></h3>
118 <p>
119 Compile va compiler. Cette commande utilise les régles de compilation
120 (compile_rules) spécifiées dans la recette du paquet en question, pour
121 compiler les sources. A noter qu'il n'y a pas forcement de régles de
122 compilation, des paquets sont directement généré par 'genpkg' et que la
123 commande 'cook' permet de compiler les sources et générer le paquet binaire
124 en une seule fois. Exemple :
125 </p>
126 <pre>
127 # tazwok compile package
128 </pre>
129 <h3><font color="#6c0023">genpkg</font></h3>
130 <p>
131 Genpkg pour <em>Generate package</em>, va générer le paquet (.tazpkg) en
132 utilisant la fonction 'genpkg_rules' trouvée dans sa recette et compresser
133 les fichiers. Une fois le paquet généré, il est stocké dans le repositoire
134 des paquetss spécifié dans le fichier de configuration ('tazwok stats' pour
135 afficher la configuration courante). Le paquet peut ensuite facilement
136 s'installer via Tazpkg ou être utilisé par Tazlito pour générer une
137 distribution LiveCD automatiquement. Utilisation de 'genpkg' :
138 </p>
139 <pre>
140 # tazwok genpkg package
141 </pre>
142 <h3><font color="#6c0023">cook</font></h3>
143 <p>
144 Cook va simplement compiler et empaqueter les paquet en une seule fois :
145 </p>
146 <pre>
147 # tazwok cook package
148 </pre>
149 <h3><font color="#6c0023">cook-list</font></h3>
150 <p>
151 Cette commade va lancer 'tazwok cook' sur tous les paquets contenus dans la
152 liste spécifiées en argument. Cook-list est utilisés par exemple, pour cuire
153 le système de base, les applications de base, le système X, etc. Avant de
154 lancer cette commande avec un grand nombre de paquets, il est conseillé de
155 cuire une fois le système de base (base-system) sans la glibc. Sur SliTaz,
156 vous trouverez des exemples de liste de cuisson (cooklist) dans le répertoire
157 des exemples /usr/share/examples/tazwok/cooklists :
158 </p>
159 <pre>
160 # tazwok cook-list packages.cooklist
161 </pre>
162 <h3><font color="#6c0023">clean</font></h3>
163 <p>
164 Clean permet simplement de supprimer tous les fichiers générés par la
165 compilation et l'empaquetage, pour recommencer à cuire (cook) :
166 </p>
167 <pre>
168 # tazwok clean package
169 </pre>
170 <h3><font color="#6c0023">new-tree</font></h3>
171 <p>
172 La commande 'new-tree' permet de créer un nouveau paquet dans le wok et
173 peut s'utiliser de manière interactive. New-tree va créer le répertoire du
174 paquet et une recette modèle (receipt), cette recette peur être éditée avec
175 votre éditeur de texte préféré et peut se configurer via l'option
176 '--interactive'. Pour vous aider vous pouvez regarder des recettes existantes
177 et lire la documentation du Cookbook. Exemple d'utilisation :
178 </p>
179 <pre>
180 # tazwok new-tree package
181 # tazwok new-tree package --interactive
182 </pre>
183 <h3><font color="#6c0023">gen-list</font></h3>
184 <p>
185 La commande 'gen-list' permet de générer une liste de paquets (packages.list)
186 et leurs sommes md5 (packages.md5), en se basant sur les paquets contenus
187 dans un répertoire. Le répertoire des paquets par défaut est celui spécifié
188 dans le fichier de configuration, vous avez aussi la possibilité de spécifier
189 le répertoire à utiliser sur la ligne de commande :
190 </p>
191 <pre>
192 # tazwok gen-list
193 # tazwok gen-list /path/to/packages-repository
194 </pre>
195 <h3><font color="#6c0023">gen-clean-wok et clean-wok</font></h3>
196 <p>
197 La commande 'gen-clean-wok' permet de générer un wok propre depuis le wok
198 courant. Cette commande est utile pour sauvegarder un version du wok ou copier
199 un wok pour tester avec un autre. Quand à la commande 'clean-wok', elle va
200 nettoyer tous les paquets du wok courant et supprimer tous les fichiers
201 générés. Pour récupérer un wok propre ou nettoyer le wok actuel :
202 </p>
203 <pre>
204 # tazwok gen-clean-wok path/to/new-wok
205 # tazwok clean-wok
206 </pre>
207 <h3><font color="#6c0023">remove</font></h3>
208 <p>
209 Supprime le paquet spécifié du wok, avec tous les fichiers, stuff et recette
210 y compris :
211 </p>
212 <pre>
213 # tazwok remove package
214 </pre>
216 <h2>MAINTENEUR</h2>
217 <p>
218 Christophe Lincoln <pankso at slitaz.org>
219 </p>
221 <!-- End content -->
222 </div>
223 </body>
224 </html>