website annotate en/doc/manuals/tazwok.en.html @ rev 180

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