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

Add Polish translation (thanks Pawel Pyrczak); merge tazpkg, tazpkg-notify and other *pkg* translations into one; simplify plural translations using $num; normalize name (Tazpkg, TazPKG -> TazPkg); move markup outside translations; re-use categories names in tazpkg and tazpanel; other tiny improvements.
author Aleksej Bobylev <al.bobylev@gmail.com>
date Thu Jul 25 01:47:48 2013 +0300 (2013-07-25)
parents d059a3effb3a
children a73c9918a5de
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@467 4 <meta charset="utf-8" />
al@633 5 <title>TazPkg Manual (en)</title>
al@633 6 <link rel="stylesheet" type="text/css" href="../slitaz-doc.css" />
al@633 7 <script type="text/javascript" src="../slitaz-doc.js"></script>
pankso@302 8 </head>
pankso@467 9 <body>
pankso@467 10
pankso@509 11 <!-- Header -->
pankso@302 12 <div id="header">
al@633 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@633 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>
al@633 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@633 37 TazPkg is an ultralightweight (~ 80KB) package manager to
pankso@302 38 install, list, download, update or remove precompiled packages
al@633 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,
al@633 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>
al@633 51 TazPkg is entirely built from scratch using SHell script,
paul@607 52 compatible with Bash; it runs under Ash - part of the Busybox
al@633 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>
al@633 139 <pre>
al@633 140 # tazpkg list-config
pankso@467 141 # tazpkg list-config --box
pankso@302 142 </pre>
pankso@467 143
al@571 144
al@571 145 <h3 id="list-files">list-files</h3>
al@571 146
pankso@302 147 <p>
pankso@302 148 List all files installed with a package. This command will
al@571 149 simply read and display the <tt>files.list</tt> of each package which is
pankso@302 150 automatically generated when the package is created and is
pankso@302 151 also used to remove files when uninstalling a package.
pankso@302 152 To list the files installed with the package bc:
pankso@302 153 </p>
pankso@302 154 <pre>
al@571 155 # tazpkg list-files <em>bc</em>
pankso@302 156 </pre>
pankso@467 157
al@571 158
al@571 159 <h3 id="search">search</h3>
al@571 160
pankso@302 161 <p>
pankso@302 162 Search for packages by owner or package name. This command
pankso@302 163 will search for the term wanted in the installed packages and the
pankso@598 164 list of available packages on the mirror. To obtain the
pankso@302 165 latest list of installable packages on the mirror, just
al@571 166 run <code>tazpkg recharge</code> before conducting a search:
pankso@302 167 </p>
pankso@302 168 <pre>
al@571 169 # tazpkg search <em>gcc</em>
pankso@302 170 </pre>
pankso@467 171
al@571 172
al@571 173 <h3 id="search-file">search-file</h3>
al@571 174
pankso@302 175 <p>
al@571 176 The <tt>search-file</tt> command allows you to search for a file
pankso@302 177 among the files installed by the packages. This command is very
pankso@598 178 useful to find the full path to a file and determine if
pankso@302 179 a file is present on the system. Example:
pankso@302 180 </p>
pankso@302 181 <pre>
al@633 182 $ tazpkg search-file <em>libnss</em>
pankso@302 183 </pre>
pankso@467 184
al@571 185
al@571 186 <h3 id="install">install</h3>
al@571 187
pankso@302 188 <p>
pankso@302 189 This command allows the installation of a local package with
al@571 190 the <tt>.tazpkg</tt> extension. See
pankso@598 191 <tt><a href="#get-install">get-install</a></tt> to install a
pankso@302 192 package from the internet. Note that you can force the
al@571 193 installation via the <tt>--forced</tt>, <tt>uninstall</tt> and
pankso@598 194 <tt>reinstall</tt> options
pankso@302 195 or specify the root system where you want to install the
al@571 196 packages via the <tt>--root=</tt> option:
pankso@302 197 </p>
pankso@302 198 <pre>
al@571 199 # tazpkg install <em>package-1.0.tazpkg</em>
al@571 200 # tazpkg install <em>path/to/package-1.0.tazpkg</em> --forced
al@571 201 # tazpkg install <em>path/to/package-1.0.tazpkg</em> --root=<em>/mnt/rootfs</em>
pankso@302 202 </pre>
pankso@467 203
al@571 204
al@571 205 <h3 id="install-list">install-list or get-install-list</h3>
pankso@302 206 <p>
pankso@302 207 Install a set of packages listed in a file. This command
pankso@302 208 allows you to (download and) install several packages with a single command
pankso@302 209 and can also be forced:
pankso@302 210 </p>
al@633 211 <pre>
al@633 212 # tazpkg install-list <em>my-packages.list</em>
al@571 213 # tazpkg get-install-list <em>my-packages.list</em> --forced
pankso@302 214 </pre>
pankso@467 215
al@571 216
al@571 217 <h3 id="link">link</h3>
al@571 218
pankso@302 219 <p>
pankso@598 220 This command allows the installation of a package from another media
pankso@598 221 device. The set up is done through symbolic links and consumes very little
pankso@598 222 memory. It is generally used within the system RAM to install add-ons
pankso@302 223 from an USB key:
pankso@302 224 </p>
pankso@302 225 <pre>
al@571 226 # tazpkg link <em>openoffice /media/usbdisk</em>
pankso@302 227 </pre>
pankso@467 228
al@571 229
al@571 230 <h3 id="remove">remove</h3>
al@571 231
pankso@302 232 <p>
pankso@302 233 Remove a package. You will be asked for confirmation (y/N).
pankso@302 234 This command will delete all files installed with the package.
al@571 235 To view the list of files, use the <tt><a href="#list-files">list-files</a></tt>
al@571 236 command followed by the name of the package. Example
pankso@302 237 with the package bc:
pankso@302 238 </p>
pankso@302 239 <pre>
al@571 240 # tazpkg remove <em>bc</em>
pankso@302 241 </pre>
pankso@467 242
al@571 243
al@571 244 <h3 id="extract">extract</h3>
al@571 245
pankso@302 246 <p>
pankso@302 247 Extract a package into a directory. If you do not specify
pankso@302 248 the destination directory, the package will be extracted
al@571 249 in the current directory using the name <tt><em>package-version</em></tt>:
pankso@302 250 </p>
pankso@302 251 <pre>
al@571 252 # tazpkg extract <em>package.tazpkg</em>
al@571 253 # tazpkg extract <em>package.tazpkg target/dir</em>
pankso@302 254 </pre>
pankso@467 255
al@571 256
al@571 257 <h3 id="pack">pack</h3>
al@571 258
pankso@302 259 <p>
al@571 260 The <tt>pack</tt> command will create a package from a directory
pankso@598 261 prepared in advance or from an unpacked package. It can
paul@579 262 also manually create a .tazpkg package (see the Cookutils documentation
pankso@302 263 for the automatic creation of packages). To pack a package:
pankso@302 264 </p>
pankso@302 265 <pre>
al@571 266 # tazpkg pack <em>package-version</em>
pankso@302 267 </pre>
pankso@467 268
al@571 269
al@571 270 <h3 id="repack">repack</h3>
al@571 271
pankso@302 272 <p>
al@571 273 The <tt>repack</tt> command allows you to recreate a package from
pankso@302 274 the files on a system where it was previously installed.
pankso@302 275 To repack a package:
pankso@302 276 </p>
pankso@302 277 <pre>
al@571 278 # tazpkg repack <tt>package</tt>
pankso@302 279 </pre>
pankso@467 280
al@571 281
al@571 282 <h3 id="repack-config">repack-config</h3>
al@571 283
pankso@302 284 <p>
al@571 285 The <tt>repack-config</tt> command recreates a package
al@571 286 of the system configuration files (see
pankso@598 287 <tt><a href="#list-config">list-config</a></tt>). It is enough
pankso@598 288 to install the package to find the current configuration. To repack
pankso@302 289 the configuration files:
pankso@302 290 </p>
pankso@467 291 <pre>
pankso@467 292 # tazpkg repack-config
pankso@302 293 </pre>
pankso@467 294
al@571 295
al@571 296 <h3 id="recharge">recharge</h3>
al@571 297
pankso@302 298 <p>
pankso@598 299 Recharge the list of available packages on the mirror.
al@571 300 This command will download the most recent <tt>packages.list</tt>
pankso@598 301 of installable packages on the mirror and before starting
paul@373 302 will save the old list. Once the list is updated,
al@571 303 you can then use the <tt><a href="#list">list</a></tt> and
al@571 304 <tt><a href="#search">search</a></tt> commands. To view
al@571 305 and list the differences, you can use <code>list-mirror --diff</code>;
al@571 306 and to view and update packages, you can simply
al@571 307 <tt><a href="#upgrade">upgrade</a></tt>. To recharge the
pankso@302 308 latest list of packages:
pankso@302 309 </p>
pankso@302 310 <pre>
pankso@467 311 # tazpkg recharge
pankso@302 312 </pre>
pankso@467 313
al@571 314
al@571 315 <h3 id="upgrade">up or upgrade</h3>
al@571 316
pankso@302 317 <p>
pankso@302 318 Upgrade allows you to update all installed packages available
pankso@302 319 on the current mirror. Upgrading packages is an important
pankso@302 320 part of system security, it helps to keep you secure with
pankso@302 321 the latest updates and fixes. The SliTaz project,
pankso@302 322 although tiny, provides regular updates on security and generally
pankso@598 323 offers the latest versions of software. Note that this
pankso@598 324 function is aimed at people with SliTaz installed on a
pankso@302 325 hard drive. Updated packages in LiveCD mode will be lost on
al@571 326 system shutdown. To upgrade or display the full <tt>up</tt> options:
pankso@302 327 </p>
pankso@302 328 <pre>
pankso@467 329 # tazpkg up
pankso@467 330 # tazpkg --help-up
pankso@467 331 # tazpkg up --recharge --install
pankso@467 332 # tazpkg up -r -i
pankso@302 333 </pre>
pankso@467 334
al@571 335
al@571 336 <h3 id="check">check</h3>
al@571 337
pankso@302 338 <p>
al@571 339 The <tt>check</tt> command can check dependencies on installed
pankso@598 340 packages and determine whether all the files needed for the
pankso@302 341 repacking of packages are present:
pankso@302 342 </p>
pankso@302 343 <pre>
al@571 344 # tazpkg check <em>package</em>
pankso@302 345 </pre>
pankso@467 346
al@571 347
al@571 348 <h3 id="block">block or unblock</h3>
al@571 349
pankso@302 350 <p>
al@571 351 The <tt>block</tt> and <tt>unblock</tt> commands permit you to block
pankso@302 352 installed package versions so that they are not maintained
al@571 353 by an <tt><a href="#upgrade">upgrade</a></tt>. The list of packages
al@571 354 on hold are contained
al@571 355 in the <tt>/var/lib/tazpkg/blocked-packages.list</tt>. This file can also
pankso@302 356 be edited by hand. To block or unblock a package such as
pankso@302 357 Grub:
pankso@302 358 </p>
pankso@302 359 <pre>
al@571 360 # tazpkg block <em>grub</em>
al@571 361 # tazpkg unblock <em>grub</em>
pankso@302 362 </pre>
pankso@467 363
al@571 364
al@571 365 <h3 id="get">get</h3>
al@571 366
pankso@302 367 <p>
pankso@302 368 Get a package from the mirror (if it exists). The downloaded
pankso@302 369 package is stored in the current directory. To find the path
al@571 370 you can use <code>pwd</code>. To get the Grub package:
pankso@302 371 </p>
pankso@302 372 <pre>
al@571 373 # tazpkg get <em>grub</em>
pankso@302 374 </pre>
pankso@467 375
al@571 376
al@571 377 <h3 id="get-install">get-install</h3>
al@571 378
pankso@302 379 <p>
pankso@302 380 Get and install a package from a mirror on the internet.
al@571 381 The <tt>get-install</tt> command begins by checking whether the
pankso@598 382 package exists on the mirror and if it has been already downloaded.
pankso@302 383 For a list of packages on the mirror, we must
al@571 384 use the <tt><a href="#list-mirror">list-mirror</a></tt> command.
al@571 385 To install the package Grub:
pankso@302 386 </p>
pankso@302 387 <pre>
al@571 388 # tazpkg get-install <tt>grub</tt>
pankso@302 389 </pre>
pankso@467 390
al@571 391
al@571 392 <h3 id="clean-cache">clean-cache</h3>
al@571 393
pankso@302 394 <p>
pankso@598 395 Remove *.tazpkg packages downloaded to the cache. During
al@633 396 installation, TazPkg keeps a copy of packages downloaded
pankso@598 397 from the web. This is done to save bandwidth in case of
pankso@302 398 reinstallation, but you may want to free up space on the hard
pankso@302 399 drive or re-download the packages:
pankso@302 400 </p>
pankso@302 401 <pre>
pankso@467 402 # tazpkg clean-cache
pankso@302 403 </pre>
pankso@467 404
al@571 405
al@571 406 <h3 id="setup-mirror">setup-mirror</h3>
al@571 407
pankso@302 408 <p>
al@571 409 Setup the URL for the mirror. The <tt>setup-mirror</tt> command
pankso@302 410 will ask for the URL of the new mirror. You can specify
pankso@302 411 multiple URLs separated by spaces. Note that you can also
al@571 412 modify the main <tt>/var/lib/tazpkg/mirror</tt> file. The URL must
al@571 413 point to the directory containing the <tt>packages.list</tt> and
pankso@302 414 packages:
pankso@302 415 </p>
pankso@302 416 <pre>
pankso@467 417 # tazpkg setup-mirror
pankso@302 418 </pre>
pankso@467 419
al@571 420
al@571 421 <h3 id="reconfigure">reconfigure</h3>
al@571 422
pankso@302 423 <p>
pankso@302 424 Replays the post-install script from the package.
pankso@302 425 Example using gcc:
pankso@302 426 </p>
pankso@467 427 <pre>
al@571 428 # tazpkg reconfigure <em>gcc</em>
pankso@302 429 </pre>
al@571 430
al@571 431
al@571 432 <h3 id="depends">depends or rdepends</h3>
al@571 433
pankso@302 434 <p>
pankso@302 435 Displays a dependency tree or reverse dependency tree for a package.
pankso@302 436 Examples using mpd:
pankso@302 437 </p>
pankso@467 438 <pre>
al@571 439 # tazpkg depends <em>mpd</em>
al@571 440 # tazpkg rdepends <em>mpd</em>
pankso@302 441 </pre>
al@571 442
al@571 443
al@571 444 <h3 id="add-undigest">add-undigest or setup-undigest</h3>
al@571 445
pankso@302 446 <p>
pankso@302 447 Set the URL of an additional unofficial mirror to test packages that
pankso@302 448 are not yet present on the official mirrors. Note, you can also
al@571 449 manually edit the file in <tt>/var/lib/tazpkg/undigest/<em>repository</em></tt>.
al@571 450 The URL must point to the directory containing the packages and
al@571 451 <tt>packages.list</tt>:
pankso@302 452 </p>
pankso@302 453 <pre>
al@571 454 # tazpkg add-undigest <em>public-repository http://my.home.org/slitaz</em>
al@571 455 # tazpkg setup-undigest <em>local-repository /home/slitaz/packages</em>
pankso@302 456 </pre>
pankso@467 457
al@571 458
al@571 459 <h3 id="remove-undigest">remove-undigest</h3>
al@571 460
pankso@302 461 <p>
pankso@302 462 Removes the URL of an undigest mirror:
pankso@302 463 </p>
pankso@302 464 <pre>
al@571 465 # tazpkg remove-undigest <em>my-repository</em>
pankso@302 466 </pre>
pankso@467 467
al@571 468
al@571 469 <h3 id="list-undigest">list-undigest</h3>
al@571 470
pankso@302 471 <p>
pankso@302 472 Lists additional undigest mirrors:
pankso@302 473 </p>
pankso@302 474 <pre>
pankso@467 475 # tazpkg list-undigest
pankso@302 476 </pre>
pankso@467 477
al@571 478
al@571 479 <h3 id="convert">convert</h3>
al@571 480
pankso@302 481 <p>
pankso@598 482 Converts a Debian package (.deb), Redhat (.rpm), Slackware (.tgz) or
pankso@302 483 Archlinux (.pkg.tar.gz) package into a SliTaz package (.tazpkg):
pankso@302 484 </p>
pankso@302 485 <pre>
al@571 486 # tazpkg convert <em>alien-package</em>
pankso@302 487 </pre>
pankso@467 488
al@571 489
al@571 490 <h3 id="set-release">set-release</h3>
pankso@302 491 <p>
pankso@598 492 The <tt>set-release</tt> command changes the current version and
paul@373 493 upgrades all of the packages to the latest release:
pankso@302 494 </p>
pankso@467 495 <pre>
al@571 496 # tazpkg set-release <em>cooking</em>
pankso@302 497 </pre>
pankso@467 498
al@571 499
al@571 500 <h3 id="bugs">bugs</h3>
pankso@302 501 <p>
pankso@302 502 Generates a list of known bugs in the packages:
pankso@302 503 </p>
pankso@467 504 <pre>
pankso@467 505 # tazpkg bugs
pankso@302 506 </pre>
pankso@302 507
pankso@302 508 <h2>MAINTAINER</h2>
pankso@302 509 <p>
pankso@302 510 Christophe Lincoln &lt;pankso at slitaz.org&gt;
pankso@302 511 </p>
pankso@302 512
pankso@302 513 </div>
pankso@302 514 <!-- End content -->
pankso@302 515 </body>
pankso@302 516 </html>
pankso@302 517