tazpkg annotate doc/tazpkg.en.html @ rev 598

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