website view en/doc/manuals/tazwok.en.html @ rev 180
en: Edit Tazwok Manual
| author | Paul Issott <paul@slitaz.org> |
|---|---|
| date | Mon Oct 20 20:11:07 2008 +0000 (2008-10-20) |
| parents | 982bc39a306f |
| children | 6010185e6ab8 |
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="en" lang="en">
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="2008-07-18 20:30:00" />
10 <style type="text/css"><!--
11 body { font: 90% sans-serif, vernada, arial; margin: 0; }
12 #header { background: #f0ba08; 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>NAME</h2>
33 <p>
34 Tazwok - SliTaz sources and packages cooker.
35 </p>
37 <h2>SYNTAX</h2>
38 <pre> tazwok [command] [package|list|category|dir] [--option]
39 </pre>
41 <h2>DESCRIPTION</h2>
42 <p>
43 Tazwok is a command line tool to configure and compile a package from source. Tazwok can also create packages
44 ready to be used by Tazpkg, the SliTaz package manager. To work, Tazwok uses a directory containing
45 the receipt and the necessary information (stuff) for the construction of the package. This receipt is also used by
46 Tazpkg and consists of different variables and functions. Tazwok uses a configuration file (/etc/tazwok.conf)
47 to find the path to the wok, the package sources, and any generated .tazpkg packages. Tazwok can also generate
48 a list of packages with their md5, create packages interactively, search for packages in the wok, clean generated files and even
49 cook several packages at once (See available commands).
50 </p>
51 <p>
52 Tazwok is entirely built from scratch using SHell script, compatible with Bash, it runs under Ash -
53 part of the Busybox project. Tazwok is distributed under the free GNU license GPL V3. The SliTaz
54 Cookbook also provides documentation about Tazwok and the package receipts.
55 </p>
57 <h2>COMMANDS</h2>
58 <h3><font color="#6c0023">usage</font></h3>
59 <p>
60 Usage displays a summary of available commands with a short description in English:
61 </p>
62 <pre> # tazwok usage
63 </pre>
64 <h3><font color="#6c0023">stats</font></h3>
65 <p>
66 Stats displays information contained in the configuration file and the number of packages
67 available in the wok:
68 </p>
69 <pre> # tazwok stats
70 </pre>
71 <h3><font color="#6c0023">list</font></h3>
72 <p>
73 List allows you to list all the packages contained in the wok or the default categories
74 (you can create your own). It can also list packages by category:
75 </p>
76 <pre> # tazwok list
77 # tazwok list category
78 </pre>
79 <h3><font color="#6c0023">info</font></h3>
80 <p>
81 This command provides information on the package - name, version, etc. Info on the basic package receipt
82 is the same as displayed by Tazpkg and the installed packages:
83 </p>
84 <pre> # tazwok info package
85 </pre>
86 <h3><font color="#6c0023">check-log</font></h3>
87 <p>
88 When compiling a binary source, Tazwok generates a few messages stored in the file
89 'process.log'. To view:
90 </p>
91 <pre> # tazwok check-log package
92 </pre>
93 <h3><font color="#6c0023">search</font></h3>
94 <p>
95 Search allows you to search for packages in the wok. You can specify a term or package name:
96 </p>
97 <pre> # tazwok search name
98 </pre>
99 <h3><font color="#6c0023">compile</font></h3>
100 <p>
101 This command uses the compilation rules (compile_rules) specified in the receipt for the package in
102 question to compile the sources. Note compilation rules are not always necessary - packages
103 generated by 'genpkg' and 'cook' can also compile sources and generate the binary package.
104 Example:
105 </p>
106 <pre> # tazwok compile package
107 </pre>
108 <h3><font color="#6c0023">genpkg</font></h3>
109 <p>
110 Genpkg will generate the .tazpkg package using the 'genpkg_rules' found in the receipt.
111 Once the package is generated, it's stored in the repository of packages specified in the configuration
112 file ('tazwok stats' to view). The package can be used by Tazpkg or Tazlito to generate a LiveCD
113 distribution. Note that the standard files such as local, pixmap or name.desktop are automatically copied
114 to $fs/usr/share, provided the paths are standard or if the file exists in /stuff. Example using 'genpkg':
115 </p>
116 <pre> # tazwok genpkg package
117 </pre>
118 <h3><font color="#6c0023">cook</font></h3>
119 <p>
120 Cook will simply compile and generate the package:
121 </p>
122 <pre> # tazwok cook package
123 </pre>
124 <h3><font color="#6c0023">cook-list</font></h3>
125 <p>
126 This command will launch 'tazwok cook' on all the packages contained in the list file specified in the argument.
127 Cook-list is used for example, to cook the base system (base-system) without glibc. On SliTaz, you will find
128 examples of cooking lists in the directory /usr/share/examples/tazwok.cooklists:
129 </p>
130 <pre> # tazwok cook-list packages.cooklist
131 </pre>
132 <h3><font color="#6c0023">clean</font></h3>
133 <p>
134 Clean can simply delete all files generated by compiling and packaging:
135 </p>
136 <pre> # tazwok clean package
137 </pre>
138 <h3><font color="#6c0023">new-tree</font></h3>
139 <p>
140 The 'new-tree' command can create a new package in the wok and can be used interactively. It
141 will create a directory of the package and a receipt that can then be edited with your favorite
142 text editor. The receipt can also be configured using the '--interactive' option. For help you can look at existing
143 receipts or read the documentation in the Cookbook. Example:
144 </p>
145 <pre> # tazwok new-tree package
146 # tazwok new-tree package --interactive
147 </pre>
148 <h3><font color="#6c0023">gen-list</font></h3>
149 <p>
150 The 'gen-list' command can generate a list of packages (packages.list), their md5 (packages.md5) and a list
151 of options containing information (packages.txt). The lists are created on the basis of packages
152 contained in a directory. The list in text format is built using a receipt contained in a wok. The default
153 packages directory is the one specified in the configuration file, you can also specify the directory on the
154 command line. Examples:
155 </p>
156 <pre> # tazwok gen-list
157 # tazwok gen-list --text
158 # tazwok gen-list /path/to/repository
159 </pre>
160 <h3><font color="#6c0023">gen-clean-wok and clean-wok</font></h3>
161 <p>
162 The 'gen-clean-wok' command can create a new wok, this is useful to save a version of the wok, or create a new wok
163 to test with another. Running 'clean-wok' will clean all packages in the current wok and delete any generated
164 files. To generate a clean wok or clean the current wok:
165 </p>
166 <pre> # tazwok gen-clean-wok path/to/new-wok
167 # tazwok clean-wok
168 </pre>
169 <h3><font color="#6c0023">remove</font></h3>
170 <p>
171 Removes the package specified from the wok, including the receipt, stuff, all files, etc:
172 </p>
173 <pre> # tazwok remove package
174 </pre>
175 <h3><font color="#6c0023">build-depends</font></h3>
176 <p>
177 Build-depends generates a list of packages to build a wok:
178 </p>
179 <pre> # tazwok build-depends
180 </pre>
181 <h3><font color="#6c0023">cmp|compare</font></h3>
182 <p>
183 Compares the wok and the cooked packages and generates a report.
184 Obsolete packages can be deleted with the --remove option.
185 The --cook option compiles the packages:
186 </p>
187 <pre> # tazwok compare
188 # tazwok compare --remove
189 # tazwok compare --cook
190 </pre>
191 <h3><font color="#6c0023">check</font></h3>
192 <p>
193 Checks the receipts for common errors:
194 </p>
195 <pre> # tazwok check
196 </pre>
198 <h2>MAINTAINER</h2>
199 <p>
200 Christophe Lincoln <pankso at slitaz.org>
201 </p>
203 <!-- End content -->
204 </div>
206 </body>
207 </html>