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