tazwok annotate doc/tazwok.en.html @ rev 370

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