tazpkg diff doc/tazpkg.en.html @ rev 302
Add manual translation (en,fr,pt) and symlink to the default english one
author | Christophe Lincoln <pankso@slitaz.org> |
---|---|
date | Fri Oct 02 17:59:37 2009 +0200 (2009-10-02) |
parents | |
children | 703be3441860 |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/doc/tazpkg.en.html Fri Oct 02 17:59:37 2009 +0200 1.3 @@ -0,0 +1,443 @@ 1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 1.5 + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1.6 +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 1.7 +<head> 1.8 + <title>Tazpkg Manual</title> 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-07-18 19:45: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> 1.26 +</head> 1.27 +<body bgcolor="#ffffff"> 1.28 +<div id="header"> 1.29 +<h1><font color="#3e1220">Tazpkg Manual</font></h1> 1.30 +</div> 1.31 +<hr /> 1.32 +<!-- Start content --> 1.33 +<div id="content"> 1.34 + 1.35 +<h2>NAME</h2> 1.36 +<p> 1.37 +Tazpkg - Tiny autonomous zone package manager 1.38 +</p> 1.39 + 1.40 +<h2>SYNTAX</h2> 1.41 +<pre> 1.42 + tazpkg [command] [package|dir|pattern|list|cat|--opt] [dir|--opt] 1.43 +</pre> 1.44 + 1.45 +<h2>DESCRIPTION</h2> 1.46 +<p> 1.47 +Tazpkg is an ultralightweight (~ 35KB) package manager to 1.48 +install, list, download, update or remove precompiled packages 1.49 +on a GNU/Linux system. Tazpkg offers commands for searching 1.50 +and creating packages and was created independently. 1.51 +The format of the packages using the *.tazpkg extension is a 1.52 +cpio archive containing a filesystem compressed with gzip, 1.53 +a receipt and an optional description. Tazpkg also manages 1.54 +dependencies based on package receipts. Each receipt contains 1.55 +all the information about a package and can also include 1.56 +pre and post installation functions. The same receipt is 1.57 +used by Tazwok to compile sources and generate a .tazpkg 1.58 +package. 1.59 +</p> 1.60 +<p> 1.61 +Tazpkg is entirely built from scratch using SHell script, 1.62 +compatible with Bash, it runs under Ash - part of the Busybox 1.63 +project. Tazpkg is distributed under the free GNU license GPL V3. 1.64 +</p> 1.65 + 1.66 +<h2>COMMANDS</h2> 1.67 +<h3><font color="#6c0023">list</font></h3> 1.68 +<p> 1.69 +List packages installed on the system. This command displays 1.70 +a column list of all installed packages, It also allows you to list the 1.71 +categories, packages based on category and packages placed on hold. 1.72 +You can also use the 'search' command for a list based 1.73 +on a term or package name: 1.74 +</p> 1.75 +<pre> 1.76 + # tazpkg list 1.77 + # tazpkg list cat|categories 1.78 + # tazpkg list blocked 1.79 +</pre> 1.80 +<a name="xhtml-list"></a> 1.81 +<h3><font color="#6c0023">xhtml-list</font></h3> 1.82 +<p> 1.83 +The 'xhtml-list' command can create a XHTML list 1.84 +of all the packages installed on the system which can be read 1.85 +with your preferred Web browser. It can be run as a normal 1.86 +user and creates a page 'installed-packages.html' in 1.87 +your current directory. Note that you can change the name of the 1.88 +generated list via the command line: 1.89 +</p> 1.90 +<pre> 1.91 + # tazpkg xhtml-list 1.92 + # tazpkg xhtml-list list-name.html 1.93 +</pre> 1.94 +<a name="list-mirror"></a> 1.95 +<h3><font color="#6c0023">list-mirror</font></h3> 1.96 +<p> 1.97 +List packages available on the mirror. This command will 1.98 +display the 'packages.list' file recharged from the mirror. 1.99 +If this doesn't exist, you will be asked to launch 1.100 +'tazpkg recharge' as administrator (root) for a list of 1.101 +available packages . The --diff option is used to display 1.102 +the differences between the last and current list of packages: 1.103 +</p> 1.104 +<pre> 1.105 + # tazpkg list-mirror 1.106 + # tazpkg list-mirror --diff 1.107 +</pre> 1.108 +<a name="info"></a> 1.109 +<h3><font color="#6c0023">info</font></h3> 1.110 +<p> 1.111 +Display any information available in the receipt for the 1.112 +package in question - its version, category, maintainer, 1.113 +Web site and any dependencies (see also Tazwok for more 1.114 +information on receipts): 1.115 +</p> 1.116 +<pre> 1.117 + # tazpkg info busybox 1.118 +</pre> 1.119 +<a name="desc"></a> 1.120 +<h3><font color="#6c0023">desc</font></h3> 1.121 +<p> 1.122 +Description of the package (if it exists). This command 1.123 +displays the 'description.txt' file of each package (a simple 1.124 +text file, justified to 80 characters to fit in a standard terminal): 1.125 +</p> 1.126 +<pre> 1.127 + # tazpkg desc busybox 1.128 +</pre> 1.129 +<a name="list-config"></a> 1.130 +<h3><font color="#6c0023">list-config</font></h3> 1.131 +<p> 1.132 +Lists the system configuration files. The --box option displays 1.133 +in table format: 1.134 +</p> 1.135 +<pre> # tazpkg list-config 1.136 + # tazpkg list-config --box 1.137 +</pre> 1.138 +<a name="list-files"></a> 1.139 +<h3><font color="#6c0023">list-files</font></h3> 1.140 +<p> 1.141 +List all files installed with a package. This command will 1.142 +simply read and display the 'files.list' of each package which is 1.143 +automatically generated when the package is created and is 1.144 +also used to remove files when uninstalling a package. 1.145 +To list the files installed with the package bc: 1.146 +</p> 1.147 +<pre> 1.148 + # tazpkg list-files bc 1.149 +</pre> 1.150 +<a name="search"></a> 1.151 +<h3><font color="#6c0023">search</font></h3> 1.152 +<p> 1.153 +Search for packages by owner or package name. This command 1.154 +will search for the term wanted in the installed packages and the 1.155 +list of available packages on the mirror. To obtain the 1.156 +latest list of installable packages on the mirror, just 1.157 +run 'tazpkg recharge' before conducting a search: 1.158 +</p> 1.159 +<pre> 1.160 + # tazpkg search gcc 1.161 +</pre> 1.162 +<a name="search-file"></a> 1.163 +<h3><font color="#6c0023">search-file</font></h3> 1.164 +<p> 1.165 +The 'search-file' command allows you to search for a file 1.166 +among the files installed by the packages. This command is very 1.167 +useful to find the full path to a file and determine if 1.168 +a file is present on the system. Example: 1.169 +</p> 1.170 +<pre> 1.171 + $ tazpkg search-file libnss 1.172 +</pre> 1.173 +<a name="install"></a> 1.174 +<h3><font color="#6c0023">install</font></h3> 1.175 +<p> 1.176 +This command allows the installation of a local package with 1.177 +the .tazpkg extension. See 'get-install' to install a 1.178 +package from the internet. Note that you can force the 1.179 +installation via the --forced, uninstall and reinstall options 1.180 +or specify the root system where you want to install the 1.181 +packages via the -root= option: 1.182 +</p> 1.183 +<pre> 1.184 + # tazpkg install package-1.0.tazpkg 1.185 + Or : 1.186 + # tazpkg install path/to/package-1.0.tazpkg --forced 1.187 + Or : 1.188 + # tazpkg install path/to/package-1.0.tazpkg --root=/mnt/rootfs 1.189 +</pre> 1.190 +<h3><font color="#6c0023">install-list or get-install-list</font></h3> 1.191 +<p> 1.192 +Install a set of packages listed in a file. This command 1.193 +allows you to (download and) install several packages with a single command 1.194 +and can also be forced: 1.195 +</p> 1.196 +<pre> # tazpkg install-list my-packages.list 1.197 + # tazpkg get-install-list my-packages.list --forced 1.198 +</pre> 1.199 +<a name="link"></a> 1.200 +<h3><font color="#6c0023">link</font></h3> 1.201 +<p> 1.202 +This command allows the installation of a package from another media 1.203 +device. The set up is done through symbolic links and consumes very little 1.204 +memory. It is generally used within the system RAM to install add-ons 1.205 +from an USB key: 1.206 +</p> 1.207 +<pre> 1.208 + # tazpkg link openoffice /media/usbdisk 1.209 +</pre> 1.210 +<a name="remove"></a> 1.211 +<h3><font color="#6c0023">remove</font></h3> 1.212 +<p> 1.213 +Remove a package. You will be asked for confirmation (y/N). 1.214 +This command will delete all files installed with the package. 1.215 +To view the list of files, use the 'list-files' command 1.216 +followed by the name of the package. Example 1.217 +with the package bc: 1.218 +</p> 1.219 +<pre> 1.220 + # tazpkg remove bc 1.221 +</pre> 1.222 +<a name="extract"></a> 1.223 +<h3><font color="#6c0023">extract</font></h3> 1.224 +<p> 1.225 +Extract a package into a directory. If you do not specify 1.226 +the destination directory, the package will be extracted 1.227 +in the current directory using the name package-version: 1.228 +</p> 1.229 +<pre> 1.230 + # tazpkg extract package.tazpkg 1.231 + # tazpkg extract package.tazpkg target/dir 1.232 +</pre> 1.233 +<a name="pack"></a> 1.234 +<h3><font color="#6c0023">pack</font></h3> 1.235 +<p> 1.236 +The 'pack' command will create a package from a directory 1.237 +prepared in advance or from an unpacked package. It can 1.238 +also manually create a .tazpkg package (see the Tazwok documentation 1.239 +for the automatic creation of packages). To pack a package: 1.240 +</p> 1.241 +<pre> 1.242 + # tazpkg pack package-version 1.243 +</pre> 1.244 +<a name="repack"></a> 1.245 +<h3><font color="#6c0023">repack</font></h3> 1.246 +<p> 1.247 +The 'repack' command allows you to recreate a package from 1.248 +the files on a system where it was previously installed. 1.249 +To repack a package: 1.250 +</p> 1.251 +<pre> 1.252 + # tazpkg repack package 1.253 +</pre> 1.254 +<a name="repack-config"></a> 1.255 +<h3><font color="#6c0023">repack-config</font></h3> 1.256 +<p> 1.257 +The 'repack-config' command recreates a package 1.258 +of the system configuration files (see list-config). It is enough 1.259 +to install the package to find the current configuration. To repack 1.260 +the configuration files: 1.261 +</p> 1.262 +<pre> # tazpkg repack-config 1.263 +</pre> 1.264 +<a name="recharge"></a> 1.265 +<h3><font color="#6c0023">recharge</font></h3> 1.266 +<p> 1.267 +Recharge the list of available packages on the mirror. 1.268 +This command will download the most recent 'packages.list' 1.269 +of installable packages on the mirror and before starting 1.270 +will save the old list. Once the list is updated 1.271 +you can then use the 'list' and 'search' commands. To view 1.272 +and list the differences, you can use 'list-mirror --diff', and to view 1.273 +and update packages, you can simply 'upgrade'. To recharge the 1.274 +latest list of packages: 1.275 +</p> 1.276 +<pre> 1.277 + # tazpkg recharge 1.278 +</pre> 1.279 +<a name="upgrade"></a> 1.280 +<h3><font color="#6c0023">upgrade</font></h3> 1.281 +<p> 1.282 +Upgrade allows you to update all installed packages available 1.283 +on the current mirror. Upgrading packages is an important 1.284 +part of system security, it helps to keep you secure with 1.285 +the latest updates and fixes. The SliTaz project, 1.286 +although tiny, provides regular updates on security and generally 1.287 +offers the latest versions of software. Note that this 1.288 +function is aimed at people with SliTaz installed on a 1.289 +hard drive. Updated packages in LiveCD mode will be lost on 1.290 +system shutdown. To upgrade: 1.291 +</p> 1.292 +<pre> 1.293 + # tazpkg upgrade 1.294 +</pre> 1.295 +<a name="check"></a> 1.296 +<h3><font color="#6c0023">check</font></h3> 1.297 +<p> 1.298 +The 'check' command can check dependencies on installed 1.299 +packages and determine whether all the files needed for the 1.300 +repacking of packages are present: 1.301 +</p> 1.302 +<pre> 1.303 + # tazpkg check package 1.304 +</pre> 1.305 +<a name="block"></a> 1.306 +<h3><font color="#6c0023">block or unblock</font></h3> 1.307 +<p> 1.308 +The 'block' and 'unblock' commands permit you to block 1.309 +installed package versions so that they are not maintained 1.310 +by an 'upgrade'. The list of packages on hold are contained 1.311 +in the /var/lib/tazpkg/blocked-packages.list. This file can also 1.312 +be edited by hand. To block or unblock a package such as 1.313 +Grub: 1.314 +</p> 1.315 +<pre> 1.316 + # tazpkg block grub 1.317 + Or : 1.318 + # tazpkg unblock grub 1.319 +</pre> 1.320 +<a name="get"></a> 1.321 +<h3><font color="#6c0023">get</font></h3> 1.322 +<p> 1.323 +Get a package from the mirror (if it exists). The downloaded 1.324 +package is stored in the current directory. To find the path 1.325 +you can use 'pwd'. To get the Grub package: 1.326 +</p> 1.327 +<pre> 1.328 + # tazpkg get grub 1.329 +</pre> 1.330 +<a name="get-install"></a> 1.331 +<h3><font color="#6c0023">get-install</font></h3> 1.332 +<p> 1.333 +Get and install a package from a mirror on the internet. 1.334 +The 'get-install' command begins by checking whether the 1.335 +package exists on the mirror and if it has been already downloaded. 1.336 +For a list of packages on the mirror, we must 1.337 +use the 'list-mirror' command. To install the package Grub: 1.338 +</p> 1.339 +<pre> 1.340 + # tazpkg get-install grub 1.341 +</pre> 1.342 +<a name="clean-cache"></a> 1.343 +<h3><font color="#6c0023">clean-cache</font></h3> 1.344 +<p> 1.345 +Remove *.tazpkg packages downloaded to the cache. During 1.346 +installation, Tazpkg keeps a copy of packages downloaded 1.347 +from the web. This is done to save bandwidth in case of 1.348 +reinstallation, but you may want to free up space on the hard 1.349 +drive or re-download the packages: 1.350 +</p> 1.351 +<pre> 1.352 + # tazpkg clean-cache 1.353 +</pre> 1.354 +<a name="setup-mirror"></a> 1.355 +<h3><font color="#6c0023">setup-mirror</font></h3> 1.356 +<p> 1.357 +Setup the URL for the mirror. The 'setup-mirror' command 1.358 +will ask for the URL of the new mirror. You can specify 1.359 +multiple URLs separated by spaces. Note that you can also 1.360 +modify the main /var/lib/tazpkg/mirror file. The URL must 1.361 +point to the directory containing the 'packages.list' and 1.362 +packages: 1.363 +</p> 1.364 +<pre> 1.365 + # tazpkg setup-mirror 1.366 +</pre> 1.367 +<a name="reconfigure"></a> 1.368 +<h3><font color="#6c0023">reconfigure</font></h3> 1.369 +<p> 1.370 +Replays the post-install script from the package. 1.371 +Example using gcc: 1.372 +</p> 1.373 +<pre> # tazpkg reconfigure gcc 1.374 +</pre> 1.375 +<a name="depends"></a> 1.376 +<h3><font color="#6c0023">depends or rdepends</font></h3> 1.377 +<p> 1.378 +Displays a dependency tree or reverse dependency tree for a package. 1.379 +Examples using mpd: 1.380 +</p> 1.381 +<pre> # tazpkg depends mpd 1.382 + # tazpkg rdepends mpd 1.383 +</pre> 1.384 +<a name="add-undigest"></a> 1.385 +<h3><font color="#6c0023">add-undigest or setup-undigest</font></h3> 1.386 +<p> 1.387 +Set the URL of an additional unofficial mirror to test packages that 1.388 +are not yet present on the official mirrors. Note, you can also 1.389 +manually edit the file in /var/lib/tazpkg/undigest/'repository'. The URL 1.390 +must point to the directory containing the packages and 'packages.list': 1.391 +</p> 1.392 +<pre> 1.393 + # tazpkg add-undigest public-repository http://my.home.org/slitaz 1.394 + # tazpkg setup-undigest local-repository /home/slitaz/packages 1.395 +</pre> 1.396 +<a name="remove-undigest"></a> 1.397 +<h3><font color="#6c0023">remove-undigest</font></h3> 1.398 +<p> 1.399 +Removes the URL of an undigest mirror: 1.400 +</p> 1.401 +<pre> 1.402 + # tazpkg remove-undigest my-repository 1.403 +</pre> 1.404 +<a name="list-undigest"></a> 1.405 +<h3><font color="#6c0023">list-undigest</font></h3> 1.406 +<p> 1.407 +Lists additional undigest mirrors: 1.408 +</p> 1.409 +<pre> 1.410 + # tazpkg list-undigest 1.411 +</pre> 1.412 +<a name="convert"></a> 1.413 +<h3><font color="#6c0023">convert</font></h3> 1.414 +<p> 1.415 +Converts a Debian package (.deb), Redhat (.rpm), Slackware (.tgz) or 1.416 +Archlinux (.pkg.tar.gz) package into a SliTaz package (.tazpkg): 1.417 +</p> 1.418 +<pre> 1.419 + # tazpkg convert alien-package 1.420 +</pre> 1.421 +<a name="set-release"></a> 1.422 +<h3><font color="#6c0023">set-release</font></h3> 1.423 +<p> 1.424 +The 'set-release' command changes the current version and 1.425 +upgrades the packages to the latest release: 1.426 +</p> 1.427 +<pre> # tazpkg set-release cooking 1.428 +</pre> 1.429 +<a name="bugs"></a> 1.430 +<h3><font color="#6c0023">bugs</font></h3> 1.431 +<p> 1.432 +Generates a list of known bugs in the packages: 1.433 +</p> 1.434 +<pre> # tazpkg bugs 1.435 +</pre> 1.436 + 1.437 +<h2>MAINTAINER</h2> 1.438 +<p> 1.439 +Christophe Lincoln <pankso at slitaz.org> 1.440 +</p> 1.441 + 1.442 +</div> 1.443 +<!-- End content --> 1.444 +</body> 1.445 +</html> 1.446 +