website view en/doc/manuals/tazwok.en.html @ rev 64
Add Apps to Handbook (en) and typos
| author | Paul Issott <paul@slitaz.org> |
|---|---|
| date | Fri Jun 06 22:42:57 2008 +0000 (2008-06-06) |
| parents | 3fbfd357859a |
| children | b9186eb65961 |
line source
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><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-02-06 15:05: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></head><body bgcolor="#ffffff">
23 <div id="header">
24 <h1><font color="#3e1220">Tazwok Manual</font></h1>
25 </div>
26 <hr />
27 <!-- Start content -->
28 <div id="content">
30 <h2>NAME</h2>
31 <p>
32 Tazwok - SliTaz sources and packages cooker.
33 </p>
35 <h2>SYNTAX</h2>
36 <pre> tazwok [command] [package|list|category|dir] [--option]
37 </pre>
39 <h2>DESCRIPTION</h2>
40 <p>
41 Tazwok is a command line tool to configure and compile a package from source. Tazwok can also create packages
42 ready to be used by Tazpkg - the SliTaz package manager. To work Tazwok uses a directory containing
43 the receipt and the necessary information for the construction of the package, this receipt is also used by
44 Tazpkg and consists of different variables and functions. Tazwok uses a configuration file (/etc/tazwok.conf)
45 to find the path to the wok, the package sources and generated .tazpkg packages. Tazwok can also generate
46 a list of packages with their md5, create packages interactively, search for packages in the wok, clean generated files and even
47 cook several packages at once (See available commands).
48 </p>
49 <p>
50 Tazwok is entirely built from scratch using SHell script, compatible with Bash, it runs under Ash -
51 part of the Busbox project. Tazwok is distributed under the free GNU license GPL V3. The SliTaz
52 Cookbook also provides documentation about Tazwok and the package receipts.
53 </p>
55 <h2>COMMANDS</h2>
56 <h3><font color="#6c0023">usage</font></h3>
57 <p>
58 Usage displays a list of available commands with a short description in English:
59 </p>
60 <pre> # tazwok usage
61 </pre>
62 <h3><font color="#6c0023">stats</font></h3>
63 <p>
64 Stats displays information contained in the configuration file and the number of packages
65 available in the wok:
66 </p>
67 <pre> # tazwok stats
68 </pre>
69 <h3><font color="#6c0023">list</font></h3>
70 <p>
71 List allows you to list all the packages contained in the wok or list the default categories
72 (you can create your own). It can also list packages by category:
73 </p>
74 <pre> # tazwok list
75 # tazwok list category
76 </pre>
77 <h3><font color="#6c0023">info</font></h3>
78 <p>
79 This command provides information on the package - name, version etc. Info on the basic package receipt
80 is the same displayed by Tazpkg and the installed packages:
81 </p>
82 <pre> # tazwok info package
83 </pre>
84 <h3><font color="#6c0023">check-log</font></h3>
85 <p>
86 When compiling a binary source, Tazwok generates a few messages stored in the log file
87 'process.log'. To view:
88 </p>
89 <pre> # tazwok check-log package
90 </pre>
91 <h3><font color="#6c0023">search</font></h3>
92 <p>
93 Search allows you to search for packages in the wok. You can specify a term or package name:
94 </p>
95 <pre> # tazwok search name
96 </pre>
97 <h3><font color="#6c0023">compile</font></h3>
98 <p>
99 This command uses the compilation rules (compile_rules) specified in the receipt for the package in
100 question to compile the sources. Note compilation rules are not always necessary - packages
101 generated by 'genpkg' and 'cook' can compile sources and generate the binary package.
102 Example:
103 </p>
104 <pre> # tazwok compile package
105 </pre>
106 <h3><font color="#6c0023">genpkg</font></h3>
107 <p>
108 Genpkg will generate the .tazpkg package using the 'genpkg_rules' found in the receipt.
109 Once the package is generated, it's stored in the repository of packages specified in the configuration
110 file ('tazwok stats' to view). The package can be used by Tazpkg or Tazlito to generate a LiveCD
111 distribution. Note that the standard files such as local, pixmap or name.desktop are automatically copied
112 to $fs/usr/share, providing the paths are standard or if the file exists in /stuff. Example using 'genpkg':
113 </p>
114 <pre> # tazwok genpkg package
115 </pre>
116 <h3><font color="#6c0023">cook</font></h3>
117 <p>
118 Cook will simply compile and generate the package:
119 </p>
120 <pre> # tazwok cook package
121 </pre>
122 <h3><font color="#6c0023">cook-list</font></h3>
123 <p>
124 This command will launch 'tazwok cook' on all the packages contained in the list specified in the argument.
125 Cook-list is used for example, to cook the base system (base-system) without glibc. On SliTaz, you will find
126 examples of cooking lists in the directory /usr/share/examples/tazwok.cooklists:
127 </p>
128 <pre> # tazwok cook-list packages.cooklist
129 </pre>
130 <h3><font color="#6c0023">clean</font></h3>
131 <p>
132 Clean can simply delete all files generated by compiling and packaging:
133 </p>
134 <pre> # tazwok clean package
135 </pre>
136 <h3><font color="#6c0023">new-tree</font></h3>
137 <p>
138 The 'new-tree' command can create a new package in the wok and can be used interactively. New tree
139 will create a directory of the package and a receipt, this receipt can then be edited with your favorite
140 text editor and can be configured using the '-interactive' option. For help you can look at existing
141 receipts or read the documentation in the Cookbook. Example:
142 </p>
143 <pre> # tazwok new-tree package
144 # tazwok new-tree package --interactive
145 </pre>
146 <h3><font color="#6c0023">gen-list</font></h3>
147 <p>
148 The 'gen-list' command can generate a list of packages (packages.list), their md5 (packages.md5) and a list
149 of package options containing more information (packages.txt). The lists are created on the basis of packages
150 contained in a directory. The list in text format is built using a receipt contained in a wok. The default
151 packages directory is the one specified in the configuration file, you can also specify the directory on the
152 command line. Examples:
153 </p>
154 <pre> # tazwok gen-list
155 # tazwok gen-list --text
156 # tazwok gen-list /path/to/repository
157 </pre>
158 <h3><font color="#6c0023">gen-clean-wok and clean-wok</font></h3>
159 <p>
160 The 'gen-clean-wok' command can create a new wok, this is useful to save a version of the wok, or use a copy
161 to test with another. Running 'clean-wok' will clean all packages in the current wok and delete any files
162 generated. To create a clean wok or clean current wok:
163 </p>
164 <pre> # tazwok gen-clean-wok path/to/new-wok
165 # tazwok clean-wok
166 </pre>
167 <h3><font color="#6c0023">remove</font></h3>
168 <p>
169 Remove the package specified in the wok, including the receipt, stuff, all files etc:
170 </p>
171 <pre> # tazwok remove package
172 </pre>
174 <h2>MAINTAINER</h2>
175 <p>
176 Christophe Lincoln <pankso at slitaz.org>
177 </p>
179 <!-- End content -->
180 </div>
182 </body></html>