website annotate en/doc/manuals/tazpkg.en.html @ rev 538

en: Update tazpkg manual and add link to dev page
author Paul Issott <paul@slitaz.org>
date Wed Aug 26 20:24:46 2009 +0000 (2009-08-26)
parents a52d8135ce42
children 773e49b29b16
rev   line source
paul@70 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
paul@70 2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
paul@70 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
paul@70 4 <head>
paul@70 5 <title>Tazpkg Manual</title>
paul@70 6 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
paul@70 7 <meta name="description" content="" />
paul@70 8 <meta name="expires" content="never" />
MikeDSmith25@117 9 <meta name="modified" content="2008-07-18 19:45:00" />
paul@70 10 <style type="text/css"><!--
paul@70 11 body { font: 90% sans-serif, vernada, arial; margin: 0; }
paul@70 12 #header { background: #f0ba08; color: black; height: 50px;
paul@70 13 border-top: 1px solid black; border-bottom: 1px solid black; }
paul@70 14 #content { margin: 0px 50px 26px 50px; }
paul@70 15 h1 { margin: 14px 0px 0px 16px; }
paul@70 16 li { line-height: 1.4em; }
paul@70 17 pre { padding: 5px; color: black; background: #e1e0b0; }
paul@70 18 pre.script { padding: 10px; color: black; background: #e8e8e8;
paul@70 19 border: 1px inset #333333; }
paul@70 20 code { font-size: 100%; color: #669900; background: transparent; }
paul@70 21 hr { color: white; background: white; height: 1px; border: 0; }
paul@70 22 --></style>
paul@70 23 </head>
paul@70 24 <body bgcolor="#ffffff">
paul@70 25 <div id="header">
paul@70 26 <h1><font color="#3e1220">Tazpkg Manual</font></h1>
paul@70 27 </div>
paul@70 28 <hr />
paul@70 29 <!-- Start content -->
paul@70 30 <div id="content">
paul@70 31
paul@70 32 <h2>NAME</h2>
paul@70 33 <p>
paul@70 34 Tazpkg - Tiny autonomous zone package manager
paul@70 35 </p>
paul@70 36
paul@70 37 <h2>SYNTAX</h2>
paul@70 38 <pre>
paul@70 39 tazpkg [command] [package|dir|pattern|list|cat|--opt] [dir|--opt]
paul@70 40 </pre>
paul@70 41
paul@70 42 <h2>DESCRIPTION</h2>
paul@70 43 <p>
paul@70 44 Tazpkg is an ultralightweight (~ 35KB) package manager to
paul@70 45 install, list, download, update or remove precompiled packages
paul@70 46 on a GNU/Linux system. Tazpkg offers commands for searching
paul@70 47 and creating packages and was created independently.
paul@70 48 The format of the packages using the *.tazpkg extension is a
paul@70 49 cpio archive containing a filesystem compressed with gzip,
MikeDSmith25@117 50 a receipt and an optional description. Tazpkg also manages
paul@71 51 dependencies based on package receipts. Each receipt contains
MikeDSmith25@117 52 all the information about a package and can also include
paul@70 53 pre and post installation functions. The same receipt is
paul@70 54 used by Tazwok to compile sources and generate a .tazpkg
paul@70 55 package.
paul@70 56 </p>
paul@70 57 <p>
paul@70 58 Tazpkg is entirely built from scratch using SHell script,
paul@70 59 compatible with Bash, it runs under Ash - part of the Busybox
paul@70 60 project. Tazpkg is distributed under the free GNU license GPL V3.
paul@70 61 </p>
paul@70 62
paul@70 63 <h2>COMMANDS</h2>
paul@70 64 <h3><font color="#6c0023">list</font></h3>
paul@70 65 <p>
paul@70 66 List packages installed on the system. This command displays
paul@70 67 a column list of all installed packages, It also allows you to list the
paul@70 68 categories, packages based on category and packages placed on hold.
paul@70 69 You can also use the 'search' command for a list based
paul@70 70 on a term or package name:
paul@70 71 </p>
paul@70 72 <pre>
paul@70 73 # tazpkg list
paul@70 74 # tazpkg list cat|categories
paul@70 75 # tazpkg list blocked
paul@70 76 </pre>
paul@70 77 <h3><font color="#6c0023">xhtml-list</font></h3>
paul@70 78 <p>
paul@70 79 The 'xhtml-list' command can create a XHTML list
paul@70 80 of all the packages installed on the system which can be read
MikeDSmith25@117 81 with your preferred Web browser. It can be run as a normal
paul@126 82 user and creates a page 'installed-packages.html' in
paul@70 83 your current directory. Note that you can change the name of the
paul@70 84 generated list via the command line:
paul@70 85 </p>
paul@70 86 <pre>
paul@70 87 # tazpkg xhtml-list
paul@70 88 # tazpkg xhtml-list list-name.html
paul@70 89 </pre>
paul@70 90 <h3><font color="#6c0023">list-mirror</font></h3>
paul@70 91 <p>
paul@70 92 List packages available on the mirror. This command will
paul@70 93 display the 'packages.list' file recharged from the mirror.
paul@70 94 If this doesn't exist, you will be asked to launch
paul@70 95 'tazpkg recharge' as administrator (root) for a list of
paul@126 96 available packages . The --diff option is used to display
paul@70 97 the differences between the last and current list of packages:
paul@70 98 </p>
paul@70 99 <pre>
paul@70 100 # tazpkg list-mirror
paul@70 101 # tazpkg list-mirror --diff
paul@70 102 </pre>
paul@70 103 <h3><font color="#6c0023">info</font></h3>
paul@70 104 <p>
paul@70 105 Display any information available in the receipt for the
MikeDSmith25@117 106 package in question - its version, category, maintainer,
paul@70 107 Web site and any dependencies (see also Tazwok for more
paul@70 108 information on receipts):
paul@70 109 </p>
paul@70 110 <pre>
paul@70 111 # tazpkg info busybox
paul@70 112 </pre>
paul@70 113 <h3><font color="#6c0023">desc</font></h3>
paul@70 114 <p>
paul@70 115 Description of the package (if it exists). This command
paul@70 116 displays the 'description.txt' file of each package (a simple
paul@138 117 text file, justified to 80 characters to fit in a standard terminal):
paul@70 118 </p>
paul@70 119 <pre>
paul@70 120 # tazpkg desc busybox
paul@70 121 </pre>
paul@185 122 <h3><font color="#6c0023">list-config</font></h3>
paul@185 123 <p>
paul@185 124 Lists the system configuration files. The --box option displays
paul@185 125 in table format:
paul@185 126 </p>
paul@185 127 <pre> # tazpkg list-config
paul@185 128 # tazpkg list-config --box
paul@185 129 </pre>
paul@70 130 <h3><font color="#6c0023">list-files</font></h3>
paul@70 131 <p>
paul@70 132 List all files installed with a package. This command will
MikeDSmith25@117 133 simply read and display the 'files.list' of each package which is
paul@70 134 automatically generated when the package is created and is
paul@70 135 also used to remove files when uninstalling a package.
paul@70 136 To list the files installed with the package bc:
paul@70 137 </p>
paul@70 138 <pre>
paul@70 139 # tazpkg list-files bc
paul@70 140 </pre>
paul@70 141 <h3><font color="#6c0023">search</font></h3>
paul@70 142 <p>
MikeDSmith25@117 143 Search for packages by owner or package name. This command
paul@70 144 will search for the term wanted in the installed packages and the
paul@70 145 list of available packages on the mirror. To obtain the
paul@70 146 latest list of installable packages on the mirror, just
paul@70 147 run 'tazpkg recharge' before conducting a search:
paul@70 148 </p>
paul@70 149 <pre>
paul@70 150 # tazpkg search gcc
paul@70 151 </pre>
paul@70 152 <h3><font color="#6c0023">search-file</font></h3>
paul@70 153 <p>
paul@70 154 The 'search-file' command allows you to search for a file
paul@70 155 among the files installed by the packages. This command is very
MikeDSmith25@117 156 useful to find the full path to a file and determine if
paul@70 157 a file is present on the system. Example:
paul@70 158 </p>
paul@70 159 <pre>
paul@70 160 $ tazpkg search-file libnss
paul@70 161 </pre>
paul@70 162 <h3><font color="#6c0023">install</font></h3>
paul@70 163 <p>
paul@70 164 This command allows the installation of a local package with
paul@70 165 the .tazpkg extension. See 'get-install' to install a
paul@70 166 package from the internet. Note that you can force the
paul@138 167 installation via the --forced, uninstall and reinstall options
paul@138 168 or specify the root system where you want to install the
paul@70 169 packages via the -root= option:
paul@70 170 </p>
paul@70 171 <pre>
paul@70 172 # tazpkg install package-1.0.tazpkg
paul@70 173 Or :
paul@70 174 # tazpkg install path/to/package-1.0.tazpkg --forced
paul@70 175 Or :
paul@70 176 # tazpkg install path/to/package-1.0.tazpkg --root=/mnt/rootfs
paul@70 177 </pre>
paul@185 178 <h3><font color="#6c0023">install-list or get-install-list</font></h3>
paul@70 179 <p>
paul@70 180 Install a set of packages listed in a file. This command
paul@185 181 allows you to (download and) install several packages with a single command
MikeDSmith25@117 182 and can also be forced:
paul@70 183 </p>
paul@185 184 <pre> # tazpkg install-list my-packages.list
paul@185 185 # tazpkg get-install-list my-packages.list --forced
paul@70 186 </pre>
paul@538 187 <h3><font color="#6c0023">link</font></h3>
paul@538 188 <p>
paul@538 189 This command allows the installation of a package from another media
paul@538 190 device. The set up is done through symbolic links and consumes very little
paul@538 191 memory. It is generally used within the system RAM to install add-ons
paul@538 192 from an USB key:
paul@538 193 </p>
paul@538 194 <pre>
paul@538 195 # tazpkg link openoffice /media/usbdisk
paul@538 196 </pre>
paul@70 197 <h3><font color="#6c0023">remove</font></h3>
paul@70 198 <p>
MikeDSmith25@117 199 Remove a package. You will be asked for confirmation (y/N).
MikeDSmith25@117 200 This command will delete all files installed with the package.
MikeDSmith25@117 201 To view the list of files, use the 'list-files' command
paul@70 202 followed by the name of the package. Example
paul@70 203 with the package bc:
paul@70 204 </p>
paul@70 205 <pre>
paul@70 206 # tazpkg remove bc
paul@70 207 </pre>
paul@70 208 <h3><font color="#6c0023">extract</font></h3>
paul@70 209 <p>
paul@70 210 Extract a package into a directory. If you do not specify
paul@70 211 the destination directory, the package will be extracted
paul@70 212 in the current directory using the name package-version:
paul@70 213 </p>
paul@70 214 <pre>
paul@70 215 # tazpkg extract package.tazpkg
paul@70 216 # tazpkg extract package.tazpkg target/dir
paul@70 217 </pre>
paul@70 218 <h3><font color="#6c0023">pack</font></h3>
paul@70 219 <p>
paul@70 220 The 'pack' command will create a package from a directory
paul@70 221 prepared in advance or from an unpacked package. It can
paul@70 222 also manually create a .tazpkg package (see the Tazwok documentation
paul@70 223 for the automatic creation of packages). To pack a package:
paul@70 224 </p>
paul@70 225 <pre>
paul@70 226 # tazpkg pack package-version
paul@70 227 </pre>
paul@70 228 <h3><font color="#6c0023">repack</font></h3>
paul@70 229 <p>
paul@171 230 The 'repack' command allows you to recreate a package from
paul@70 231 the files on a system where it was previously installed.
paul@70 232 To repack a package:
paul@70 233 </p>
paul@70 234 <pre>
paul@70 235 # tazpkg repack package
paul@70 236 </pre>
paul@185 237 <h3><font color="#6c0023">repack-config</font></h3>
paul@185 238 <p>
paul@185 239 The 'repack-config' command recreates a package
paul@185 240 of the system configuration files (see list-config). It is enough
paul@185 241 to install the package to find the current configuration. To repack
paul@185 242 the configuration files:
paul@185 243 </p>
paul@185 244 <pre> # tazpkg repack-config
paul@185 245 </pre>
paul@70 246 <h3><font color="#6c0023">recharge</font></h3>
paul@70 247 <p>
paul@70 248 Recharge the list of available packages on the mirror.
paul@70 249 This command will download the most recent 'packages.list'
paul@70 250 of installable packages on the mirror and before starting
paul@70 251 will save the old list. Once the list is updated
paul@70 252 you can then use the 'list' and 'search' commands. To view
paul@164 253 and list the differences, you can use 'list-mirror --diff', and to view
paul@164 254 and update packages, you can simply 'upgrade'. To recharge the
paul@70 255 latest list of packages:
paul@70 256 </p>
paul@70 257 <pre>
paul@70 258 # tazpkg recharge
paul@70 259 </pre>
paul@70 260 <h3><font color="#6c0023">upgrade</font></h3>
paul@70 261 <p>
paul@70 262 Upgrade allows you to update all installed packages available
paul@70 263 on the current mirror. Upgrading packages is an important
paul@126 264 part of system security, it helps to keep you secure with
paul@70 265 the latest updates and fixes. The SliTaz project,
paul@70 266 although tiny, provides regular updates on security and generally
paul@70 267 offers the latest versions of software. Note that this
paul@70 268 function is aimed at people with SliTaz installed on a
paul@70 269 hard drive. Updated packages in LiveCD mode will be lost on
paul@70 270 system shutdown. To upgrade:
paul@70 271 </p>
paul@70 272 <pre>
paul@70 273 # tazpkg upgrade
paul@70 274 </pre>
paul@70 275 <h3><font color="#6c0023">check</font></h3>
paul@70 276 <p>
paul@70 277 The 'check' command can check dependencies on installed
MikeDSmith25@117 278 packages and determine whether all the files needed for the
paul@70 279 repacking of packages are present:
paul@70 280 </p>
paul@70 281 <pre>
paul@70 282 # tazpkg check package
paul@70 283 </pre>
paul@70 284 <h3><font color="#6c0023">block or unblock</font></h3>
paul@70 285 <p>
paul@70 286 The 'block' and 'unblock' commands permit you to block
paul@70 287 installed package versions so that they are not maintained
paul@70 288 by an 'upgrade'. The list of packages on hold are contained
paul@164 289 in the /var/lib/tazpkg/blocked-packages.list. This file can also
paul@70 290 be edited by hand. To block or unblock a package such as
paul@70 291 Grub:
paul@70 292 </p>
paul@70 293 <pre>
paul@70 294 # tazpkg block grub
paul@70 295 Or :
paul@70 296 # tazpkg unblock grub
paul@70 297 </pre>
paul@70 298 <h3><font color="#6c0023">get</font></h3>
paul@70 299 <p>
paul@70 300 Get a package from the mirror (if it exists). The downloaded
MikeDSmith25@117 301 package is stored in the current directory. To find the path
paul@70 302 you can use 'pwd'. To get the Grub package:
paul@70 303 </p>
paul@70 304 <pre>
paul@70 305 # tazpkg get grub
paul@70 306 </pre>
paul@70 307 <h3><font color="#6c0023">get-install</font></h3>
paul@70 308 <p>
paul@70 309 Get and install a package from a mirror on the internet.
paul@70 310 The 'get-install' command begins by checking whether the
paul@70 311 package exists on the mirror and if it has been already downloaded.
paul@70 312 For a list of packages on the mirror, we must
paul@70 313 use the 'list-mirror' command. To install the package Grub:
paul@70 314 </p>
paul@70 315 <pre>
paul@70 316 # tazpkg get-install grub
paul@70 317 </pre>
paul@70 318 <h3><font color="#6c0023">clean-cache</font></h3>
paul@70 319 <p>
paul@71 320 Remove *.tazpkg packages downloaded to the cache. During
paul@70 321 installation, Tazpkg keeps a copy of packages downloaded
MikeDSmith25@117 322 from the web. This is done to save bandwidth in case of
MikeDSmith25@117 323 reinstallation, but you may want to free up space on the hard
paul@71 324 drive or re-download the packages:
paul@70 325 </p>
paul@70 326 <pre>
paul@70 327 # tazpkg clean-cache
paul@70 328 </pre>
paul@70 329 <h3><font color="#6c0023">setup-mirror</font></h3>
paul@70 330 <p>
paul@70 331 Setup the URL for the mirror. The 'setup-mirror' command
paul@164 332 will ask for the URL of the new mirror. You can specify
MikeDSmith25@117 333 multiple URLs separated by spaces. Note that you can also
paul@70 334 modify the main /var/lib/tazpkg/mirror file. The URL must
paul@70 335 point to the directory containing the 'packages.list' and
paul@70 336 packages:
paul@70 337 </p>
paul@70 338 <pre>
paul@70 339 # tazpkg setup-mirror
paul@70 340 </pre>
paul@185 341 <h3><font color="#6c0023">reconfigure</font></h3>
paul@185 342 <p>
paul@185 343 Replays the post-install script from the package.
paul@185 344 Example using gcc:
paul@185 345 </p>
paul@185 346 <pre> # tazpkg reconfigure gcc
paul@185 347 </pre>
paul@285 348 <h3><font color="#6c0023">depends or rdepends</font></h3>
paul@285 349 <p>
paul@285 350 Displays a dependency tree or reverse dependency tree for a package.
paul@285 351 Examples using mpd:
paul@285 352 </p>
paul@285 353 <pre> # tazpkg depends mpd
paul@285 354 # tazpkg rdepends mpd
paul@285 355 </pre>
paul@538 356 <h3><font color="#6c0023">add-undigest or setup-undigest</font></h3>
paul@538 357 <p>
paul@538 358 Set the URL of an additional unofficial mirror to test packages that
paul@538 359 are not yet present on the official mirrors. Note, you can also
paul@538 360 manually edit the file in /var/lib/tazpkg/undigest/'repository'. The URL
paul@538 361 must point to the directory containing the packages and 'packages.list':
paul@538 362 </p>
paul@538 363 <pre>
paul@538 364 # tazpkg add-undigest public-repository http://my.home.org/slitaz
paul@538 365 # tazpkg setup-undigest local-repository /home/slitaz/packages
paul@538 366 </pre>
paul@538 367 <h3><font color="#6c0023">remove-undigest</font></h3>
paul@538 368 <p>
paul@538 369 Removes the URL of an undigest mirror:
paul@538 370 </p>
paul@538 371 <pre>
paul@538 372 # tazpkg remove-undigest my-repository
paul@538 373 </pre>
paul@538 374 <h3><font color="#6c0023">list-undigest</font></h3>
paul@538 375 <p>
paul@538 376 Lists additional undigest mirrors:
paul@538 377 </p>
paul@538 378 <pre>
paul@538 379 # tazpkg list-undigest
paul@538 380 </pre>
paul@538 381 <h3><font color="#6c0023">convert</font></h3>
paul@538 382 <p>
paul@538 383 Converts a Debian package (.deb), Redhat (.rpm), Slackware (.tgz) or
paul@538 384 Archlinux (.pkg.tar.gz) package into a SliTaz package (.tazpkg):
paul@538 385 </p>
paul@538 386 <pre>
paul@538 387 # tazpkg convert alien-package
paul@538 388 </pre>
paul@185 389 <h3><font color="#6c0023">set-release</font></h3>
paul@185 390 <p>
paul@185 391 The 'set-release' command changes the current version and
paul@185 392 upgrades the packages to the latest release:
paul@185 393 </p>
paul@185 394 <pre> # tazpkg set-release cooking
paul@185 395 </pre>
paul@185 396 <h3><font color="#6c0023">bugs</font></h3>
paul@185 397 <p>
paul@185 398 Generates a list of known bugs in the packages:
paul@185 399 </p>
paul@185 400 <pre> # tazpkg bugs
paul@185 401 </pre>
paul@70 402
paul@70 403 <h2>MAINTAINER</h2>
paul@70 404 <p>
paul@70 405 Christophe Lincoln &lt;pankso at slitaz.org&gt;
paul@70 406 </p>
paul@70 407
paul@70 408 </div>
paul@70 409 <!-- End content -->
paul@70 410 </body>
paul@70 411 </html>
paul@70 412