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