tazwok rev 116
Add English manual (to be include in package/distro)
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Fri Feb 13 00:04:21 2009 +0100 (2009-02-13) |
| parents | 39732adba9c7 |
| children | 3fa6decf700e |
| files | doc/tazwok.en.html |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/doc/tazwok.en.html Fri Feb 13 00:04:21 2009 +0100 1.3 @@ -0,0 +1,207 @@ 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="en" lang="en"> 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="2008-07-18 20:30:00" /> 1.13 + <style type="text/css"><!-- 1.14 + body { font: 90% sans-serif, vernada, arial; margin: 0; } 1.15 + #header { background: #f0ba08; 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>NAME</h2> 1.36 +<p> 1.37 +Tazwok - SliTaz sources and packages cooker. 1.38 +</p> 1.39 + 1.40 +<h2>SYNTAX</h2> 1.41 +<pre> tazwok [command] [package|list|category|dir] [--option] 1.42 +</pre> 1.43 + 1.44 +<h2>DESCRIPTION</h2> 1.45 +<p> 1.46 +Tazwok is a command line tool to configure and compile a package from source. Tazwok can also create packages 1.47 +ready to be used by Tazpkg, the SliTaz package manager. To work, Tazwok uses a directory containing 1.48 +the receipt and the necessary information (stuff) for the construction of the package. This receipt is also used by 1.49 +Tazpkg and consists of different variables and functions. Tazwok uses a configuration file (/etc/tazwok.conf) 1.50 +to find the path to the wok, the package sources, and any generated .tazpkg packages. Tazwok can also generate 1.51 +a list of packages with their md5, create packages interactively, search for packages in the wok, clean generated files and even 1.52 +cook several packages at once (See available commands). 1.53 +</p> 1.54 +<p> 1.55 +Tazwok is entirely built from scratch using SHell script, compatible with Bash, it runs under Ash - 1.56 +part of the Busybox project. Tazwok is distributed under the free GNU license GPL V3. The SliTaz 1.57 +Cookbook also provides documentation about Tazwok and the package receipts. 1.58 +</p> 1.59 + 1.60 +<h2>COMMANDS</h2> 1.61 +<h3><font color="#6c0023">usage</font></h3> 1.62 +<p> 1.63 +Usage displays a summary of available commands with a short description in English: 1.64 +</p> 1.65 +<pre> # tazwok usage 1.66 +</pre> 1.67 +<h3><font color="#6c0023">stats</font></h3> 1.68 +<p> 1.69 +Stats displays information contained in the configuration file and the number of packages 1.70 +available in the wok: 1.71 +</p> 1.72 +<pre> # tazwok stats 1.73 +</pre> 1.74 +<h3><font color="#6c0023">list</font></h3> 1.75 +<p> 1.76 +List allows you to list all the packages contained in the wok or the default categories 1.77 +(you can create your own). It can also list packages by category: 1.78 +</p> 1.79 +<pre> # tazwok list 1.80 + # tazwok list category 1.81 +</pre> 1.82 +<h3><font color="#6c0023">info</font></h3> 1.83 +<p> 1.84 +This command provides information on the package - name, version, etc. Info on the basic package receipt 1.85 +is the same as displayed by Tazpkg and the installed packages: 1.86 +</p> 1.87 +<pre> # tazwok info package 1.88 +</pre> 1.89 +<h3><font color="#6c0023">check-log</font></h3> 1.90 +<p> 1.91 +When compiling a binary source, Tazwok generates a few messages stored in the file 1.92 +'process.log'. To view: 1.93 +</p> 1.94 +<pre> # tazwok check-log package 1.95 +</pre> 1.96 +<h3><font color="#6c0023">search</font></h3> 1.97 +<p> 1.98 +Search allows you to search for packages in the wok. You can specify a term or package name: 1.99 +</p> 1.100 +<pre> # tazwok search name 1.101 +</pre> 1.102 +<h3><font color="#6c0023">compile</font></h3> 1.103 +<p> 1.104 +This command uses the compilation rules (compile_rules) specified in the receipt for the package in 1.105 +question to compile the sources. Note compilation rules are not always necessary - packages 1.106 +generated by 'genpkg' and 'cook' can also compile sources and generate the binary package. 1.107 +Example: 1.108 +</p> 1.109 +<pre> # tazwok compile package 1.110 +</pre> 1.111 +<h3><font color="#6c0023">genpkg</font></h3> 1.112 +<p> 1.113 +Genpkg will generate the .tazpkg package using the 'genpkg_rules' found in the receipt. 1.114 +Once the package is generated, it's stored in the repository of packages specified in the configuration 1.115 +file ('tazwok stats' to view). The package can be used by Tazpkg or Tazlito to generate a LiveCD 1.116 +distribution. Note that the standard files such as local, pixmap or name.desktop are automatically copied 1.117 +to $fs/usr/share, provided the paths are standard or if the file exists in /stuff. Example using 'genpkg': 1.118 +</p> 1.119 +<pre> # tazwok genpkg package 1.120 +</pre> 1.121 +<h3><font color="#6c0023">cook</font></h3> 1.122 +<p> 1.123 +Cook will simply compile and generate the package: 1.124 +</p> 1.125 +<pre> # tazwok cook package 1.126 +</pre> 1.127 +<h3><font color="#6c0023">cook-list</font></h3> 1.128 +<p> 1.129 +This command will launch 'tazwok cook' on all the packages contained in the list file specified in the argument. 1.130 +Cook-list is used for example, to cook the base system (base-system) without glibc. On SliTaz, you will find 1.131 +examples of cooking lists in the directory /usr/share/examples/tazwok.cooklists: 1.132 +</p> 1.133 +<pre> # tazwok cook-list packages.cooklist 1.134 +</pre> 1.135 +<h3><font color="#6c0023">clean</font></h3> 1.136 +<p> 1.137 +Clean can simply delete all files generated by compiling and packaging: 1.138 +</p> 1.139 +<pre> # tazwok clean package 1.140 +</pre> 1.141 +<h3><font color="#6c0023">new-tree</font></h3> 1.142 +<p> 1.143 +The 'new-tree' command can create a new package in the wok and can be used interactively. It 1.144 +will create a directory of the package and a receipt that can then be edited with your favorite 1.145 +text editor. The receipt can also be configured using the '--interactive' option. For help you can look at existing 1.146 +receipts or read the documentation in the Cookbook. Example: 1.147 +</p> 1.148 +<pre> # tazwok new-tree package 1.149 + # tazwok new-tree package --interactive 1.150 +</pre> 1.151 +<h3><font color="#6c0023">gen-list</font></h3> 1.152 +<p> 1.153 +The 'gen-list' command can generate a list of packages (packages.list), their md5 (packages.md5) and a list 1.154 +of options containing information (packages.txt). The lists are created on the basis of packages 1.155 +contained in a directory. The list in text format is built using a receipt contained in a wok. The default 1.156 +packages directory is the one specified in the configuration file, you can also specify the directory on the 1.157 +command line. Examples: 1.158 +</p> 1.159 +<pre> # tazwok gen-list 1.160 + # tazwok gen-list --text 1.161 + # tazwok gen-list /path/to/repository 1.162 +</pre> 1.163 +<h3><font color="#6c0023">gen-clean-wok and clean-wok</font></h3> 1.164 +<p> 1.165 +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 1.166 +to test with another. Running 'clean-wok' will clean all packages in the current wok and delete any generated 1.167 +files. To generate a clean wok or clean the current wok: 1.168 +</p> 1.169 +<pre> # tazwok gen-clean-wok path/to/new-wok 1.170 + # tazwok clean-wok 1.171 +</pre> 1.172 +<h3><font color="#6c0023">remove</font></h3> 1.173 +<p> 1.174 +Removes the package specified from the wok, including the receipt, stuff, all files, etc: 1.175 +</p> 1.176 +<pre> # tazwok remove package 1.177 +</pre> 1.178 +<h3><font color="#6c0023">build-depends</font></h3> 1.179 +<p> 1.180 +Build-depends generates a list of packages to build a wok: 1.181 +</p> 1.182 +<pre> # tazwok build-depends 1.183 +</pre> 1.184 +<h3><font color="#6c0023">cmp|compare</font></h3> 1.185 +<p> 1.186 +Compares the wok and the cooked packages and generates a report. 1.187 +Obsolete packages can be deleted with the --remove option. 1.188 +The --cook option compiles the packages. Examples: 1.189 +</p> 1.190 +<pre> # tazwok compare 1.191 + # tazwok compare --remove 1.192 + # tazwok compare --cook 1.193 +</pre> 1.194 +<h3><font color="#6c0023">check</font></h3> 1.195 +<p> 1.196 +Checks the receipts for common errors: 1.197 +</p> 1.198 +<pre> # tazwok check 1.199 +</pre> 1.200 + 1.201 +<h2>MAINTAINER</h2> 1.202 +<p> 1.203 +Christophe Lincoln <pankso at slitaz.org> 1.204 +</p> 1.205 + 1.206 +<!-- End content --> 1.207 +</div> 1.208 + 1.209 +</body> 1.210 +</html>