website rev 45
Add Tazwok Manual to Cookbook (en) and typos
| author | Paul Issott <paul@slitaz.org> |
|---|---|
| date | Tue May 13 22:50:13 2008 +0000 (2008-05-13) |
| parents | 8ad71b0b72c5 |
| children | 65881025ee62 |
| files | en/about/index.html en/doc/cookbook/index.html en/doc/index.html en/doc/manuals/tazusb.en.html en/doc/manuals/tazwok.en.html |
line diff
1.1 --- a/en/about/index.html Tue May 13 15:44:09 2008 +0200 1.2 +++ b/en/about/index.html Tue May 13 22:50:13 2008 +0000 1.3 @@ -82,7 +82,7 @@ 1.4 1.5 <h3>Overview</h3> 1.6 <ul> 1.7 - <li>Root filesystem taking about 80 Mb and ISO image less than 30 Mb.</li> 1.8 + <li>Root filesystem taking about 80 MB and ISO image less than 30 MB.</li> 1.9 <li>Ready to use Web server powered by LightTPD with CGI and PHP support.</li> 1.10 <li>Browse the Web with Mozilla Firefox or Retawq in text mode.</li> 1.11 <li>Sound support provided by Alsa mixer, audio player and CD ripper/encoder.</li>
2.1 --- a/en/doc/cookbook/index.html Tue May 13 15:44:09 2008 +0200 2.2 +++ b/en/doc/cookbook/index.html Tue May 13 22:50:13 2008 +0000 2.3 @@ -32,8 +32,9 @@ 2.4 <h3>Table of contents</h3> 2.5 2.6 <ul> 2.7 - <li><a href="wok-tools.html">Wok & Tools.</a></li> 2.8 - <li><a href="receipts.html">Receipts.</a></li> 2.9 + <li><a href="wok-tools.html">Wok & Tools.</a> - SliTaz Developer Tools.</li> 2.10 + <li><a href="receipts.html">Receipts.</a> - Receipts for creating packages.</li> 2.11 + <li><a href="../manuals/tazwok.en.html">Tazwok manual.</a> - Manual for compiling & generating packages for SliTaz.</li> 2.12 </ul> 2.13 2.14 <h3>About this Cookbook</h3>
3.1 --- a/en/doc/index.html Tue May 13 15:44:09 2008 +0200 3.2 +++ b/en/doc/index.html Tue May 13 22:50:13 2008 +0000 3.3 @@ -72,8 +72,8 @@ 3.4 <li><a href="handbook/">Handbook</a> - SliTaz Handbook. LiveCD usage, 3.5 package management, network or system administration 3.6 and specific instructions.</li> 3.7 - <li><a href="cookbook/">Cookbook</a> - SliTaz Cookbook provides instructions 3.8 - on how to use Tazwok with the wok and information about the package 3.9 + <li><a href="cookbook/">Cookbook</a> - SliTaz Cookbook contains the Tazwok manual and also 3.10 + provides instructions on how to use the wok and package 3.11 receipts.</li> 3.12 <li><a href="manuals/tazusb.en.html">TazUSB manual</a> - SliTaz LiveUSB 3.13 utility.</li>
4.1 --- a/en/doc/manuals/tazusb.en.html Tue May 13 15:44:09 2008 +0200 4.2 +++ b/en/doc/manuals/tazusb.en.html Tue May 13 22:50:13 2008 +0000 4.3 @@ -29,7 +29,7 @@ 4.4 <!-- Start content --> 4.5 <div id="content"> 4.6 4.7 -<h2>Name</h2> 4.8 +<h2>NAME</h2> 4.9 <p> 4.10 TazUSB - Slitaz LiveUSB utility 4.11 </p>
5.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 5.2 +++ b/en/doc/manuals/tazwok.en.html Tue May 13 22:50:13 2008 +0000 5.3 @@ -0,0 +1,182 @@ 5.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5.5 +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><title>Tazwok Manual</title> 5.6 + 5.7 + 5.8 + 5.9 + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> 5.10 + <meta name="description" content="" /> 5.11 + <meta name="expires" content="never" /> 5.12 + <meta name="modified" content="2008-02-06 15:05:00" /> 5.13 + <style type="text/css"><!-- 5.14 + body { font: 90% sans-serif, vernada, arial; margin: 0; } 5.15 + #header { background: #f0ba08; color: black; height: 50px; 5.16 + border-top: 1px solid black; border-bottom: 1px solid black; } 5.17 + #content { margin: 0px 50px 26px 50px; } 5.18 + h1 { margin: 14px 0px 0px 16px; } 5.19 + li { line-height: 1.4em; } 5.20 + pre { padding: 5px; color: black; background: #e1e0b0; } 5.21 + pre.script { padding: 10px; color: black; background: #e8e8e8; 5.22 + border: 1px inset #333333; } 5.23 + code { font-size: 100%; color: #669900; background: transparent; } 5.24 + hr { color: white; background: white; height: 1px; border: 0; } 5.25 + --></style></head><body bgcolor="#ffffff"> 5.26 +<div id="header"> 5.27 +<h1><font color="#3e1220">Tazwok Manual</font></h1> 5.28 +</div> 5.29 +<hr /> 5.30 +<!-- Start content --> 5.31 +<div id="content"> 5.32 + 5.33 +<h2>NAME</h2> 5.34 +<p> 5.35 +Tazwok - SliTaz sources and packages cooker. 5.36 +</p> 5.37 + 5.38 +<h2>SYNTAX</h2> 5.39 +<pre> tazwok [command] [package|list|category|dir] [--option] 5.40 +</pre> 5.41 + 5.42 +<h2>DESCRIPTION</h2> 5.43 +<p> 5.44 +Tazwok is a command line tool to configure and compile a package from source. Tazwok can also create packages 5.45 +ready to be used by Tazpkg - the SliTaz package manager. To work Tazwok uses a directory containing 5.46 +the receipt and the necessary information for the construction of the package, this receipt is also used by 5.47 +Tazpkg and consists of different variables and functions. Tazwok uses a configuration file (/etc/tazwok.conf) 5.48 +to find the path to the wok, the package sources and generated .tazpkg packages. Tazwok is also available to generate 5.49 +a list of packages with their md5, create packages interactively, search for packages in the wok, clean generated files and even 5.50 +cook several packages at once (See available commands). 5.51 +</p> 5.52 +<p> 5.53 +Tazwok is entirely built from scratch using SHell script, compatible with Bash, it runs under Ash - 5.54 +part of the Busbox project. Tazwok is distributed under the free GNU license GPL V3. The SliTaz 5.55 +Cookbook also provides documentation about Tazwok and the package receipts. 5.56 +</p> 5.57 + 5.58 +<h2>COMMANDS</h2> 5.59 +<h3><font color="#6c0023">usage</font></h3> 5.60 +<p> 5.61 +Usage displays a list of available commands with a short description in English: 5.62 +</p> 5.63 +<pre> # tazwok usage 5.64 +</pre> 5.65 +<h3><font color="#6c0023">stats</font></h3> 5.66 +<p> 5.67 +Stats displays information contained in the configuration file and the number of packages 5.68 +available in the wok: 5.69 +</p> 5.70 +<pre> # tazwok stats 5.71 +</pre> 5.72 +<h3><font color="#6c0023">list</font></h3> 5.73 +<p> 5.74 +List allows you to list all the packages contained in the wok or list the default categories 5.75 +(you can create your own). It can also list packages by category: 5.76 +</p> 5.77 +<pre> # tazwok list 5.78 + # tazwok list category 5.79 +</pre> 5.80 +<h3><font color="#6c0023">info</font></h3> 5.81 +<p> 5.82 +This command provides information on the package - name, version etc. Info on the basic package receipt 5.83 +is the same displayed by Tazpkg and the installed packages: 5.84 +</p> 5.85 +<pre> # tazwok info package 5.86 +</pre> 5.87 +<h3><font color="#6c0023">check-log</font></h3> 5.88 +<p> 5.89 +When compiling a binary source, Tazwok generates a few messages stored in the log file 5.90 +'process.log'. To view: 5.91 +</p> 5.92 +<pre> # tazwok check-log package 5.93 +</pre> 5.94 +<h3><font color="#6c0023">search</font></h3> 5.95 +<p> 5.96 +Search allows you to search for packages in the wok. You can specify a term or package name: 5.97 +</p> 5.98 +<pre> # tazwok search name 5.99 +</pre> 5.100 +<h3><font color="#6c0023">compile</font></h3> 5.101 +<p> 5.102 +This command uses the compilation rules (compile_rules) specified in the receipt for the package in 5.103 +question to compile the sources. Note compilation rules are not always necessary - packages 5.104 +generated by 'genpkg' and 'cook' can compile sources and generate the binary package. 5.105 +Example: 5.106 +</p> 5.107 +<pre> # tazwok compile package 5.108 +</pre> 5.109 +<h3><font color="#6c0023">genpkg</font></h3> 5.110 +<p> 5.111 +Genpkg will generate the .tazpkg package using the 'genpkg_rules' found in the receipt. 5.112 +Once the package is generated, it's stored in the repository of packages specified in the configuration 5.113 +file ('tazwok stats' to view). The package can be used by Tazpkg or Tazlito to generate a LiveCD 5.114 +distribution. Note that the standard files such as local, pixmap or name.desktop are automatically copied 5.115 +to $fs/usr/share, providing the paths are standard or if the file exists in /stuff. Example using 'genpkg': 5.116 +</p> 5.117 +<pre> # tazwok genpkg package 5.118 +</pre> 5.119 +<h3><font color="#6c0023">cook</font></h3> 5.120 +<p> 5.121 +Cook will simply compile and generate the package: 5.122 +</p> 5.123 +<pre> # tazwok cook package 5.124 +</pre> 5.125 +<h3><font color="#6c0023">cook-list</font></h3> 5.126 +<p> 5.127 +This command will launch 'tazwok cook' on all the packages contained in the list specified in the argument. 5.128 +Cook-list is used for example, to cook the base system (base-system) without glibc. On SliTaz, you will find 5.129 +examples of cooking lists in the directory /usr/share/examples/tazwok.cooklists: 5.130 +</p> 5.131 +<pre> # tazwok cook-list packages.cooklist 5.132 +</pre> 5.133 +<h3><font color="#6c0023">clean</font></h3> 5.134 +<p> 5.135 +Clean can simply delete all files generated by compiling and packaging: 5.136 +</p> 5.137 +<pre> # tazwok clean package 5.138 +</pre> 5.139 +<h3><font color="#6c0023">new-tree</font></h3> 5.140 +<p> 5.141 +The 'new-tree' command can create a new package in the wok and can be used interactively. New tree 5.142 +will create a directory of the package and a receipt, this receipt can then be edited with your favorite 5.143 +text editor and can be configured using the '-interactive' option. For help you can look at existing 5.144 +receipts or read the documentation in the Cookbook. Example: 5.145 +</p> 5.146 +<pre> # tazwok new-tree package 5.147 + # tazwok new-tree package --interactive 5.148 +</pre> 5.149 +<h3><font color="#6c0023">gen-list</font></h3> 5.150 +<p> 5.151 +The 'gen-list' command can generate a list of packages (packages.list), their md5 (packages.md5) and a list 5.152 +of package options containing more information (packages.txt). The lists are created on the basis of packages 5.153 +contained in a directory. The list in text format is built using a receipt contained in a wok. The default 5.154 +packages directory is the one specified in the configuration file, you can also specify the directory on the 5.155 +command line. Examples: 5.156 +</p> 5.157 +<pre> # tazwok gen-list 5.158 + # tazwok gen-list --text 5.159 + # tazwok gen-list /path/to/repository 5.160 +</pre> 5.161 +<h3><font color="#6c0023">gen-clean-wok and clean-wok</font></h3> 5.162 +<p> 5.163 +The 'gen-clean-wok' command can create a new wok, this is useful to save a version of the wok, or use a copy 5.164 +to test with another. Running 'clean-wok' will clean all packages in the current wok and delete any files 5.165 +generated. To create a clean wok or clean current wok: 5.166 +</p> 5.167 +<pre> # tazwok gen-clean-wok path/to/new-wok 5.168 + # tazwok clean-wok 5.169 +</pre> 5.170 +<h3><font color="#6c0023">remove</font></h3> 5.171 +<p> 5.172 +Remove the package specified in the wok, including the receipt, stuff, all files etc: 5.173 +</p> 5.174 +<pre> # tazwok remove package 5.175 +</pre> 5.176 + 5.177 +<h2>MAINTAINER</h2> 5.178 +<p> 5.179 +Christophe Lincoln <pankso at slitaz.org> 5.180 +</p> 5.181 + 5.182 +<!-- End content --> 5.183 +</div> 5.184 + 5.185 +</body></html>