website 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 b9186eb65961
children 68af7877fc92
files en/doc/index.html en/doc/manuals/tazpkg.en.html
line diff
     1.1 --- a/en/doc/index.html	Sun Jun 15 13:46:00 2008 +0000
     1.2 +++ b/en/doc/index.html	Thu Jun 19 16:09:28 2008 +0000
     1.3 @@ -66,18 +66,24 @@
     1.4  <a name="content"></a>
     1.5  
     1.6  <h1><font color="#3e1220">English documentation</font></h1>
     1.7 -<h2><font color="#df8f06">Books and manuals</font></h2>
     1.8 +<h2><font color="#df8f06">Handbook &amp; Cookbook</font></h2>
     1.9  
    1.10  <ul>
    1.11  	<li><a href="handbook/">Handbook</a> - SliTaz Handbook. LiveCD usage,
    1.12 -	 package management, network or system administration
    1.13 +	package management, network or system administration
    1.14  	and specific instructions.</li>
    1.15 -	<li><a href="cookbook/">Cookbook</a> - SliTaz Cookbook. Tazwok manual and 
    1.16 -	instructions on how to use the wok and package receipts.</li>
    1.17 +	<li><a href="cookbook/">Cookbook</a> - SliTaz Cookbook. Instructions on how 
    1.18 +	to use the wok and package receipts.</li>
    1.19 +	<li>Users speaking English can get support and ask for new texts on the
    1.20 +	<a href="http://forum.slitaz.org/#idx2">English forum</a>.</li>
    1.21 +</ul>
    1.22 +	
    1.23 +<h2><font color="#df8f06">Manuals</font></h2>	
    1.24 +<ul>
    1.25  	<li><a href="manuals/tazusb.en.html">TazUSB manual</a> -  SliTaz LiveUSB
    1.26  	utility.</li>
    1.27 -	<li>Users speaking English can get support and ask for new texts on the
    1.28 -	<a href="http://forum.slitaz.org/#idx2">English forum</a>.</li>
    1.29 +	<li><a href="manuals/tazpkg.en.html">Tazpkg manual</a> -  SliTaz Package manager
    1.30 +	utility.</li>
    1.31  </ul>
    1.32  
    1.33  <h2><font color="#df8f06">Release Notes</font></h2>

     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/en/doc/manuals/tazpkg.en.html	Thu Jun 19 16:09:28 2008 +0000
     2.3 @@ -0,0 +1,325 @@
     2.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     2.5 +	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     2.6 +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
     2.7 +<head>
     2.8 +	<title>Tazpkg Manual</title>
     2.9 +	<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
    2.10 +	<meta name="description" content="" />
    2.11 +	<meta name="expires" content="never" />
    2.12 +	<meta name="modified" content="2008-02-06 00:02:00" />
    2.13 +	<style type="text/css"><!--
    2.14 +	body { font: 90% sans-serif, vernada, arial; margin: 0; }
    2.15 +	#header { background: #f0ba08; color: black; height: 50px;
    2.16 +		border-top: 1px solid black; border-bottom: 1px solid black; }
    2.17 +	#content { margin: 0px 50px 26px 50px; }
    2.18 +	h1 { margin: 14px 0px 0px 16px; }
    2.19 +	li { line-height: 1.4em; }
    2.20 +	pre { padding: 5px; color: black; background: #e1e0b0; }
    2.21 +	pre.script { padding: 10px; color: black; background: #e8e8e8;
    2.22 +		border: 1px inset #333333; }
    2.23 +	code { font-size: 100%; color: #669900; background: transparent; }
    2.24 +	hr { color: white; background: white; height: 1px; border: 0; }
    2.25 +	--></style>
    2.26 +</head>
    2.27 +<body bgcolor="#ffffff">
    2.28 +<div id="header">
    2.29 +<h1><font color="#3e1220">Tazpkg Manual</font></h1>
    2.30 +</div>
    2.31 +<hr />
    2.32 +<!-- Start content -->
    2.33 +<div id="content">
    2.34 +
    2.35 +<h2>NAME</h2>
    2.36 +<p>
    2.37 +Tazpkg - Tiny autonomous zone package manager
    2.38 +</p>
    2.39 +
    2.40 +<h2>SYNTAX</h2>
    2.41 +<pre>
    2.42 + tazpkg [command] [package|dir|pattern|list|cat|--opt] [dir|--opt]
    2.43 +</pre>
    2.44 +
    2.45 +<h2>DESCRIPTION</h2>
    2.46 +<p>
    2.47 +Tazpkg is an ultralightweight (~ 35KB) package manager to
    2.48 +install, list, download, update or remove precompiled packages
    2.49 +on a GNU/Linux system. Tazpkg offers commands for searching
    2.50 +and creating packages and was created independently.
    2.51 +The format of the packages using the *.tazpkg extension is a
    2.52 +cpio archive containing a filesystem compressed with gzip,
    2.53 +a receipt and a possible description. Tazpkg also manages
    2.54 +dependencies based on package receipts. Each receipt holds
    2.55 +all the information about the package, it can also contain
    2.56 +pre and post installation functions. The same receipt is 
    2.57 +used by Tazwok to compile sources and generate a .tazpkg 
    2.58 +package.
    2.59 +</p>
    2.60 +<p>
    2.61 +Tazpkg is entirely built from scratch using SHell script, 
    2.62 +compatible with Bash, it runs under Ash - part of the Busybox 
    2.63 +project. Tazpkg is distributed under the free GNU license GPL V3. 
    2.64 +</p>
    2.65 +
    2.66 +<h2>COMMANDS</h2>
    2.67 +<h3><font color="#6c0023">list</font></h3>
    2.68 +<p>
    2.69 +List packages installed on the system. This command displays 
    2.70 +a column list of all installed packages, It also allows you to list the 
    2.71 +categories, packages based on category and packages placed on hold.
    2.72 +You can also use the 'search' command for a list based 
    2.73 +on a term or package name:
    2.74 +</p>
    2.75 +<pre>
    2.76 + # tazpkg list
    2.77 + # tazpkg list cat|categories
    2.78 + # tazpkg list blocked
    2.79 +</pre>
    2.80 +<h3><font color="#6c0023">xhtml-list</font></h3>
    2.81 +<p>
    2.82 +The 'xhtml-list' command can create a XHTML list
    2.83 +of all the packages installed on the system which can be read
    2.84 +with your preferred Web browser. It can be started as a simple
    2.85 +user and creates a page 'installed-packages.html' in
    2.86 +your current directory. Note that you can change the name of the
    2.87 +generated list via the command line:
    2.88 +</p>
    2.89 +<pre>
    2.90 + # tazpkg xhtml-list
    2.91 + # tazpkg xhtml-list list-name.html
    2.92 +</pre>
    2.93 +<h3><font color="#6c0023">list-mirror</font></h3>
    2.94 +<p>
    2.95 +List packages available on the mirror. This command will
    2.96 +display the 'packages.list' file recharged from the mirror.
    2.97 +If this doesn't exist, you will be asked to launch
    2.98 +'tazpkg recharge' as administrator (root) for a list of 
    2.99 +available packages . The -diff option is used to display
   2.100 +the differences between the last and current list of packages:
   2.101 +</p>
   2.102 +<pre>
   2.103 + # tazpkg list-mirror
   2.104 + # tazpkg list-mirror --diff
   2.105 +</pre>
   2.106 +<h3><font color="#6c0023">info</font></h3>
   2.107 +<p>
   2.108 +Display any information available in the receipt for the 
   2.109 +package in question,  it's version, category, maintainer,
   2.110 +Web site and any dependencies (see also Tazwok for more
   2.111 +information on receipts):
   2.112 +</p>
   2.113 +<pre>
   2.114 + # tazpkg info busybox
   2.115 +</pre>
   2.116 +<h3><font color="#6c0023">desc</font></h3>
   2.117 +<p>
   2.118 +Description of the package (if it exists). This command
   2.119 +displays the 'description.txt' file of each package (a simple
   2.120 +text file not more than 80 characters to fit in a standard terminal):
   2.121 +</p>
   2.122 +<pre>
   2.123 + # tazpkg desc busybox
   2.124 +</pre>
   2.125 +<h3><font color="#6c0023">list-files</font></h3>
   2.126 +<p>
   2.127 +List all files installed with a package. This command will
   2.128 +simply read and display the 'files.list' of each package, this file is
   2.129 +automatically generated when the package is created and is
   2.130 +also used to remove files when uninstalling a package.
   2.131 +To list the files installed with the package bc:
   2.132 +</p>
   2.133 +<pre>
   2.134 + # tazpkg list-files bc
   2.135 +</pre>
   2.136 +<h3><font color="#6c0023">search</font></h3>
   2.137 +<p>
   2.138 +Search for packages by owner or name of package. This command
   2.139 +will search for the term wanted in the installed packages and the
   2.140 +list of available packages on the mirror. To obtain the 
   2.141 +latest list of installable packages on the mirror, just
   2.142 +run 'tazpkg recharge' before conducting a search:
   2.143 +</p>
   2.144 +<pre>
   2.145 + # tazpkg search gcc
   2.146 +</pre>
   2.147 +<h3><font color="#6c0023">search-file</font></h3>
   2.148 +<p>
   2.149 +The 'search-file' command allows you to search for a file
   2.150 +among the files installed by the packages. This command is very
   2.151 +useful to find the full path to a file and determines if 
   2.152 +a file is present on the system. Example:
   2.153 +</p>
   2.154 +<pre>
   2.155 + $ tazpkg search-file libnss
   2.156 +</pre>
   2.157 +<h3><font color="#6c0023">install</font></h3>
   2.158 +<p>
   2.159 +This command allows the installation of a local package with
   2.160 +the .tazpkg extension. See 'get-install' to install a 
   2.161 +package from the internet. Note that you can force the
   2.162 +installation via the -forced, uninstall and reinstall options
   2.163 +or specify the root system where you want to install the
   2.164 +packages via the -root= option:
   2.165 +</p>
   2.166 +<pre>
   2.167 + # tazpkg install package-1.0.tazpkg
   2.168 + Or :
   2.169 + # tazpkg install path/to/package-1.0.tazpkg --forced
   2.170 + Or :
   2.171 + # tazpkg install path/to/package-1.0.tazpkg --root=/mnt/rootfs
   2.172 +</pre>
   2.173 +<h3><font color="#6c0023">install-list</font></h3>
   2.174 +<p>
   2.175 +Install a set of packages listed in a file. This command
   2.176 +allows you to install several packages with a single command
   2.177 +and can also be enforced:
   2.178 +</p>
   2.179 +<pre>
   2.180 + # tazpkg install-list my-packages.list
   2.181 + # tazpkg install-list my-packages.list --forced
   2.182 +</pre>
   2.183 +<h3><font color="#6c0023">remove</font></h3>
   2.184 +<p>
   2.185 +Remove a package, you will be asked for confirmation (y/N).
   2.186 +This command will delete all files installed with the package;
   2.187 +to view the list of files, use the 'list-files' command
   2.188 +followed by the name of the package. Example
   2.189 +with the package bc:
   2.190 +</p>
   2.191 +<pre>
   2.192 + # tazpkg remove bc
   2.193 +</pre>
   2.194 +<h3><font color="#6c0023">extract</font></h3>
   2.195 +<p>
   2.196 +Extract a package into a directory. If you do not specify
   2.197 +the destination directory, the package will be extracted
   2.198 +in the current directory using the name package-version:
   2.199 +</p>
   2.200 +<pre>
   2.201 + # tazpkg extract package.tazpkg
   2.202 + # tazpkg extract package.tazpkg target/dir
   2.203 +</pre>
   2.204 +<h3><font color="#6c0023">pack</font></h3>
   2.205 +<p>
   2.206 +The 'pack' command will create a package from a directory
   2.207 +prepared in advance or from an unpacked package. It can 
   2.208 +also manually create a .tazpkg package (see the Tazwok documentation
   2.209 +for the automatic creation of packages). To pack a package:
   2.210 +</p>
   2.211 +<pre>
   2.212 + # tazpkg pack package-version
   2.213 +</pre>
   2.214 +<h3><font color="#6c0023">repack</font></h3>
   2.215 +<p>
   2.216 +The 'repack' command allows us to recreate a package from
   2.217 +the files on a system where it was previously installed.
   2.218 +To repack a package:
   2.219 +</p>
   2.220 +<pre>
   2.221 + # tazpkg repack package
   2.222 +</pre>
   2.223 +<h3><font color="#6c0023">recharge</font></h3>
   2.224 +<p>
   2.225 +Recharge the list of available packages on the mirror. 
   2.226 +This command will download the most recent 'packages.list' 
   2.227 +of installable packages on the mirror and before starting 
   2.228 +will save the old list. Once the list is updated
   2.229 +you can then use the 'list' and 'search' commands. To view
   2.230 +the list of differences, you can use 'list-mirror -diff' and to view 
   2.231 +and update packages, you can 'upgrade'. To recharge the
   2.232 +latest list of packages:
   2.233 +</p>
   2.234 +<pre>
   2.235 + # tazpkg recharge
   2.236 +</pre>
   2.237 +<h3><font color="#6c0023">upgrade</font></h3>
   2.238 +<p>
   2.239 +Upgrade allows you to update all installed packages available
   2.240 +on the current mirror. Upgrading packages is an important
   2.241 +part of security, it helps to keep the system secure with
   2.242 +the latest updates and fixes. The SliTaz project,
   2.243 +although tiny, provides regular updates on security and generally
   2.244 +offers the latest versions of software. Note that this 
   2.245 +function is aimed at people with SliTaz installed on a 
   2.246 +hard drive. Updated packages in LiveCD mode will be lost on
   2.247 +system shutdown. To upgrade:
   2.248 +</p>
   2.249 +<pre>
   2.250 + # tazpkg upgrade
   2.251 +</pre>
   2.252 +<h3><font color="#6c0023">check</font></h3>
   2.253 +<p>
   2.254 +The 'check' command can check dependencies on installed
   2.255 +packages and whether all the files needed for the 
   2.256 +repacking of packages are present:
   2.257 +</p>
   2.258 +<pre>
   2.259 + # tazpkg check package
   2.260 +</pre>
   2.261 +<h3><font color="#6c0023">block or unblock</font></h3>
   2.262 +<p>
   2.263 +The 'block' and 'unblock' commands permit you to block
   2.264 +installed package versions so that they are not maintained
   2.265 +by an 'upgrade'. The list of packages on hold are contained
   2.266 +in the /var/lib/tazpkg/blocked-packages.list, this file can also
   2.267 +be edited by hand. To block or unblock a package such as
   2.268 +Grub:
   2.269 +</p>
   2.270 +<pre>
   2.271 + # tazpkg block grub
   2.272 + Or :
   2.273 + # tazpkg unblock grub
   2.274 +</pre>
   2.275 +<h3><font color="#6c0023">get</font></h3>
   2.276 +<p>
   2.277 +Get a package from the mirror (if it exists). The downloaded
   2.278 +package is stored in the current directory, to find the path
   2.279 +you can use 'pwd'. To get the Grub package:
   2.280 +</p>
   2.281 +<pre>
   2.282 + # tazpkg get grub
   2.283 +</pre>
   2.284 +<h3><font color="#6c0023">get-install</font></h3>
   2.285 +<p>
   2.286 +Get and install a package from a mirror on the internet.
   2.287 +The 'get-install' command begins by checking whether the
   2.288 +package exists on the mirror and if it has been already downloaded. 
   2.289 +For a list of packages on the mirror, we must
   2.290 +use the 'list-mirror' command. To install the package Grub:
   2.291 +</p>
   2.292 +<pre>
   2.293 + # tazpkg get-install grub
   2.294 +</pre>
   2.295 +<h3><font color="#6c0023">clean-cache</font></h3>
   2.296 +<p>
   2.297 +Remove tazpkg packages downloaded to the cache. During 
   2.298 +installation, Tazpkg keeps a copy of packages downloaded
   2.299 +from the web, it's done to save bandwidth in case of 
   2.300 +reinstalment, but you may want to free up space on the hard
   2.301 +drive or make room for packages:
   2.302 +</p>
   2.303 +<pre>
   2.304 + # tazpkg clean-cache
   2.305 +</pre>
   2.306 +<h3><font color="#6c0023">setup-mirror</font></h3>
   2.307 +<p>
   2.308 +Setup the URL for the mirror. The 'setup-mirror' command
   2.309 +will ask for the URL for the new mirror. You can specify
   2.310 +multiple URLs separated by spaces, note that you can also
   2.311 +modify the main /var/lib/tazpkg/mirror file. The URL must
   2.312 +point to the directory containing the 'packages.list' and
   2.313 +packages:
   2.314 +</p>
   2.315 +<pre>
   2.316 + # tazpkg setup-mirror
   2.317 +</pre>
   2.318 +
   2.319 +<h2>MAINTAINER</h2>
   2.320 +<p>
   2.321 +Christophe Lincoln &lt;pankso at slitaz.org&gt;
   2.322 +</p>
   2.323 +
   2.324 +</div>
   2.325 +<!-- End content -->
   2.326 +</body>
   2.327 +</html>
   2.328 +