website diff en/doc/manuals/tazwok.en.html @ 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)
children: 266f8d73dfd8
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/en/doc/manuals/tazwok.en.html	Tue May 13 22:50:13 2008 +0000
     1.3 @@ -0,0 +1,182 @@
     1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     1.5 +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><title>Tazwok Manual</title>
     1.6 +
     1.7 +
     1.8 +	
     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-02-06 15:05: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></head><body bgcolor="#ffffff">
    1.26 +<div id="header">
    1.27 +<h1><font color="#3e1220">Tazwok Manual</font></h1>
    1.28 +</div>
    1.29 +<hr />
    1.30 +<!-- Start content -->
    1.31 +<div id="content">
    1.32 +
    1.33 +<h2>NAME</h2>
    1.34 +<p>
    1.35 +Tazwok - SliTaz sources and packages cooker.
    1.36 +</p>
    1.37 +
    1.38 +<h2>SYNTAX</h2>
    1.39 +<pre> tazwok [command] [package|list|category|dir] [--option]
    1.40 +</pre>
    1.41 +
    1.42 +<h2>DESCRIPTION</h2>
    1.43 +<p>
    1.44 +Tazwok is a command line tool to configure and compile a package from source. Tazwok can also create packages
    1.45 +ready to be used by Tazpkg - the SliTaz package manager. To work Tazwok uses a directory containing
    1.46 +the receipt and the necessary information for the construction of the package, this receipt is also used by
    1.47 +Tazpkg and consists of different variables and functions. Tazwok uses a configuration file (/etc/tazwok.conf)
    1.48 +to find the path to the wok, the package sources and generated .tazpkg packages. Tazwok is also available to generate
    1.49 +a list of packages with their md5, create packages interactively, search for packages in the wok, clean generated files and even 
    1.50 +cook several packages at once (See available commands).
    1.51 +</p>
    1.52 +<p>
    1.53 +Tazwok is entirely built from scratch using SHell script, compatible with Bash, it runs under Ash - 
    1.54 +part of the Busbox project. Tazwok is distributed under the free GNU license GPL V3. The SliTaz
    1.55 +Cookbook also provides documentation about Tazwok and the package receipts.
    1.56 +</p>
    1.57 +
    1.58 +<h2>COMMANDS</h2>
    1.59 +<h3><font color="#6c0023">usage</font></h3>
    1.60 +<p>
    1.61 +Usage displays a list of available commands with a short description in English:
    1.62 +</p>
    1.63 +<pre> # tazwok usage
    1.64 +</pre>
    1.65 +<h3><font color="#6c0023">stats</font></h3>
    1.66 +<p>
    1.67 +Stats displays information contained in the configuration file and the number of packages
    1.68 +available in the wok:
    1.69 +</p>
    1.70 +<pre> # tazwok stats
    1.71 +</pre>
    1.72 +<h3><font color="#6c0023">list</font></h3>
    1.73 +<p>
    1.74 +List allows you to list all the packages contained in the wok or list the default categories
    1.75 +(you can create your own). It can also list packages by category:
    1.76 +</p>
    1.77 +<pre> # tazwok list
    1.78 + # tazwok list category
    1.79 +</pre>
    1.80 +<h3><font color="#6c0023">info</font></h3>
    1.81 +<p>
    1.82 +This command provides information on the package - name, version etc. Info on the basic package receipt
    1.83 +is the same displayed by Tazpkg and the installed packages:
    1.84 +</p>
    1.85 +<pre> # tazwok info package
    1.86 +</pre>
    1.87 +<h3><font color="#6c0023">check-log</font></h3>
    1.88 +<p>
    1.89 +When compiling a binary source, Tazwok generates a few messages stored in the log file
    1.90 +'process.log'. To view:
    1.91 +</p>
    1.92 +<pre> # tazwok check-log package
    1.93 +</pre>
    1.94 +<h3><font color="#6c0023">search</font></h3>
    1.95 +<p>
    1.96 +Search allows you to search for packages in the wok. You can specify a term or package name:
    1.97 +</p>
    1.98 +<pre> # tazwok search name
    1.99 +</pre>
   1.100 +<h3><font color="#6c0023">compile</font></h3>
   1.101 +<p>
   1.102 +This command uses the compilation rules (compile_rules) specified in the receipt for the package in
   1.103 +question to compile the sources. Note compilation rules are not always necessary - packages 
   1.104 +generated by 'genpkg' and 'cook' can compile sources and generate the binary package.
   1.105 +Example:
   1.106 +</p>
   1.107 +<pre> # tazwok compile package
   1.108 +</pre>
   1.109 +<h3><font color="#6c0023">genpkg</font></h3>
   1.110 +<p>
   1.111 +Genpkg will generate the .tazpkg package using the 'genpkg_rules' found in the receipt.
   1.112 +Once the package is generated, it's stored in the repository of packages specified in the configuration
   1.113 +file ('tazwok stats' to view). The package can be used by Tazpkg or Tazlito to generate a LiveCD
   1.114 +distribution. Note that the standard files such as local, pixmap or name.desktop are automatically copied
   1.115 +to $fs/usr/share, providing the paths are standard or if the file exists in /stuff. Example using 'genpkg':
   1.116 +</p>
   1.117 +<pre> # tazwok genpkg package
   1.118 +</pre>
   1.119 +<h3><font color="#6c0023">cook</font></h3>
   1.120 +<p>
   1.121 +Cook will simply compile and generate the package:
   1.122 +</p>
   1.123 +<pre> # tazwok cook package
   1.124 +</pre>
   1.125 +<h3><font color="#6c0023">cook-list</font></h3>
   1.126 +<p>
   1.127 +This command will launch 'tazwok cook' on all the packages contained in the list specified in the argument.
   1.128 +Cook-list is used for example, to cook the base system (base-system) without glibc. On SliTaz, you will find
   1.129 +examples of cooking lists in the directory /usr/share/examples/tazwok.cooklists:
   1.130 +</p>
   1.131 +<pre> # tazwok cook-list packages.cooklist
   1.132 +</pre>
   1.133 +<h3><font color="#6c0023">clean</font></h3>
   1.134 +<p>
   1.135 +Clean can simply delete all files generated by compiling and packaging: 
   1.136 +</p>
   1.137 +<pre> # tazwok clean package
   1.138 +</pre>
   1.139 +<h3><font color="#6c0023">new-tree</font></h3>
   1.140 +<p>
   1.141 +The 'new-tree' command can create a new package in the wok and can be used interactively. New tree
   1.142 +will create a directory of the package and a receipt, this receipt can then be edited with your favorite
   1.143 +text editor and can be configured using the '-interactive' option. For help you can look at existing 
   1.144 +receipts or read the documentation in the Cookbook. Example: 
   1.145 +</p>
   1.146 +<pre> # tazwok new-tree package
   1.147 + # tazwok new-tree package --interactive
   1.148 +</pre>
   1.149 +<h3><font color="#6c0023">gen-list</font></h3>
   1.150 +<p>
   1.151 +The 'gen-list' command can generate a list of packages (packages.list), their md5 (packages.md5) and a list
   1.152 +of package options containing more information (packages.txt). The lists are created on the basis of packages
   1.153 +contained in a directory. The list in text format is built using a receipt contained in a wok. The default
   1.154 +packages directory is the one specified in the configuration file, you can also specify the directory on the
   1.155 +command line. Examples: 
   1.156 +</p>
   1.157 +<pre> # tazwok gen-list
   1.158 + # tazwok gen-list --text
   1.159 + # tazwok gen-list /path/to/repository
   1.160 +</pre>
   1.161 +<h3><font color="#6c0023">gen-clean-wok and clean-wok</font></h3>
   1.162 +<p>
   1.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
   1.164 +to test with another. Running 'clean-wok' will clean all packages in the current wok and delete any files
   1.165 +generated. To create a clean wok or clean current wok:
   1.166 +</p>
   1.167 +<pre> # tazwok gen-clean-wok path/to/new-wok
   1.168 + # tazwok clean-wok
   1.169 +</pre>
   1.170 +<h3><font color="#6c0023">remove</font></h3>
   1.171 +<p>
   1.172 +Remove the package specified in the wok, including the receipt, stuff, all files etc:
   1.173 +</p>
   1.174 +<pre> # tazwok remove package
   1.175 +</pre>
   1.176 +
   1.177 +<h2>MAINTAINER</h2>
   1.178 +<p>
   1.179 +Christophe Lincoln &lt;pankso at slitaz.org&gt;
   1.180 +</p>
   1.181 +
   1.182 +<!-- End content -->
   1.183 +</div>
   1.184 +
   1.185 +</body></html>
author	Paul Issott <paul@slitaz.org>
date	Tue May 13 22:50:13 2008 +0000 (2008-05-13)
parents
children	266f8d73dfd8