tazpkg diff doc/tazpkg.en.html @ rev 811
Update documentation (attempt to describe all the commands both with all options). Strongly need to review and update translations and docs! Add TazPkg help system for commandline (based on the HTML docs). Attempt to drop all package lists but "packages.info". Small improvements and code prettify.
| author | Aleksej Bobylev <al.bobylev@gmail.com> |
|---|---|
| date | Thu Jun 04 00:15:13 2015 +0300 (2015-06-04) |
| parents | 5317ffe7bfbb |
| children | 2f3580bd8c0c |
line diff
1.1 --- a/doc/tazpkg.en.html Thu Jul 25 01:47:48 2013 +0300 1.2 +++ b/doc/tazpkg.en.html Thu Jun 04 00:15:13 2015 +0300 1.3 @@ -1,17 +1,17 @@ 1.4 <!DOCTYPE html> 1.5 -<html xmlns="http://www.w3.org/1999/xhtml" lang="en"> 1.6 +<html lang="en"> 1.7 <head> 1.8 <meta charset="utf-8" /> 1.9 <title>TazPkg Manual (en)</title> 1.10 + <meta name="viewport" content="width=device-width,initial-scale=1"/> 1.11 <link rel="stylesheet" type="text/css" href="../slitaz-doc.css" /> 1.12 <script type="text/javascript" src="../slitaz-doc.js"></script> 1.13 </head> 1.14 <body> 1.15 1.16 -<!-- Header --> 1.17 -<div id="header"> 1.18 +<header> 1.19 <h1>TazPkg Manual</h1> 1.20 -</div> 1.21 +</header> 1.22 1.23 <!-- Start content --> 1.24 <div id="content"> 1.25 @@ -19,499 +19,742 @@ 1.26 1.27 <h2>NAME</h2> 1.28 1.29 -<p> 1.30 - TazPkg - Tiny autonomous zone package manager 1.31 -</p> 1.32 +<p>TazPkg — Tiny autonomous zone package manager</p> 1.33 1.34 1.35 <h2>SYNTAX</h2> 1.36 1.37 <pre> 1.38 -tazpkg [command] [package|dir|pattern|list|cat|--opt] [dir|--opt] 1.39 +tazpkg [command] [options...] 1.40 </pre> 1.41 1.42 1.43 <h2>DESCRIPTION</h2> 1.44 1.45 -<p> 1.46 -TazPkg is an ultralightweight (~ 80KB) package manager to 1.47 -install, list, download, update or remove precompiled packages 1.48 -on a GNU/Linux system. TazPkg offers commands for searching 1.49 -and creating packages and was created independently for the project. 1.50 -The format of the packages using the *.tazpkg extension is a 1.51 -cpio archive containing a filesystem compressed with gzip, 1.52 -a receipt and an optional description. TazPkg also manages 1.53 -dependencies based on package receipts. Each receipt contains 1.54 -all the information about a package and can also include 1.55 -pre and post installation functions. The same receipt is 1.56 -used by Cookutils to compile sources and generate a .tazpkg 1.57 -package. 1.58 -</p> 1.59 -<p> 1.60 -TazPkg is entirely built from scratch using SHell script, 1.61 -compatible with Bash; it runs under Ash - part of the Busybox 1.62 -project. TazPkg is distributed under the free GNU license GPL V3. 1.63 -</p> 1.64 +<p>TazPkg is a lightweight package manager to install, list, download, update or 1.65 +remove precompiled packages on a GNU/Linux system. TazPkg offers commands for 1.66 +searching and creating packages and was created independently for the project. 1.67 +The format of the packages using the *.tazpkg extension is a cpio archive 1.68 +containing a filesystem compressed with gzip, a receipt and an optional 1.69 +description. TazPkg also manages dependencies based on package receipts. Each 1.70 +receipt contains all the information about a package and can also include pre- 1.71 +and post-installation functions. The same receipt is used by Cookutils to 1.72 +compile sources and generate a .tazpkg package.</p> 1.73 + 1.74 +<p>TazPkg is entirely built from scratch using Shell script, compatible with 1.75 +Bash; it runs under Ash — part of the Busybox project. TazPkg is distributed 1.76 +under the free GNU license GPL V3.</p> 1.77 1.78 1.79 <h2>COMMANDS</h2> 1.80 1.81 1.82 +<h3>Service commands</h3> 1.83 + 1.84 +<ul> 1.85 + <li><a href="#usage">usage</a>: print short usage</li> 1.86 + <li><a href="#help">help</a>: show help on the TazPkg commands</li> 1.87 + <li><a href="#activity">activity</a>: show TazPkg activity log</li> 1.88 + <li><a href="#clean-cache">clean-cache</a>: clean all packages downloaded in 1.89 + cache directory</li> 1.90 + <li><a href="#shell">shell</a>: run interactive TazPkg shell</li> 1.91 +</ul> 1.92 + 1.93 + 1.94 +<h3>Working with lists</h3> 1.95 + 1.96 +<ul> 1.97 + <li><a href="#list">list</a>: list installed packages on the system</li> 1.98 + <li><a href="#list-mirror">list-mirror</a>: list all available packages on 1.99 + the mirror</li> 1.100 + <li><a href="#list-config">list-config</a>: list the configuration 1.101 + files</li> 1.102 +</ul> 1.103 + 1.104 + 1.105 +<h3>Search</h3> 1.106 + 1.107 +<ul> 1.108 + <li><a href="#search">search</a>: search for a package by pattern or 1.109 + name</li> 1.110 + <li><a href="#search-pkgname">search-pkgname</a>: search on mirror for 1.111 + package having a particular file</li> 1.112 + <li><a href="#search-file">search-file</a>: search for file in all installed 1.113 + packages files</li> 1.114 +</ul> 1.115 + 1.116 + 1.117 +<h3>Installing and removing packages</h3> 1.118 + 1.119 +<ul> 1.120 + <li><a href="#get">get</a>: download a package into the current 1.121 + directory</li> 1.122 + <li><a href="#install">install</a>: install a local package</li> 1.123 + <li><a href="#get-install">get-install</a>: download and install a package 1.124 + from the mirror</li> 1.125 + <li><a href="#install-list">install-list</a>: install all packages from a 1.126 + list of packages</li> 1.127 + <li><a href="#install-list">get-install-list</a>: download and install a 1.128 + list of packages from the mirror</li> 1.129 + <li><a href="#remove">remove</a>: remove the specified package and all 1.130 + installed files</li> 1.131 + <li><a href="#reconfigure">reconfigure</a>: replay post install script from 1.132 + package</li> 1.133 + <li><a href="#link">link</a>: link a package from another SliTaz 1.134 + installation</li> 1.135 + <li><a href="#set-release">set-release</a>: change release and update 1.136 + packages</li> 1.137 + <li><a href="#add-flavor">add-flavor</a>: install the flavor list of 1.138 + packages</li> 1.139 + <li><a href="#add-flavor">install-flavor</a>: install the flavor list of 1.140 + packages and remove other ones</li> 1.141 +</ul> 1.142 + 1.143 + 1.144 +<h3>Working with packages</h3> 1.145 + 1.146 +<ul> 1.147 + <li><a href="#info">info</a>: print information about a package</li> 1.148 + <li><a href="#desc">desc</a>: print description of a package</li> 1.149 + <li><a href="#list-files">list-files</a>: list the files installed with a 1.150 + package</li> 1.151 + <li><a href="#block">block, unblock</a>: block an installed package version 1.152 + or unblock it for upgrade</li> 1.153 + <li><a href="#check">check</a>: verify consistency of installed 1.154 + packages</li> 1.155 + <li><a href="#bugs">bugs</a>: show known bugs in packages</li> 1.156 + <li><a href="#depends">depends</a>: display dependencies tree</li> 1.157 + <li><a href="#depends">rdepends</a>: display reverse dependencies tree</li> 1.158 + <li><a href="#extract">extract</a>: extract a (*.tazpkg) package into a 1.159 + directory</li> 1.160 + <li><a href="#pack">pack</a>: pack an unpacked or prepared package tree</li> 1.161 + <li><a href="#repack">repack</a>: create a package archive from an installed 1.162 + package</li> 1.163 + <li><a href="#repack-config">repack-config</a>: create a package archive 1.164 + with configuration files</li> 1.165 + <li><a href="#recompress">recompress</a>: rebuild a package with a better 1.166 + compression ratio</li> 1.167 + <li><a href="#convert">convert</a>: convert alien package to tazpkg</li> 1.168 + <li><a href="#list-suggested">list-suggested</a>: print list of suggested 1.169 + packages</li> 1.170 +</ul> 1.171 + 1.172 + 1.173 +<h3>Working with repositories</h3> 1.174 + 1.175 +<ul> 1.176 + <li><a href="#recharge">recharge</a>: recharge your packages database from 1.177 + the mirror</li> 1.178 + <li><a href="#upgrade">upgrade</a>: check packages, list and install latest 1.179 + upgrades</li> 1.180 + <li><a href="#setup-mirror">setup-mirror</a>: change the mirror URL 1.181 + configuration</li> 1.182 + <li><a href="#add-undigest">setup-undigest</a>: update an undigest 1.183 + mirror</li> 1.184 + <li><a href="#list-undigest">list-undigest</a>: list undigest mirrors</li> 1.185 + <li><a href="#add-undigest">add-undigest</a>: add an undigest mirror</li> 1.186 + <li><a href="#remove-undigest">remove-undigest</a>: remove an undigest 1.187 + mirror</li> 1.188 +</ul> 1.189 + 1.190 + 1.191 + 1.192 + 1.193 +<h2>Service commands</h2> 1.194 + 1.195 + 1.196 +<h3 id="usage">usage</h3> 1.197 + 1.198 +<p>Show the full list of the TazPkg commands with a brief description.</p> 1.199 + 1.200 +<pre> 1.201 +$ tazpkg usage 1.202 +$ tazpkg 1.203 +</pre> 1.204 + 1.205 + 1.206 +<h3 id="help">help</h3> 1.207 + 1.208 +<p>Display help for the selected command (<tt>help</tt> or <tt>-h</tt>). You can 1.209 +enter a short name of the command, the full name or a part of the full name. You 1.210 +can ignore hyphens at the beginning of the short name. If the requested part of 1.211 +the full name match the several commands, you will be asked to clarify the 1.212 +request.</p> 1.213 + 1.214 +<pre> 1.215 +$ tazpkg help <em>-gi</em> 1.216 +$ tazpkg -h <em>us</em> 1.217 +</pre> 1.218 + 1.219 + 1.220 +<h3 id="activity">activity</h3> 1.221 + 1.222 +<p>Display TazPkg activity log (<tt>activity</tt> or <tt>log</tt> or 1.223 +<tt>-a</tt>). Optional parameter <tt>--nb=</tt> lets you set number of displayed 1.224 +lines.</p> 1.225 + 1.226 +<pre> 1.227 +$ tazpkg activity 1.228 +$ tazpkg -a --nb=<em>20</em> 1.229 +</pre> 1.230 + 1.231 + 1.232 +<h3 id="clean-cache">clean-cache</h3> 1.233 + 1.234 +<p>Remove *.tazpkg packages downloaded to the cache (<tt>clean-cache</tt> or 1.235 +<tt>-cc</tt>). During installation, TazPkg keeps a copy of packages downloaded 1.236 +from the Web. This is done to save bandwidth in case of reinstallation, but you 1.237 +may want to free up space on the hard drive or re-download the packages.</p> 1.238 + 1.239 +<pre> 1.240 +# tazpkg clean-cache 1.241 +# tazpkg -cc 1.242 +</pre> 1.243 + 1.244 + 1.245 +<h3 id="shell">shell</h3> 1.246 + 1.247 +<p>Run interactive TazPkg shell. Here you can enter all the TazPkg commands 1.248 +listed above.</p> 1.249 + 1.250 +<pre> 1.251 +$ tazpkg shell 1.252 +# tazpkg shell 1.253 +</pre> 1.254 + 1.255 + 1.256 + 1.257 + 1.258 +<h2>Working with lists</h2> 1.259 + 1.260 + 1.261 <h3 id="list">list</h3> 1.262 1.263 -<p> 1.264 -List packages installed on the system. This command displays 1.265 -a column list of all installed packages, It also allows you to list the 1.266 -categories, packages based on category and packages placed on hold. 1.267 -You can also use the <tt><a href="#search">search</a></tt> command 1.268 -for a list based on a term or package name: 1.269 -</p> 1.270 +<p>List packages installed on the system (<tt>list</tt> or <tt>-l</tt>). This 1.271 +command displays a column list of all installed packages. It also allows you to 1.272 +list the categories (<tt>c</tt> or <tt>cat</tt> or <tt>categories</tt>), 1.273 +packages based on category and packages placed on hold (<tt>b</tt> or 1.274 +<tt>blocked</tt>). You can also use the <tt><a href="#search">search</a></tt> 1.275 +command for a list based on a term or package name.</p> 1.276 + 1.277 <pre> 1.278 -# tazpkg list 1.279 -# tazpkg list cat|<em>categories</em> 1.280 -# tazpkg list blocked 1.281 -</pre> 1.282 - 1.283 - 1.284 -<h3 id="xhtml-list">xhtml-list</h3> 1.285 - 1.286 -<p> 1.287 -The <tt>xhtml-list</tt> command can create a XHTML list 1.288 -of all the packages installed on the system which can be read 1.289 -with your preferred Web browser. It can be run as a normal 1.290 -user and creates a page <tt>installed-packages.html</tt> in 1.291 -your current directory. Note that you can change the name of the 1.292 -generated list via the command line: 1.293 -</p> 1.294 -<pre> 1.295 -# tazpkg xhtml-list 1.296 -# tazpkg xhtml-list <em>list-name.html</em> 1.297 +$ tazpkg list 1.298 +$ tazpkg list cat 1.299 +$ tazpkg list <em>games</em> 1.300 +$ tazpkg list blocked 1.301 </pre> 1.302 1.303 1.304 <h3 id="list-mirror">list-mirror</h3> 1.305 1.306 -<p> 1.307 -List packages available on the mirror. This command will 1.308 -display the <tt>packages.list</tt> file recharged from the mirror. 1.309 -If this doesn't exist, you will be asked to launch 1.310 -<code>tazpkg <a href="#recharge">recharge</a></code> as administrator (root) 1.311 -for a list of available packages . The <tt>--diff</tt> option is used to display 1.312 -the differences between the last and current list of packages: 1.313 -</p> 1.314 +<p>List packages available on the mirror (<tt>list-mirror</tt> or <tt>-lm</tt>). 1.315 +This command will display the packages list recharged from the mirror. If it 1.316 +doesn't exist, you will be asked to launch <code>tazpkg 1.317 +<a href="#recharge">recharge</a></code> as administrator (root) for a list of 1.318 +available packages. The <tt>--diff</tt> option is used to display the 1.319 +differences between the last and current list of packages.</p> 1.320 + 1.321 <pre> 1.322 -# tazpkg list-mirror 1.323 -# tazpkg list-mirror --diff 1.324 -</pre> 1.325 - 1.326 - 1.327 -<h3 id="info">info</h3> 1.328 - 1.329 -<p> 1.330 -Display any information available in the receipt for the 1.331 -package in question—its version, category, maintainer, 1.332 -Web site and any dependencies (see also Cookutils for more 1.333 -information on receipts): 1.334 -</p> 1.335 -<pre> 1.336 -# tazpkg info <em>busybox</em> 1.337 -</pre> 1.338 - 1.339 - 1.340 -<h3 id="desc">desc</h3> 1.341 - 1.342 -<p> 1.343 -Description of the package (if it exists). This command 1.344 -displays the <tt>description.txt</tt> file of each package (a simple 1.345 -text file, justified to 80 characters to fit in a standard terminal): 1.346 -</p> 1.347 -<pre> 1.348 -# tazpkg desc <em>busybox</em> 1.349 +$ tazpkg list-mirror 1.350 +$ tazpkg -lm --diff 1.351 </pre> 1.352 1.353 1.354 <h3 id="list-config">list-config</h3> 1.355 1.356 -<p> 1.357 -Lists the system configuration files. The <tt>--box</tt> option displays 1.358 -in table format: 1.359 -</p> 1.360 +<p>Lists the system configuration files. The <tt>--box</tt> option displays in 1.361 +table form. You can specify package name to display configuration files only for 1.362 +this package.</p> 1.363 + 1.364 <pre> 1.365 -# tazpkg list-config 1.366 -# tazpkg list-config --box 1.367 +$ tazpkg list-config 1.368 +$ tazpkg list-config --box 1.369 +$ tazpkg list-config <em>slim</em> 1.370 +$ tazpkg list-config --box <em>slim</em> 1.371 </pre> 1.372 1.373 1.374 -<h3 id="list-files">list-files</h3> 1.375 1.376 -<p> 1.377 -List all files installed with a package. This command will 1.378 -simply read and display the <tt>files.list</tt> of each package which is 1.379 -automatically generated when the package is created and is 1.380 -also used to remove files when uninstalling a package. 1.381 -To list the files installed with the package bc: 1.382 -</p> 1.383 -<pre> 1.384 -# tazpkg list-files <em>bc</em> 1.385 -</pre> 1.386 + 1.387 +<h2>Search</h2> 1.388 1.389 1.390 <h3 id="search">search</h3> 1.391 1.392 -<p> 1.393 -Search for packages by owner or package name. This command 1.394 -will search for the term wanted in the installed packages and the 1.395 -list of available packages on the mirror. To obtain the 1.396 -latest list of installable packages on the mirror, just 1.397 -run <code>tazpkg recharge</code> before conducting a search: 1.398 -</p> 1.399 +<p>Search for packages by owner or package name (<tt>search</tt> or 1.400 +<tt>-s</tt>). This command will search for the term wanted in the installed 1.401 +packages (<tt>-i</tt> or <tt>--installed</tt>) and the list of available 1.402 +packages on the mirror (<tt>-l</tt> or <tt>--list</tt>).</p> 1.403 + 1.404 +<p>To obtain the latest list of installable packages on the mirror, just run 1.405 +<code>tazpkg recharge</code> before conducting a search.</p> 1.406 + 1.407 <pre> 1.408 -# tazpkg search <em>gcc</em> 1.409 +$ tazpkg search <em>gcc</em> 1.410 +$ tazpkg search <em>mt</em> -i 1.411 +$ tazpkg search <em>bit</em> -l 1.412 +</pre> 1.413 + 1.414 + 1.415 +<h3 id="search-pkgname">search-pkgname</h3> 1.416 + 1.417 +<p>Search for a file on mirror and output only the packages names 1.418 +(<tt>search-pkgname</tt> or <tt>-sp</tt>).</p> 1.419 + 1.420 +<pre> 1.421 +$ tazpkg search-pkgname <em>libnss</em> 1.422 +$ tazpkg -sp <em>/usr/share/fonts</em> 1.423 </pre> 1.424 1.425 1.426 <h3 id="search-file">search-file</h3> 1.427 1.428 -<p> 1.429 -The <tt>search-file</tt> command allows you to search for a file 1.430 -among the files installed by the packages. This command is very 1.431 -useful to find the full path to a file and determine if 1.432 -a file is present on the system. Example: 1.433 -</p> 1.434 +<p>Search for a file among the files installed by the packages 1.435 +(<tt>search-file</tt> or <tt>-sf</tt>). This command is very useful to find the 1.436 +full path to a file and determine if a file is present on the system. Option 1.437 +<tt>--mirror</tt> allows to search for a file among all the files available on 1.438 +the mirror.</p> 1.439 + 1.440 <pre> 1.441 $ tazpkg search-file <em>libnss</em> 1.442 +$ tazpkg -sf <em>/usr/share/fonts</em> --mirror 1.443 +</pre> 1.444 + 1.445 + 1.446 + 1.447 + 1.448 +<h2>Installing and removing packages</h2> 1.449 + 1.450 + 1.451 +<h3 id="get">get</h3> 1.452 + 1.453 +<p>Get a package from the mirror (<tt>get</tt> or <tt>-g</tt>). The downloaded 1.454 +package is stored in the current directory. To find the path you can use 1.455 +<code>pwd</code>.</p> 1.456 + 1.457 +<pre> 1.458 +# tazpkg get <em>grub</em> 1.459 +# tazpkg get <em>nano</em> --root=<em>/mnt/sda6</em> 1.460 </pre> 1.461 1.462 1.463 <h3 id="install">install</h3> 1.464 1.465 -<p> 1.466 -This command allows the installation of a local package with 1.467 -the <tt>.tazpkg</tt> extension. See 1.468 -<tt><a href="#get-install">get-install</a></tt> to install a 1.469 -package from the internet. Note that you can force the 1.470 -installation via the <tt>--forced</tt>, <tt>uninstall</tt> and 1.471 -<tt>reinstall</tt> options 1.472 -or specify the root system where you want to install the 1.473 -packages via the <tt>--root=</tt> option: 1.474 -</p> 1.475 +<p>This command allows the installation of a local package with the 1.476 +<tt>.tazpkg</tt> extension (<tt>install</tt> or <tt>-i</tt>). See 1.477 +<tt><a href="#get-install">get-install</a></tt> to install a package from the 1.478 +internet. Note that you can force the installation via the <tt>--forced</tt> 1.479 +option, specify the root system where you want to install the packages via the 1.480 +<tt>--root=</tt> option.</p> 1.481 + 1.482 <pre> 1.483 # tazpkg install <em>package-1.0.tazpkg</em> 1.484 -# tazpkg install <em>path/to/package-1.0.tazpkg</em> --forced 1.485 -# tazpkg install <em>path/to/package-1.0.tazpkg</em> --root=<em>/mnt/rootfs</em> 1.486 +# tazpkg -i <em>path/to/package-1.0.tazpkg</em> --forced 1.487 +# tazpkg -i <em>path/to/package-1.0.tazpkg</em> --root=<em>/mnt/rootfs</em> 1.488 </pre> 1.489 1.490 1.491 -<h3 id="install-list">install-list or get-install-list</h3> 1.492 -<p> 1.493 -Install a set of packages listed in a file. This command 1.494 -allows you to (download and) install several packages with a single command 1.495 -and can also be forced: 1.496 -</p> 1.497 +<h3 id="get-install">get-install</h3> 1.498 + 1.499 +<p>Get and install a package from a mirror on the internet (<tt>get-install</tt> 1.500 +or <tt>-gi</tt>). Command begins by checking whether the package exists on the 1.501 +mirror and if it has been already downloaded. For a list of packages on the 1.502 +mirror, we must use the <tt><a href="#list-mirror">list-mirror</a></tt> 1.503 +command.</p> 1.504 + 1.505 +<p>Following options are recognized by command:</p> 1.506 + 1.507 +<p><tt>--forced</tt> allow update already installed package.</p> 1.508 + 1.509 +<p><tt>--root=</tt> allow specify root of filesystem where package will be 1.510 +installed.</p> 1.511 + 1.512 +<pre> 1.513 +# tazpkg get-install <em>grub</em> 1.514 +# tazpkg -gi <em>grub</em> --forced 1.515 +# tazpkg -gi <em>nano</em> --root=<em>/mnt/sda6</em> 1.516 +</pre> 1.517 + 1.518 + 1.519 +<h3 id="install-list">install-list, get-install-list</h3> 1.520 + 1.521 +<p>Install a set of packages listed in a file. This command allows you to 1.522 +(download and) install several packages with a single command and can also be 1.523 +forced.</p> 1.524 + 1.525 <pre> 1.526 # tazpkg install-list <em>my-packages.list</em> 1.527 # tazpkg get-install-list <em>my-packages.list</em> --forced 1.528 </pre> 1.529 1.530 1.531 +<h3 id="remove">remove</h3> 1.532 + 1.533 +<p>Remove a package (<tt>remove</tt> or <tt>-r</tt>). You will be asked for 1.534 +confirmation (y/N) of removing the package, as well as for removing packages 1.535 +depending on this package, and for reinstalling packages modified by this 1.536 +package. This command will delete all files installed with the package.</p> 1.537 + 1.538 +<p>Option <tt>--root=</tt> allows to specify root of the FS where package will 1.539 +be removed. Option <tt>--auto</tt> removes and reinstall packages without your 1.540 +confirmation.</p> 1.541 + 1.542 +<pre> 1.543 +# tazpkg remove <em>bc</em> 1.544 +# tazpkg -r <em>gtk+-3</em> --root=<em>/mnt/sda6</em> 1.545 +# tazpkg -r <em>nano</em> --auto 1.546 +</pre> 1.547 + 1.548 + 1.549 +<h3 id="reconfigure">reconfigure</h3> 1.550 + 1.551 +<p>Replays the post-install script from the package.</p> 1.552 + 1.553 +<pre> 1.554 +# tazpkg reconfigure <em>gcc</em> 1.555 +# tazpkg reconfigure <em>gcc</em> --root=<em>/mnt/sda6</em> 1.556 +</pre> 1.557 + 1.558 + 1.559 <h3 id="link">link</h3> 1.560 1.561 -<p> 1.562 -This command allows the installation of a package from another media 1.563 -device. The set up is done through symbolic links and consumes very little 1.564 -memory. It is generally used within the system RAM to install add-ons 1.565 -from an USB key: 1.566 -</p> 1.567 +<p>This command allows the installation of a package from another media device. 1.568 +The set up is done through symbolic links and consumes very little memory. It is 1.569 +generally used within the system RAM to install add-ons from an USB key.</p> 1.570 + 1.571 <pre> 1.572 # tazpkg link <em>openoffice /media/usbdisk</em> 1.573 </pre> 1.574 1.575 1.576 -<h3 id="remove">remove</h3> 1.577 +<h3 id="set-release">set-release</h3> 1.578 1.579 -<p> 1.580 -Remove a package. You will be asked for confirmation (y/N). 1.581 -This command will delete all files installed with the package. 1.582 -To view the list of files, use the <tt><a href="#list-files">list-files</a></tt> 1.583 -command followed by the name of the package. Example 1.584 -with the package bc: 1.585 -</p> 1.586 +<p>The <tt>set-release</tt> command changes the current version and upgrades all 1.587 +of the packages to the latest release.</p> 1.588 + 1.589 <pre> 1.590 -# tazpkg remove <em>bc</em> 1.591 +# tazpkg set-release <em>cooking</em> 1.592 </pre> 1.593 1.594 1.595 -<h3 id="extract">extract</h3> 1.596 +<h3 id="add-flavor">add-flavor, install-flavor</h3> 1.597 1.598 -<p> 1.599 -Extract a package into a directory. If you do not specify 1.600 -the destination directory, the package will be extracted 1.601 -in the current directory using the name <tt><em>package-version</em></tt>: 1.602 -</p> 1.603 +<p>Install a set of packages from a flavor. In addition, <tt>install-flavor</tt> 1.604 +purges other installed packages.</p> 1.605 + 1.606 <pre> 1.607 -# tazpkg extract <em>package.tazpkg</em> 1.608 -# tazpkg extract <em>package.tazpkg target/dir</em> 1.609 +# tazpkg add-flavor <em>gtkonly</em> 1.610 +# tazpkg install-flavor <em>justx</em> 1.611 </pre> 1.612 1.613 1.614 -<h3 id="pack">pack</h3> 1.615 1.616 -<p> 1.617 -The <tt>pack</tt> command will create a package from a directory 1.618 -prepared in advance or from an unpacked package. It can 1.619 -also manually create a .tazpkg package (see the Cookutils documentation 1.620 -for the automatic creation of packages). To pack a package: 1.621 -</p> 1.622 + 1.623 +<h2>Working with packages</h2> 1.624 + 1.625 + 1.626 +<h3 id="info">info</h3> 1.627 + 1.628 +<p>Display any information available in the receipt for the package in 1.629 +question — its version, category, maintainer, Web site and any dependencies (see 1.630 +also Cookutils for more information on receipts).</p> 1.631 + 1.632 <pre> 1.633 -# tazpkg pack <em>package-version</em> 1.634 +$ tazpkg info <em>busybox</em> 1.635 </pre> 1.636 1.637 1.638 -<h3 id="repack">repack</h3> 1.639 +<h3 id="desc">desc</h3> 1.640 1.641 -<p> 1.642 -The <tt>repack</tt> command allows you to recreate a package from 1.643 -the files on a system where it was previously installed. 1.644 -To repack a package: 1.645 -</p> 1.646 +<p>Description of the package (if it exists) (<tt>desc</tt> or <tt>-d</tt>). 1.647 +This command displays the <tt>description.txt</tt> file of each package (a 1.648 +simple text file, justified to 80 characters to fit in a standard terminal).</p> 1.649 + 1.650 <pre> 1.651 -# tazpkg repack <tt>package</tt> 1.652 +$ tazpkg desc <em>busybox</em> 1.653 </pre> 1.654 1.655 1.656 -<h3 id="repack-config">repack-config</h3> 1.657 +<h3 id="list-files">list-files</h3> 1.658 1.659 -<p> 1.660 -The <tt>repack-config</tt> command recreates a package 1.661 -of the system configuration files (see 1.662 -<tt><a href="#list-config">list-config</a></tt>). It is enough 1.663 -to install the package to find the current configuration. To repack 1.664 -the configuration files: 1.665 -</p> 1.666 +<p>List all files installed with a package (<tt>list-files</tt> or 1.667 +<tt>-lf</tt>). This command will simply read and display the <tt>files.list</tt> 1.668 +of each package which is automatically generated when the package is created and 1.669 +is also used to remove files when uninstalling a package.</p> 1.670 + 1.671 <pre> 1.672 -# tazpkg repack-config 1.673 +$ tazpkg list-files <em>bc</em> 1.674 </pre> 1.675 1.676 1.677 -<h3 id="recharge">recharge</h3> 1.678 +<h3 id="block">block, unblock, chblock</h3> 1.679 1.680 -<p> 1.681 -Recharge the list of available packages on the mirror. 1.682 -This command will download the most recent <tt>packages.list</tt> 1.683 -of installable packages on the mirror and before starting 1.684 -will save the old list. Once the list is updated, 1.685 -you can then use the <tt><a href="#list">list</a></tt> and 1.686 -<tt><a href="#search">search</a></tt> commands. To view 1.687 -and list the differences, you can use <code>list-mirror --diff</code>; 1.688 -and to view and update packages, you can simply 1.689 -<tt><a href="#upgrade">upgrade</a></tt>. To recharge the 1.690 -latest list of packages: 1.691 -</p> 1.692 +<p>The <tt>block</tt> (or <tt>-b</tt>) and <tt>unblock</tt> (or <tt>-u</tt>) 1.693 +commands permit you to block installed package versions so that they are not 1.694 +maintained by an <tt><a href="#upgrade">upgrade</a></tt>. Command 1.695 +<tt>chblock</tt> changes blocking state of the package. The list of packages on 1.696 +hold are contained in the <tt>/var/lib/tazpkg/blocked-packages.list</tt>. This 1.697 +file can also be edited by hand.</p> 1.698 + 1.699 <pre> 1.700 -# tazpkg recharge 1.701 -</pre> 1.702 - 1.703 - 1.704 -<h3 id="upgrade">up or upgrade</h3> 1.705 - 1.706 -<p> 1.707 -Upgrade allows you to update all installed packages available 1.708 -on the current mirror. Upgrading packages is an important 1.709 -part of system security, it helps to keep you secure with 1.710 -the latest updates and fixes. The SliTaz project, 1.711 -although tiny, provides regular updates on security and generally 1.712 -offers the latest versions of software. Note that this 1.713 -function is aimed at people with SliTaz installed on a 1.714 -hard drive. Updated packages in LiveCD mode will be lost on 1.715 -system shutdown. To upgrade or display the full <tt>up</tt> options: 1.716 -</p> 1.717 -<pre> 1.718 -# tazpkg up 1.719 -# tazpkg --help-up 1.720 -# tazpkg up --recharge --install 1.721 -# tazpkg up -r -i 1.722 +# tazpkg block <em>grub</em> 1.723 +# tazpkg unblock <em>grub</em> 1.724 +# tazpkg chblock <em>grub</em> 1.725 </pre> 1.726 1.727 1.728 <h3 id="check">check</h3> 1.729 1.730 -<p> 1.731 -The <tt>check</tt> command can check dependencies on installed 1.732 -packages and determine whether all the files needed for the 1.733 -repacking of packages are present: 1.734 -</p> 1.735 +<p>The <tt>check</tt> command can check dependencies on installed packages and 1.736 +determine whether all the files needed for the repacking of packages are 1.737 +present.</p> 1.738 + 1.739 <pre> 1.740 -# tazpkg check <em>package</em> 1.741 +$ tazpkg check 1.742 +$ tazpkg check --full 1.743 +$ tazpkg check <em>nano</em> 1.744 +$ tazpkg check <em>sakura</em> --full 1.745 </pre> 1.746 1.747 1.748 -<h3 id="block">block or unblock</h3> 1.749 +<h3 id="bugs">bugs</h3> 1.750 1.751 -<p> 1.752 -The <tt>block</tt> and <tt>unblock</tt> commands permit you to block 1.753 -installed package versions so that they are not maintained 1.754 -by an <tt><a href="#upgrade">upgrade</a></tt>. The list of packages 1.755 -on hold are contained 1.756 -in the <tt>/var/lib/tazpkg/blocked-packages.list</tt>. This file can also 1.757 -be edited by hand. To block or unblock a package such as 1.758 -Grub: 1.759 -</p> 1.760 +<p>Generates a list of known bugs in the packages. You can specify a single 1.761 +package to show bugs.</p> 1.762 + 1.763 <pre> 1.764 -# tazpkg block <em>grub</em> 1.765 -# tazpkg unblock <em>grub</em> 1.766 +$ tazpkg bugs 1.767 +$ tazpkg bugs <em>my_package</em> 1.768 </pre> 1.769 1.770 1.771 -<h3 id="get">get</h3> 1.772 +<h3 id="depends">depends, rdepends</h3> 1.773 1.774 -<p> 1.775 -Get a package from the mirror (if it exists). The downloaded 1.776 -package is stored in the current directory. To find the path 1.777 -you can use <code>pwd</code>. To get the Grub package: 1.778 -</p> 1.779 -<pre> 1.780 -# tazpkg get <em>grub</em> 1.781 -</pre> 1.782 +<p>Displays a dependency tree or reverse dependency tree for a package.</p> 1.783 1.784 - 1.785 -<h3 id="get-install">get-install</h3> 1.786 - 1.787 -<p> 1.788 -Get and install a package from a mirror on the internet. 1.789 -The <tt>get-install</tt> command begins by checking whether the 1.790 -package exists on the mirror and if it has been already downloaded. 1.791 -For a list of packages on the mirror, we must 1.792 -use the <tt><a href="#list-mirror">list-mirror</a></tt> command. 1.793 -To install the package Grub: 1.794 -</p> 1.795 -<pre> 1.796 -# tazpkg get-install <tt>grub</tt> 1.797 -</pre> 1.798 - 1.799 - 1.800 -<h3 id="clean-cache">clean-cache</h3> 1.801 - 1.802 -<p> 1.803 -Remove *.tazpkg packages downloaded to the cache. During 1.804 -installation, TazPkg keeps a copy of packages downloaded 1.805 -from the web. This is done to save bandwidth in case of 1.806 -reinstallation, but you may want to free up space on the hard 1.807 -drive or re-download the packages: 1.808 -</p> 1.809 -<pre> 1.810 -# tazpkg clean-cache 1.811 -</pre> 1.812 - 1.813 - 1.814 -<h3 id="setup-mirror">setup-mirror</h3> 1.815 - 1.816 -<p> 1.817 -Setup the URL for the mirror. The <tt>setup-mirror</tt> command 1.818 -will ask for the URL of the new mirror. You can specify 1.819 -multiple URLs separated by spaces. Note that you can also 1.820 -modify the main <tt>/var/lib/tazpkg/mirror</tt> file. The URL must 1.821 -point to the directory containing the <tt>packages.list</tt> and 1.822 -packages: 1.823 -</p> 1.824 -<pre> 1.825 -# tazpkg setup-mirror 1.826 -</pre> 1.827 - 1.828 - 1.829 -<h3 id="reconfigure">reconfigure</h3> 1.830 - 1.831 -<p> 1.832 -Replays the post-install script from the package. 1.833 -Example using gcc: 1.834 -</p> 1.835 -<pre> 1.836 -# tazpkg reconfigure <em>gcc</em> 1.837 -</pre> 1.838 - 1.839 - 1.840 -<h3 id="depends">depends or rdepends</h3> 1.841 - 1.842 -<p> 1.843 -Displays a dependency tree or reverse dependency tree for a package. 1.844 -Examples using mpd: 1.845 -</p> 1.846 <pre> 1.847 # tazpkg depends <em>mpd</em> 1.848 # tazpkg rdepends <em>mpd</em> 1.849 </pre> 1.850 1.851 1.852 -<h3 id="add-undigest">add-undigest or setup-undigest</h3> 1.853 +<h3 id="extract">extract</h3> 1.854 1.855 -<p> 1.856 -Set the URL of an additional unofficial mirror to test packages that 1.857 -are not yet present on the official mirrors. Note, you can also 1.858 -manually edit the file in <tt>/var/lib/tazpkg/undigest/<em>repository</em></tt>. 1.859 -The URL must point to the directory containing the packages and 1.860 -<tt>packages.list</tt>: 1.861 -</p> 1.862 +<p>Extract a package into a directory (<tt>extract</tt> or <tt>-e</tt>). If you 1.863 +do not specify the destination directory, the package will be extracted in the 1.864 +current directory using the name <tt><em>package-version</em></tt>.</p> 1.865 + 1.866 +<pre> 1.867 +$ tazpkg extract <em>package.tazpkg</em> 1.868 +$ tazpkg extract <em>package.tazpkg target/dir</em> 1.869 +</pre> 1.870 + 1.871 + 1.872 +<h3 id="pack">pack</h3> 1.873 + 1.874 +<p>The <tt>pack</tt> command will create a package from a directory prepared in 1.875 +advance or from an unpacked package. It can also manually create a .tazpkg 1.876 +package (see the Cookutils documentation for the automatic creation of 1.877 +packages).</p> 1.878 + 1.879 +<pre> 1.880 +# tazpkg pack <em>package-version</em> 1.881 +</pre> 1.882 + 1.883 + 1.884 +<h3 id="repack">repack</h3> 1.885 + 1.886 +<p>The <tt>repack</tt> command allows you to recreate a package from the files 1.887 +on a system where it was previously installed.</p> 1.888 + 1.889 +<pre> 1.890 +$ tazpkg repack <em>package</em> 1.891 +</pre> 1.892 + 1.893 + 1.894 +<h3 id="repack-config">repack-config</h3> 1.895 + 1.896 +<p>The <tt>repack-config</tt> command recreates a package of the system 1.897 +configuration files (see <tt><a href="#list-config">list-config</a></tt>). It is 1.898 +enough to install the package to find the current configuration.</p> 1.899 + 1.900 +<pre> 1.901 +# tazpkg repack-config 1.902 +</pre> 1.903 + 1.904 + 1.905 +<h3 id="recompress">recompress</h3> 1.906 + 1.907 +<p>Recompress .tazpkg cpio archive with lzma.</p> 1.908 + 1.909 +<pre> 1.910 +$ tazpkg recompress <em>package.tazpkg</em> 1.911 +</pre> 1.912 + 1.913 + 1.914 +<h3 id="convert">convert</h3> 1.915 + 1.916 +<p>Converts an "alien" package into a SliTaz package (.tazpkg) (<tt>convert</tt> 1.917 +or <tt>-c</tt>.</p> 1.918 + 1.919 +<p>Supported packages formats:</p> 1.920 + 1.921 +<ul> 1.922 + <li><a href="https://packages.debian.org/search" target="_blank">Debian 1.923 + packages</a> (<tt>*.deb</tt>, <tt>*.udeb</tt>)</li> 1.924 + <li><a href="http://rpmfind.net/linux/rpm2html/search.php" 1.925 + target="_blank">RPM packages</a> (<tt>*.rpm</tt>)</li> 1.926 + <li><a href="http://www.slax.org/" target="_blank">Slax packages</a> 1.927 + (<tt>*.sb</tt>)</li> 1.928 + <li><a href="http://puppylinux.org/" target="_blank">Puppy packages</a> 1.929 + (<tt>*.sfs</tt>, <tt>*.pet</tt>)</li> 1.930 + <li><a href="http://www.slackware.com/packages/" target="_blank">Slackware 1.931 + packages</a> (<tt>*.tgz</tt>)</li> 1.932 + <li><a href="http://www.nutyx.org/" target="_blank">NuTyX packages</a> 1.933 + (<tt>*.cards.tar.xz</tt>)</li> 1.934 + <li><a href="https://www.archlinux.org/packages/" target="_blank">Arch 1.935 + Linux</a> / <a href="http://pkgs.alpinelinux.org/packages" 1.936 + target="_blank">Alpine Linux packages</a> (<tt>*.apk</tt>, 1.937 + <tt>*.pkg.tar.gz</tt>, <tt>*.pkg.tar.xz</tt>)</li> 1.938 + <li><a href="http://wiki.openwrt.org/doc/packages" target="_blank">OpenWrt 1.939 + packages</a> (<tt>*.ipk</tt>, <tt>*.opk</tt>)</li> 1.940 + <li><a href="http://0.tuxfamily.org/doku.php/paquets/start" 1.941 + target="_blank">0Linux packages</a> (<tt>*.spack</tt>)</li> 1.942 + <li><a href="http://www.paldo.org/index-section-packages.html" 1.943 + target="_blank">paldo packages</a> (<tt>*.tar.bz2</tt>)</li> 1.944 + <li><a href="http://www.voidlinux.eu/packages/" target="_blank">Void 1.945 + packages</a> (<tt>*.xbps</tt>)</li> 1.946 + <li><a href="http://tinycorelinux.net/" target="_blank">Tinycore 1.947 + packages</a> (<tt>*.tce</tt>, <tt>*.tcel</tt>, <tt>*.tcem</tt>, 1.948 + <tt>*.tcz</tt>)</li> 1.949 +</ul> 1.950 + 1.951 +<pre> 1.952 +# tazpkg convert <em>alien-package-file</em> 1.953 +</pre> 1.954 + 1.955 + 1.956 +<h3 id="list-suggested">list-suggested</h3> 1.957 + 1.958 +<p>List suggested packages for each of your installed packages. With option 1.959 +<tt>--all</tt> it shows all suggested packages, and without option it shows only 1.960 +not installed suggested packages.</p> 1.961 + 1.962 +<pre> 1.963 +$ tazpkg list-suggested 1.964 +$ tazpkg list-suggested --all 1.965 +</pre> 1.966 + 1.967 + 1.968 + 1.969 + 1.970 +<h2>Working with repositories</h2> 1.971 + 1.972 + 1.973 +<h3 id="recharge">recharge</h3> 1.974 + 1.975 +<p>Recharge the list of available packages on the mirror. This command will 1.976 +download the most recent packages database of installable packages on the mirror 1.977 +and before starting will save the old database. Once the DB is updated, you can 1.978 +then use the <tt><a href="#list">list</a></tt> and 1.979 +<tt><a href="#search">search</a></tt> commands. To view and list the 1.980 +differences, you can use <code>list-mirror --diff</code>; and to view and update 1.981 +packages, you can simply <tt><a href="#upgrade">upgrade</a></tt>.</p> 1.982 + 1.983 +<p>Command without options will recharge databases of all your repositories. You 1.984 +can specify repository to be recharged: "main" for main repo, or undigest 1.985 +repository name. Option <tt>--root=</tt> allow you to specify root of filesystem 1.986 +where you want to recharge DB.</p> 1.987 + 1.988 +<pre> 1.989 +# tazpkg recharge 1.990 +# tazpkg recharge main 1.991 +# tazpkg recharge <em>My_Undigest</em> 1.992 +# tazpkg recharge --root=<em>/mnt/sda6</em> 1.993 +</pre> 1.994 + 1.995 + 1.996 +<h3 id="upgrade">upgrade</h3> 1.997 + 1.998 +<p>Upgrade allows you to update all installed packages available on the current 1.999 +mirror (<tt>upgrade</tt> or <tt>up</tt>). Upgrading packages is an important 1.1000 +part of system security, it helps to keep you secure with the latest updates and 1.1001 +fixes. The SliTaz project, although tiny, provides regular updates on security 1.1002 +and generally offers the latest versions of software. Note that this function is 1.1003 +aimed at people with SliTaz installed on a hard drive. Updated packages in 1.1004 +Live CD mode will be lost on system shutdown.</p> 1.1005 + 1.1006 +<p>Without options run in interactive mode and ask before install. You can 1.1007 +specify one or more of the next options:</p> 1.1008 + 1.1009 +<p><tt>-c</tt> or <tt>--check</tt> to check only for available upgrades;</p> 1.1010 + 1.1011 +<p><tt>-r</tt> or <tt>--recharge</tt> to force recharge of packages list and 1.1012 +check;</p> 1.1013 + 1.1014 +<p><tt>-i</tt> or <tt>--install</tt> to check for upgrades and install them 1.1015 +all.</p> 1.1016 + 1.1017 +<pre> 1.1018 +# tazpkg upgrade 1.1019 +# tazpkg up --recharge --install 1.1020 +# tazpkg up -r -i 1.1021 +</pre> 1.1022 + 1.1023 + 1.1024 +<h3 id="setup-mirror">setup-mirror</h3> 1.1025 + 1.1026 +<p>Setup the URL for the mirror. The <tt>setup-mirror</tt> (or <tt>-sm</tt>) 1.1027 +command will ask for the URL of the new mirror. Note that you can also modify 1.1028 +the main <tt>/var/lib/tazpkg/mirror</tt> file. The URL must point to the 1.1029 +directory containing the <tt>packages.info</tt> and packages.</p> 1.1030 + 1.1031 +<pre> 1.1032 +# tazpkg setup-mirror 1.1033 +</pre> 1.1034 + 1.1035 + 1.1036 +<h3 id="add-undigest">add-undigest, setup-undigest</h3> 1.1037 + 1.1038 +<p>Set the URL of an additional unofficial mirror to test packages that are not 1.1039 +yet present on the official mirrors. Note, you can also manually edit the file 1.1040 +in <tt>/var/lib/tazpkg/undigest/<em>repository</em></tt>. The URL must point to 1.1041 +the directory containing the packages and <tt>packages.info</tt>.</p> 1.1042 + 1.1043 <pre> 1.1044 # tazpkg add-undigest <em>public-repository http://my.home.org/slitaz</em> 1.1045 # tazpkg setup-undigest <em>local-repository /home/slitaz/packages</em> 1.1046 </pre> 1.1047 1.1048 1.1049 +<h3 id="list-undigest">list-undigest</h3> 1.1050 + 1.1051 +<p>Lists additional undigest mirrors. Option <tt>--box</tt> will output list in 1.1052 +the table form.</p> 1.1053 + 1.1054 +<pre> 1.1055 +# tazpkg list-undigest 1.1056 +# tazpkg list-undigest --box 1.1057 +</pre> 1.1058 + 1.1059 + 1.1060 <h3 id="remove-undigest">remove-undigest</h3> 1.1061 1.1062 -<p> 1.1063 -Removes the URL of an undigest mirror: 1.1064 -</p> 1.1065 +<p>Removes the URL of an undigest mirror. You will be asked for 1.1066 +confirmation.</p> 1.1067 + 1.1068 <pre> 1.1069 # tazpkg remove-undigest <em>my-repository</em> 1.1070 </pre> 1.1071 1.1072 1.1073 -<h3 id="list-undigest">list-undigest</h3> 1.1074 1.1075 -<p> 1.1076 -Lists additional undigest mirrors: 1.1077 -</p> 1.1078 -<pre> 1.1079 -# tazpkg list-undigest 1.1080 -</pre> 1.1081 - 1.1082 - 1.1083 -<h3 id="convert">convert</h3> 1.1084 - 1.1085 -<p> 1.1086 -Converts a Debian package (.deb), Redhat (.rpm), Slackware (.tgz) or 1.1087 -Archlinux (.pkg.tar.gz) package into a SliTaz package (.tazpkg): 1.1088 -</p> 1.1089 -<pre> 1.1090 -# tazpkg convert <em>alien-package</em> 1.1091 -</pre> 1.1092 - 1.1093 - 1.1094 -<h3 id="set-release">set-release</h3> 1.1095 -<p> 1.1096 -The <tt>set-release</tt> command changes the current version and 1.1097 -upgrades all of the packages to the latest release: 1.1098 -</p> 1.1099 -<pre> 1.1100 -# tazpkg set-release <em>cooking</em> 1.1101 -</pre> 1.1102 - 1.1103 - 1.1104 -<h3 id="bugs">bugs</h3> 1.1105 -<p> 1.1106 -Generates a list of known bugs in the packages: 1.1107 -</p> 1.1108 -<pre> 1.1109 -# tazpkg bugs 1.1110 -</pre> 1.1111 1.1112 <h2>MAINTAINER</h2> 1.1113 -<p> 1.1114 -Christophe Lincoln <pankso at slitaz.org> 1.1115 -</p> 1.1116 + 1.1117 +<p>Christophe Lincoln <pankso at slitaz.org></p> 1.1118 1.1119 </div> 1.1120 <!-- End content --> 1.1121 </body> 1.1122 </html> 1.1123 -