website diff en/doc/manuals/tazpkg.en.html @ rev 70
Add Tazpkg Manual to Handbook
| author | Paul Issott <paul@slitaz.org> |
|---|---|
| date | Thu Jun 19 16:09:28 2008 +0000 (2008-06-19) |
| parents | |
| children | 68af7877fc92 |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/en/doc/manuals/tazpkg.en.html Thu Jun 19 16:09:28 2008 +0000 1.3 @@ -0,0 +1,325 @@ 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-02-06 00:02: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 a possible description. Tazpkg also manages 1.54 +dependencies based on package receipts. Each receipt holds 1.55 +all the information about the package, it can also contain 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 +<h3><font color="#6c0023">xhtml-list</font></h3> 1.81 +<p> 1.82 +The 'xhtml-list' command can create a XHTML list 1.83 +of all the packages installed on the system which can be read 1.84 +with your preferred Web browser. It can be started as a simple 1.85 +user and creates a page 'installed-packages.html' in 1.86 +your current directory. Note that you can change the name of the 1.87 +generated list via the command line: 1.88 +</p> 1.89 +<pre> 1.90 + # tazpkg xhtml-list 1.91 + # tazpkg xhtml-list list-name.html 1.92 +</pre> 1.93 +<h3><font color="#6c0023">list-mirror</font></h3> 1.94 +<p> 1.95 +List packages available on the mirror. This command will 1.96 +display the 'packages.list' file recharged from the mirror. 1.97 +If this doesn't exist, you will be asked to launch 1.98 +'tazpkg recharge' as administrator (root) for a list of 1.99 +available packages . The -diff option is used to display 1.100 +the differences between the last and current list of packages: 1.101 +</p> 1.102 +<pre> 1.103 + # tazpkg list-mirror 1.104 + # tazpkg list-mirror --diff 1.105 +</pre> 1.106 +<h3><font color="#6c0023">info</font></h3> 1.107 +<p> 1.108 +Display any information available in the receipt for the 1.109 +package in question, it's version, category, maintainer, 1.110 +Web site and any dependencies (see also Tazwok for more 1.111 +information on receipts): 1.112 +</p> 1.113 +<pre> 1.114 + # tazpkg info busybox 1.115 +</pre> 1.116 +<h3><font color="#6c0023">desc</font></h3> 1.117 +<p> 1.118 +Description of the package (if it exists). This command 1.119 +displays the 'description.txt' file of each package (a simple 1.120 +text file not more than 80 characters to fit in a standard terminal): 1.121 +</p> 1.122 +<pre> 1.123 + # tazpkg desc busybox 1.124 +</pre> 1.125 +<h3><font color="#6c0023">list-files</font></h3> 1.126 +<p> 1.127 +List all files installed with a package. This command will 1.128 +simply read and display the 'files.list' of each package, this file is 1.129 +automatically generated when the package is created and is 1.130 +also used to remove files when uninstalling a package. 1.131 +To list the files installed with the package bc: 1.132 +</p> 1.133 +<pre> 1.134 + # tazpkg list-files bc 1.135 +</pre> 1.136 +<h3><font color="#6c0023">search</font></h3> 1.137 +<p> 1.138 +Search for packages by owner or name of package. This command 1.139 +will search for the term wanted in the installed packages and the 1.140 +list of available packages on the mirror. To obtain the 1.141 +latest list of installable packages on the mirror, just 1.142 +run 'tazpkg recharge' before conducting a search: 1.143 +</p> 1.144 +<pre> 1.145 + # tazpkg search gcc 1.146 +</pre> 1.147 +<h3><font color="#6c0023">search-file</font></h3> 1.148 +<p> 1.149 +The 'search-file' command allows you to search for a file 1.150 +among the files installed by the packages. This command is very 1.151 +useful to find the full path to a file and determines if 1.152 +a file is present on the system. Example: 1.153 +</p> 1.154 +<pre> 1.155 + $ tazpkg search-file libnss 1.156 +</pre> 1.157 +<h3><font color="#6c0023">install</font></h3> 1.158 +<p> 1.159 +This command allows the installation of a local package with 1.160 +the .tazpkg extension. See 'get-install' to install a 1.161 +package from the internet. Note that you can force the 1.162 +installation via the -forced, uninstall and reinstall options 1.163 +or specify the root system where you want to install the 1.164 +packages via the -root= option: 1.165 +</p> 1.166 +<pre> 1.167 + # tazpkg install package-1.0.tazpkg 1.168 + Or : 1.169 + # tazpkg install path/to/package-1.0.tazpkg --forced 1.170 + Or : 1.171 + # tazpkg install path/to/package-1.0.tazpkg --root=/mnt/rootfs 1.172 +</pre> 1.173 +<h3><font color="#6c0023">install-list</font></h3> 1.174 +<p> 1.175 +Install a set of packages listed in a file. This command 1.176 +allows you to install several packages with a single command 1.177 +and can also be enforced: 1.178 +</p> 1.179 +<pre> 1.180 + # tazpkg install-list my-packages.list 1.181 + # tazpkg install-list my-packages.list --forced 1.182 +</pre> 1.183 +<h3><font color="#6c0023">remove</font></h3> 1.184 +<p> 1.185 +Remove a package, you will be asked for confirmation (y/N). 1.186 +This command will delete all files installed with the package; 1.187 +to view the list of files, use the 'list-files' command 1.188 +followed by the name of the package. Example 1.189 +with the package bc: 1.190 +</p> 1.191 +<pre> 1.192 + # tazpkg remove bc 1.193 +</pre> 1.194 +<h3><font color="#6c0023">extract</font></h3> 1.195 +<p> 1.196 +Extract a package into a directory. If you do not specify 1.197 +the destination directory, the package will be extracted 1.198 +in the current directory using the name package-version: 1.199 +</p> 1.200 +<pre> 1.201 + # tazpkg extract package.tazpkg 1.202 + # tazpkg extract package.tazpkg target/dir 1.203 +</pre> 1.204 +<h3><font color="#6c0023">pack</font></h3> 1.205 +<p> 1.206 +The 'pack' command will create a package from a directory 1.207 +prepared in advance or from an unpacked package. It can 1.208 +also manually create a .tazpkg package (see the Tazwok documentation 1.209 +for the automatic creation of packages). To pack a package: 1.210 +</p> 1.211 +<pre> 1.212 + # tazpkg pack package-version 1.213 +</pre> 1.214 +<h3><font color="#6c0023">repack</font></h3> 1.215 +<p> 1.216 +The 'repack' command allows us to recreate a package from 1.217 +the files on a system where it was previously installed. 1.218 +To repack a package: 1.219 +</p> 1.220 +<pre> 1.221 + # tazpkg repack package 1.222 +</pre> 1.223 +<h3><font color="#6c0023">recharge</font></h3> 1.224 +<p> 1.225 +Recharge the list of available packages on the mirror. 1.226 +This command will download the most recent 'packages.list' 1.227 +of installable packages on the mirror and before starting 1.228 +will save the old list. Once the list is updated 1.229 +you can then use the 'list' and 'search' commands. To view 1.230 +the list of differences, you can use 'list-mirror -diff' and to view 1.231 +and update packages, you can 'upgrade'. To recharge the 1.232 +latest list of packages: 1.233 +</p> 1.234 +<pre> 1.235 + # tazpkg recharge 1.236 +</pre> 1.237 +<h3><font color="#6c0023">upgrade</font></h3> 1.238 +<p> 1.239 +Upgrade allows you to update all installed packages available 1.240 +on the current mirror. Upgrading packages is an important 1.241 +part of security, it helps to keep the system secure with 1.242 +the latest updates and fixes. The SliTaz project, 1.243 +although tiny, provides regular updates on security and generally 1.244 +offers the latest versions of software. Note that this 1.245 +function is aimed at people with SliTaz installed on a 1.246 +hard drive. Updated packages in LiveCD mode will be lost on 1.247 +system shutdown. To upgrade: 1.248 +</p> 1.249 +<pre> 1.250 + # tazpkg upgrade 1.251 +</pre> 1.252 +<h3><font color="#6c0023">check</font></h3> 1.253 +<p> 1.254 +The 'check' command can check dependencies on installed 1.255 +packages and whether all the files needed for the 1.256 +repacking of packages are present: 1.257 +</p> 1.258 +<pre> 1.259 + # tazpkg check package 1.260 +</pre> 1.261 +<h3><font color="#6c0023">block or unblock</font></h3> 1.262 +<p> 1.263 +The 'block' and 'unblock' commands permit you to block 1.264 +installed package versions so that they are not maintained 1.265 +by an 'upgrade'. The list of packages on hold are contained 1.266 +in the /var/lib/tazpkg/blocked-packages.list, this file can also 1.267 +be edited by hand. To block or unblock a package such as 1.268 +Grub: 1.269 +</p> 1.270 +<pre> 1.271 + # tazpkg block grub 1.272 + Or : 1.273 + # tazpkg unblock grub 1.274 +</pre> 1.275 +<h3><font color="#6c0023">get</font></h3> 1.276 +<p> 1.277 +Get a package from the mirror (if it exists). The downloaded 1.278 +package is stored in the current directory, to find the path 1.279 +you can use 'pwd'. To get the Grub package: 1.280 +</p> 1.281 +<pre> 1.282 + # tazpkg get grub 1.283 +</pre> 1.284 +<h3><font color="#6c0023">get-install</font></h3> 1.285 +<p> 1.286 +Get and install a package from a mirror on the internet. 1.287 +The 'get-install' command begins by checking whether the 1.288 +package exists on the mirror and if it has been already downloaded. 1.289 +For a list of packages on the mirror, we must 1.290 +use the 'list-mirror' command. To install the package Grub: 1.291 +</p> 1.292 +<pre> 1.293 + # tazpkg get-install grub 1.294 +</pre> 1.295 +<h3><font color="#6c0023">clean-cache</font></h3> 1.296 +<p> 1.297 +Remove tazpkg packages downloaded to the cache. During 1.298 +installation, Tazpkg keeps a copy of packages downloaded 1.299 +from the web, it's done to save bandwidth in case of 1.300 +reinstalment, but you may want to free up space on the hard 1.301 +drive or make room for packages: 1.302 +</p> 1.303 +<pre> 1.304 + # tazpkg clean-cache 1.305 +</pre> 1.306 +<h3><font color="#6c0023">setup-mirror</font></h3> 1.307 +<p> 1.308 +Setup the URL for the mirror. The 'setup-mirror' command 1.309 +will ask for the URL for the new mirror. You can specify 1.310 +multiple URLs separated by spaces, note that you can also 1.311 +modify the main /var/lib/tazpkg/mirror file. The URL must 1.312 +point to the directory containing the 'packages.list' and 1.313 +packages: 1.314 +</p> 1.315 +<pre> 1.316 + # tazpkg setup-mirror 1.317 +</pre> 1.318 + 1.319 +<h2>MAINTAINER</h2> 1.320 +<p> 1.321 +Christophe Lincoln <pankso at slitaz.org> 1.322 +</p> 1.323 + 1.324 +</div> 1.325 +<!-- End content --> 1.326 +</body> 1.327 +</html> 1.328 +