tazpkg annotate 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
rev   line source
pankso@467 1 <!DOCTYPE html>
al@811 2 <html lang="en">
pankso@302 3 <head>
pankso@467 4 <meta charset="utf-8" />
al@633 5 <title>TazPkg Manual (en)</title>
al@811 6 <meta name="viewport" content="width=device-width,initial-scale=1"/>
al@633 7 <link rel="stylesheet" type="text/css" href="../slitaz-doc.css" />
al@633 8 <script type="text/javascript" src="../slitaz-doc.js"></script>
pankso@302 9 </head>
pankso@467 10 <body>
pankso@467 11
al@811 12 <header>
al@633 13 <h1>TazPkg Manual</h1>
al@811 14 </header>
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
al@811 22 <p>TazPkg — Tiny autonomous zone package manager</p>
pankso@302 23
al@571 24
pankso@302 25 <h2>SYNTAX</h2>
al@571 26
pankso@302 27 <pre>
al@811 28 tazpkg [command] [options...]
pankso@302 29 </pre>
pankso@302 30
al@571 31
pankso@302 32 <h2>DESCRIPTION</h2>
al@571 33
al@811 34 <p>TazPkg is a lightweight package manager to install, list, download, update or
al@811 35 remove precompiled packages on a GNU/Linux system. TazPkg offers commands for
al@811 36 searching and creating packages and was created independently for the project.
al@811 37 The format of the packages using the *.tazpkg extension is a cpio archive
al@811 38 containing a filesystem compressed with gzip, a receipt and an optional
al@811 39 description. TazPkg also manages dependencies based on package receipts. Each
al@811 40 receipt contains all the information about a package and can also include pre-
al@811 41 and post-installation functions. The same receipt is used by Cookutils to
al@811 42 compile sources and generate a .tazpkg package.</p>
al@811 43
al@811 44 <p>TazPkg is entirely built from scratch using Shell script, compatible with
al@811 45 Bash; it runs under Ash — part of the Busybox project. TazPkg is distributed
al@811 46 under the free GNU license GPL V3.</p>
pankso@302 47
al@571 48
pankso@302 49 <h2>COMMANDS</h2>
al@571 50
al@571 51
al@811 52 <h3>Service commands</h3>
al@811 53
al@811 54 <ul>
al@811 55 <li><a href="#usage">usage</a>: print short usage</li>
al@811 56 <li><a href="#help">help</a>: show help on the TazPkg commands</li>
al@811 57 <li><a href="#activity">activity</a>: show TazPkg activity log</li>
al@811 58 <li><a href="#clean-cache">clean-cache</a>: clean all packages downloaded in
al@811 59 cache directory</li>
al@811 60 <li><a href="#shell">shell</a>: run interactive TazPkg shell</li>
al@811 61 </ul>
al@811 62
al@811 63
al@811 64 <h3>Working with lists</h3>
al@811 65
al@811 66 <ul>
al@811 67 <li><a href="#list">list</a>: list installed packages on the system</li>
al@811 68 <li><a href="#list-mirror">list-mirror</a>: list all available packages on
al@811 69 the mirror</li>
al@811 70 <li><a href="#list-config">list-config</a>: list the configuration
al@811 71 files</li>
al@811 72 </ul>
al@811 73
al@811 74
al@811 75 <h3>Search</h3>
al@811 76
al@811 77 <ul>
al@811 78 <li><a href="#search">search</a>: search for a package by pattern or
al@811 79 name</li>
al@811 80 <li><a href="#search-pkgname">search-pkgname</a>: search on mirror for
al@811 81 package having a particular file</li>
al@811 82 <li><a href="#search-file">search-file</a>: search for file in all installed
al@811 83 packages files</li>
al@811 84 </ul>
al@811 85
al@811 86
al@811 87 <h3>Installing and removing packages</h3>
al@811 88
al@811 89 <ul>
al@811 90 <li><a href="#get">get</a>: download a package into the current
al@811 91 directory</li>
al@811 92 <li><a href="#install">install</a>: install a local package</li>
al@811 93 <li><a href="#get-install">get-install</a>: download and install a package
al@811 94 from the mirror</li>
al@811 95 <li><a href="#install-list">install-list</a>: install all packages from a
al@811 96 list of packages</li>
al@811 97 <li><a href="#install-list">get-install-list</a>: download and install a
al@811 98 list of packages from the mirror</li>
al@811 99 <li><a href="#remove">remove</a>: remove the specified package and all
al@811 100 installed files</li>
al@811 101 <li><a href="#reconfigure">reconfigure</a>: replay post install script from
al@811 102 package</li>
al@811 103 <li><a href="#link">link</a>: link a package from another SliTaz
al@811 104 installation</li>
al@811 105 <li><a href="#set-release">set-release</a>: change release and update
al@811 106 packages</li>
al@811 107 <li><a href="#add-flavor">add-flavor</a>: install the flavor list of
al@811 108 packages</li>
al@811 109 <li><a href="#add-flavor">install-flavor</a>: install the flavor list of
al@811 110 packages and remove other ones</li>
al@811 111 </ul>
al@811 112
al@811 113
al@811 114 <h3>Working with packages</h3>
al@811 115
al@811 116 <ul>
al@811 117 <li><a href="#info">info</a>: print information about a package</li>
al@811 118 <li><a href="#desc">desc</a>: print description of a package</li>
al@811 119 <li><a href="#list-files">list-files</a>: list the files installed with a
al@811 120 package</li>
al@811 121 <li><a href="#block">block, unblock</a>: block an installed package version
al@811 122 or unblock it for upgrade</li>
al@811 123 <li><a href="#check">check</a>: verify consistency of installed
al@811 124 packages</li>
al@811 125 <li><a href="#bugs">bugs</a>: show known bugs in packages</li>
al@811 126 <li><a href="#depends">depends</a>: display dependencies tree</li>
al@811 127 <li><a href="#depends">rdepends</a>: display reverse dependencies tree</li>
al@811 128 <li><a href="#extract">extract</a>: extract a (*.tazpkg) package into a
al@811 129 directory</li>
al@811 130 <li><a href="#pack">pack</a>: pack an unpacked or prepared package tree</li>
al@811 131 <li><a href="#repack">repack</a>: create a package archive from an installed
al@811 132 package</li>
al@811 133 <li><a href="#repack-config">repack-config</a>: create a package archive
al@811 134 with configuration files</li>
al@811 135 <li><a href="#recompress">recompress</a>: rebuild a package with a better
al@811 136 compression ratio</li>
al@811 137 <li><a href="#convert">convert</a>: convert alien package to tazpkg</li>
al@811 138 <li><a href="#list-suggested">list-suggested</a>: print list of suggested
al@811 139 packages</li>
al@811 140 </ul>
al@811 141
al@811 142
al@811 143 <h3>Working with repositories</h3>
al@811 144
al@811 145 <ul>
al@811 146 <li><a href="#recharge">recharge</a>: recharge your packages database from
al@811 147 the mirror</li>
al@811 148 <li><a href="#upgrade">upgrade</a>: check packages, list and install latest
al@811 149 upgrades</li>
al@811 150 <li><a href="#setup-mirror">setup-mirror</a>: change the mirror URL
al@811 151 configuration</li>
al@811 152 <li><a href="#add-undigest">setup-undigest</a>: update an undigest
al@811 153 mirror</li>
al@811 154 <li><a href="#list-undigest">list-undigest</a>: list undigest mirrors</li>
al@811 155 <li><a href="#add-undigest">add-undigest</a>: add an undigest mirror</li>
al@811 156 <li><a href="#remove-undigest">remove-undigest</a>: remove an undigest
al@811 157 mirror</li>
al@811 158 </ul>
al@811 159
al@811 160
al@811 161
al@811 162
al@811 163 <h2>Service commands</h2>
al@811 164
al@811 165
al@811 166 <h3 id="usage">usage</h3>
al@811 167
al@811 168 <p>Show the full list of the TazPkg commands with a brief description.</p>
al@811 169
al@811 170 <pre>
al@811 171 $ tazpkg usage
al@811 172 $ tazpkg
al@811 173 </pre>
al@811 174
al@811 175
al@811 176 <h3 id="help">help</h3>
al@811 177
al@811 178 <p>Display help for the selected command (<tt>help</tt> or <tt>-h</tt>). You can
al@811 179 enter a short name of the command, the full name or a part of the full name. You
al@811 180 can ignore hyphens at the beginning of the short name. If the requested part of
al@811 181 the full name match the several commands, you will be asked to clarify the
al@811 182 request.</p>
al@811 183
al@811 184 <pre>
al@811 185 $ tazpkg help <em>-gi</em>
al@811 186 $ tazpkg -h <em>us</em>
al@811 187 </pre>
al@811 188
al@811 189
al@811 190 <h3 id="activity">activity</h3>
al@811 191
al@811 192 <p>Display TazPkg activity log (<tt>activity</tt> or <tt>log</tt> or
al@811 193 <tt>-a</tt>). Optional parameter <tt>--nb=</tt> lets you set number of displayed
al@811 194 lines.</p>
al@811 195
al@811 196 <pre>
al@811 197 $ tazpkg activity
al@811 198 $ tazpkg -a --nb=<em>20</em>
al@811 199 </pre>
al@811 200
al@811 201
al@811 202 <h3 id="clean-cache">clean-cache</h3>
al@811 203
al@811 204 <p>Remove *.tazpkg packages downloaded to the cache (<tt>clean-cache</tt> or
al@811 205 <tt>-cc</tt>). During installation, TazPkg keeps a copy of packages downloaded
al@811 206 from the Web. This is done to save bandwidth in case of reinstallation, but you
al@811 207 may want to free up space on the hard drive or re-download the packages.</p>
al@811 208
al@811 209 <pre>
al@811 210 # tazpkg clean-cache
al@811 211 # tazpkg -cc
al@811 212 </pre>
al@811 213
al@811 214
al@811 215 <h3 id="shell">shell</h3>
al@811 216
al@811 217 <p>Run interactive TazPkg shell. Here you can enter all the TazPkg commands
al@811 218 listed above.</p>
al@811 219
al@811 220 <pre>
al@811 221 $ tazpkg shell
al@811 222 # tazpkg shell
al@811 223 </pre>
al@811 224
al@811 225
al@811 226
al@811 227
al@811 228 <h2>Working with lists</h2>
al@811 229
al@811 230
al@571 231 <h3 id="list">list</h3>
al@571 232
al@811 233 <p>List packages installed on the system (<tt>list</tt> or <tt>-l</tt>). This
al@811 234 command displays a column list of all installed packages. It also allows you to
al@811 235 list the categories (<tt>c</tt> or <tt>cat</tt> or <tt>categories</tt>),
al@811 236 packages based on category and packages placed on hold (<tt>b</tt> or
al@811 237 <tt>blocked</tt>). You can also use the <tt><a href="#search">search</a></tt>
al@811 238 command for a list based on a term or package name.</p>
al@811 239
pankso@302 240 <pre>
al@811 241 $ tazpkg list
al@811 242 $ tazpkg list cat
al@811 243 $ tazpkg list <em>games</em>
al@811 244 $ tazpkg list blocked
pankso@302 245 </pre>
pankso@467 246
al@571 247
al@571 248 <h3 id="list-mirror">list-mirror</h3>
al@571 249
al@811 250 <p>List packages available on the mirror (<tt>list-mirror</tt> or <tt>-lm</tt>).
al@811 251 This command will display the packages list recharged from the mirror. If it
al@811 252 doesn't exist, you will be asked to launch <code>tazpkg
al@811 253 <a href="#recharge">recharge</a></code> as administrator (root) for a list of
al@811 254 available packages. The <tt>--diff</tt> option is used to display the
al@811 255 differences between the last and current list of packages.</p>
al@811 256
pankso@302 257 <pre>
al@811 258 $ tazpkg list-mirror
al@811 259 $ tazpkg -lm --diff
pankso@302 260 </pre>
pankso@467 261
al@571 262
al@571 263 <h3 id="list-config">list-config</h3>
al@571 264
al@811 265 <p>Lists the system configuration files. The <tt>--box</tt> option displays in
al@811 266 table form. You can specify package name to display configuration files only for
al@811 267 this package.</p>
al@811 268
al@633 269 <pre>
al@811 270 $ tazpkg list-config
al@811 271 $ tazpkg list-config --box
al@811 272 $ tazpkg list-config <em>slim</em>
al@811 273 $ tazpkg list-config --box <em>slim</em>
pankso@302 274 </pre>
pankso@467 275
al@571 276
al@571 277
al@811 278
al@811 279 <h2>Search</h2>
pankso@467 280
al@571 281
al@571 282 <h3 id="search">search</h3>
al@571 283
al@811 284 <p>Search for packages by owner or package name (<tt>search</tt> or
al@811 285 <tt>-s</tt>). This command will search for the term wanted in the installed
al@811 286 packages (<tt>-i</tt> or <tt>--installed</tt>) and the list of available
al@811 287 packages on the mirror (<tt>-l</tt> or <tt>--list</tt>).</p>
al@811 288
al@811 289 <p>To obtain the latest list of installable packages on the mirror, just run
al@811 290 <code>tazpkg recharge</code> before conducting a search.</p>
al@811 291
pankso@302 292 <pre>
al@811 293 $ tazpkg search <em>gcc</em>
al@811 294 $ tazpkg search <em>mt</em> -i
al@811 295 $ tazpkg search <em>bit</em> -l
al@811 296 </pre>
al@811 297
al@811 298
al@811 299 <h3 id="search-pkgname">search-pkgname</h3>
al@811 300
al@811 301 <p>Search for a file on mirror and output only the packages names
al@811 302 (<tt>search-pkgname</tt> or <tt>-sp</tt>).</p>
al@811 303
al@811 304 <pre>
al@811 305 $ tazpkg search-pkgname <em>libnss</em>
al@811 306 $ tazpkg -sp <em>/usr/share/fonts</em>
pankso@302 307 </pre>
pankso@467 308
al@571 309
al@571 310 <h3 id="search-file">search-file</h3>
al@571 311
al@811 312 <p>Search for a file among the files installed by the packages
al@811 313 (<tt>search-file</tt> or <tt>-sf</tt>). This command is very useful to find the
al@811 314 full path to a file and determine if a file is present on the system. Option
al@811 315 <tt>--mirror</tt> allows to search for a file among all the files available on
al@811 316 the mirror.</p>
al@811 317
pankso@302 318 <pre>
al@633 319 $ tazpkg search-file <em>libnss</em>
al@811 320 $ tazpkg -sf <em>/usr/share/fonts</em> --mirror
al@811 321 </pre>
al@811 322
al@811 323
al@811 324
al@811 325
al@811 326 <h2>Installing and removing packages</h2>
al@811 327
al@811 328
al@811 329 <h3 id="get">get</h3>
al@811 330
al@811 331 <p>Get a package from the mirror (<tt>get</tt> or <tt>-g</tt>). The downloaded
al@811 332 package is stored in the current directory. To find the path you can use
al@811 333 <code>pwd</code>.</p>
al@811 334
al@811 335 <pre>
al@811 336 # tazpkg get <em>grub</em>
al@811 337 # tazpkg get <em>nano</em> --root=<em>/mnt/sda6</em>
pankso@302 338 </pre>
pankso@467 339
al@571 340
al@571 341 <h3 id="install">install</h3>
al@571 342
al@811 343 <p>This command allows the installation of a local package with the
al@811 344 <tt>.tazpkg</tt> extension (<tt>install</tt> or <tt>-i</tt>). See
al@811 345 <tt><a href="#get-install">get-install</a></tt> to install a package from the
al@811 346 internet. Note that you can force the installation via the <tt>--forced</tt>
al@811 347 option, specify the root system where you want to install the packages via the
al@811 348 <tt>--root=</tt> option.</p>
al@811 349
pankso@302 350 <pre>
al@571 351 # tazpkg install <em>package-1.0.tazpkg</em>
al@811 352 # tazpkg -i <em>path/to/package-1.0.tazpkg</em> --forced
al@811 353 # tazpkg -i <em>path/to/package-1.0.tazpkg</em> --root=<em>/mnt/rootfs</em>
pankso@302 354 </pre>
pankso@467 355
al@571 356
al@811 357 <h3 id="get-install">get-install</h3>
al@811 358
al@811 359 <p>Get and install a package from a mirror on the internet (<tt>get-install</tt>
al@811 360 or <tt>-gi</tt>). Command begins by checking whether the package exists on the
al@811 361 mirror and if it has been already downloaded. For a list of packages on the
al@811 362 mirror, we must use the <tt><a href="#list-mirror">list-mirror</a></tt>
al@811 363 command.</p>
al@811 364
al@811 365 <p>Following options are recognized by command:</p>
al@811 366
al@811 367 <p><tt>--forced</tt> allow update already installed package.</p>
al@811 368
al@811 369 <p><tt>--root=</tt> allow specify root of filesystem where package will be
al@811 370 installed.</p>
al@811 371
al@811 372 <pre>
al@811 373 # tazpkg get-install <em>grub</em>
al@811 374 # tazpkg -gi <em>grub</em> --forced
al@811 375 # tazpkg -gi <em>nano</em> --root=<em>/mnt/sda6</em>
al@811 376 </pre>
al@811 377
al@811 378
al@811 379 <h3 id="install-list">install-list, get-install-list</h3>
al@811 380
al@811 381 <p>Install a set of packages listed in a file. This command allows you to
al@811 382 (download and) install several packages with a single command and can also be
al@811 383 forced.</p>
al@811 384
al@633 385 <pre>
al@633 386 # tazpkg install-list <em>my-packages.list</em>
al@571 387 # tazpkg get-install-list <em>my-packages.list</em> --forced
pankso@302 388 </pre>
pankso@467 389
al@571 390
al@811 391 <h3 id="remove">remove</h3>
al@811 392
al@811 393 <p>Remove a package (<tt>remove</tt> or <tt>-r</tt>). You will be asked for
al@811 394 confirmation (y/N) of removing the package, as well as for removing packages
al@811 395 depending on this package, and for reinstalling packages modified by this
al@811 396 package. This command will delete all files installed with the package.</p>
al@811 397
al@811 398 <p>Option <tt>--root=</tt> allows to specify root of the FS where package will
al@811 399 be removed. Option <tt>--auto</tt> removes and reinstall packages without your
al@811 400 confirmation.</p>
al@811 401
al@811 402 <pre>
al@811 403 # tazpkg remove <em>bc</em>
al@811 404 # tazpkg -r <em>gtk+-3</em> --root=<em>/mnt/sda6</em>
al@811 405 # tazpkg -r <em>nano</em> --auto
al@811 406 </pre>
al@811 407
al@811 408
al@811 409 <h3 id="reconfigure">reconfigure</h3>
al@811 410
al@811 411 <p>Replays the post-install script from the package.</p>
al@811 412
al@811 413 <pre>
al@811 414 # tazpkg reconfigure <em>gcc</em>
al@811 415 # tazpkg reconfigure <em>gcc</em> --root=<em>/mnt/sda6</em>
al@811 416 </pre>
al@811 417
al@811 418
al@571 419 <h3 id="link">link</h3>
al@571 420
al@811 421 <p>This command allows the installation of a package from another media device.
al@811 422 The set up is done through symbolic links and consumes very little memory. It is
al@811 423 generally used within the system RAM to install add-ons from an USB key.</p>
al@811 424
pankso@302 425 <pre>
al@571 426 # tazpkg link <em>openoffice /media/usbdisk</em>
pankso@302 427 </pre>
pankso@467 428
al@571 429
al@811 430 <h3 id="set-release">set-release</h3>
al@571 431
al@811 432 <p>The <tt>set-release</tt> command changes the current version and upgrades all
al@811 433 of the packages to the latest release.</p>
al@811 434
pankso@302 435 <pre>
al@811 436 # tazpkg set-release <em>cooking</em>
pankso@302 437 </pre>
pankso@467 438
al@571 439
al@811 440 <h3 id="add-flavor">add-flavor, install-flavor</h3>
al@571 441
al@811 442 <p>Install a set of packages from a flavor. In addition, <tt>install-flavor</tt>
al@811 443 purges other installed packages.</p>
al@811 444
pankso@302 445 <pre>
al@811 446 # tazpkg add-flavor <em>gtkonly</em>
al@811 447 # tazpkg install-flavor <em>justx</em>
pankso@302 448 </pre>
pankso@467 449
al@571 450
al@571 451
al@811 452
al@811 453 <h2>Working with packages</h2>
al@811 454
al@811 455
al@811 456 <h3 id="info">info</h3>
al@811 457
al@811 458 <p>Display any information available in the receipt for the package in
al@811 459 question — its version, category, maintainer, Web site and any dependencies (see
al@811 460 also Cookutils for more information on receipts).</p>
al@811 461
pankso@302 462 <pre>
al@811 463 $ tazpkg info <em>busybox</em>
pankso@302 464 </pre>
pankso@467 465
al@571 466
al@811 467 <h3 id="desc">desc</h3>
al@571 468
al@811 469 <p>Description of the package (if it exists) (<tt>desc</tt> or <tt>-d</tt>).
al@811 470 This command displays the <tt>description.txt</tt> file of each package (a
al@811 471 simple text file, justified to 80 characters to fit in a standard terminal).</p>
al@811 472
pankso@302 473 <pre>
al@811 474 $ tazpkg desc <em>busybox</em>
pankso@302 475 </pre>
pankso@467 476
al@571 477
al@811 478 <h3 id="list-files">list-files</h3>
al@571 479
al@811 480 <p>List all files installed with a package (<tt>list-files</tt> or
al@811 481 <tt>-lf</tt>). This command will simply read and display the <tt>files.list</tt>
al@811 482 of each package which is automatically generated when the package is created and
al@811 483 is also used to remove files when uninstalling a package.</p>
al@811 484
pankso@467 485 <pre>
al@811 486 $ tazpkg list-files <em>bc</em>
pankso@302 487 </pre>
pankso@467 488
al@571 489
al@811 490 <h3 id="block">block, unblock, chblock</h3>
al@571 491
al@811 492 <p>The <tt>block</tt> (or <tt>-b</tt>) and <tt>unblock</tt> (or <tt>-u</tt>)
al@811 493 commands permit you to block installed package versions so that they are not
al@811 494 maintained by an <tt><a href="#upgrade">upgrade</a></tt>. Command
al@811 495 <tt>chblock</tt> changes blocking state of the package. The list of packages on
al@811 496 hold are contained in the <tt>/var/lib/tazpkg/blocked-packages.list</tt>. This
al@811 497 file can also be edited by hand.</p>
al@811 498
pankso@302 499 <pre>
al@811 500 # tazpkg block <em>grub</em>
al@811 501 # tazpkg unblock <em>grub</em>
al@811 502 # tazpkg chblock <em>grub</em>
pankso@302 503 </pre>
pankso@467 504
al@571 505
al@571 506 <h3 id="check">check</h3>
al@571 507
al@811 508 <p>The <tt>check</tt> command can check dependencies on installed packages and
al@811 509 determine whether all the files needed for the repacking of packages are
al@811 510 present.</p>
al@811 511
pankso@302 512 <pre>
al@811 513 $ tazpkg check
al@811 514 $ tazpkg check --full
al@811 515 $ tazpkg check <em>nano</em>
al@811 516 $ tazpkg check <em>sakura</em> --full
pankso@302 517 </pre>
pankso@467 518
al@571 519
al@811 520 <h3 id="bugs">bugs</h3>
al@571 521
al@811 522 <p>Generates a list of known bugs in the packages. You can specify a single
al@811 523 package to show bugs.</p>
al@811 524
pankso@302 525 <pre>
al@811 526 $ tazpkg bugs
al@811 527 $ tazpkg bugs <em>my_package</em>
pankso@302 528 </pre>
pankso@467 529
al@571 530
al@811 531 <h3 id="depends">depends, rdepends</h3>
al@571 532
al@811 533 <p>Displays a dependency tree or reverse dependency tree for a package.</p>
pankso@467 534
pankso@467 535 <pre>
al@571 536 # tazpkg depends <em>mpd</em>
al@571 537 # tazpkg rdepends <em>mpd</em>
pankso@302 538 </pre>
al@571 539
al@571 540
al@811 541 <h3 id="extract">extract</h3>
al@571 542
al@811 543 <p>Extract a package into a directory (<tt>extract</tt> or <tt>-e</tt>). If you
al@811 544 do not specify the destination directory, the package will be extracted in the
al@811 545 current directory using the name <tt><em>package-version</em></tt>.</p>
al@811 546
al@811 547 <pre>
al@811 548 $ tazpkg extract <em>package.tazpkg</em>
al@811 549 $ tazpkg extract <em>package.tazpkg target/dir</em>
al@811 550 </pre>
al@811 551
al@811 552
al@811 553 <h3 id="pack">pack</h3>
al@811 554
al@811 555 <p>The <tt>pack</tt> command will create a package from a directory prepared in
al@811 556 advance or from an unpacked package. It can also manually create a .tazpkg
al@811 557 package (see the Cookutils documentation for the automatic creation of
al@811 558 packages).</p>
al@811 559
al@811 560 <pre>
al@811 561 # tazpkg pack <em>package-version</em>
al@811 562 </pre>
al@811 563
al@811 564
al@811 565 <h3 id="repack">repack</h3>
al@811 566
al@811 567 <p>The <tt>repack</tt> command allows you to recreate a package from the files
al@811 568 on a system where it was previously installed.</p>
al@811 569
al@811 570 <pre>
al@811 571 $ tazpkg repack <em>package</em>
al@811 572 </pre>
al@811 573
al@811 574
al@811 575 <h3 id="repack-config">repack-config</h3>
al@811 576
al@811 577 <p>The <tt>repack-config</tt> command recreates a package of the system
al@811 578 configuration files (see <tt><a href="#list-config">list-config</a></tt>). It is
al@811 579 enough to install the package to find the current configuration.</p>
al@811 580
al@811 581 <pre>
al@811 582 # tazpkg repack-config
al@811 583 </pre>
al@811 584
al@811 585
al@811 586 <h3 id="recompress">recompress</h3>
al@811 587
al@811 588 <p>Recompress .tazpkg cpio archive with lzma.</p>
al@811 589
al@811 590 <pre>
al@811 591 $ tazpkg recompress <em>package.tazpkg</em>
al@811 592 </pre>
al@811 593
al@811 594
al@811 595 <h3 id="convert">convert</h3>
al@811 596
al@811 597 <p>Converts an "alien" package into a SliTaz package (.tazpkg) (<tt>convert</tt>
al@811 598 or <tt>-c</tt>.</p>
al@811 599
al@811 600 <p>Supported packages formats:</p>
al@811 601
al@811 602 <ul>
al@811 603 <li><a href="https://packages.debian.org/search" target="_blank">Debian
al@811 604 packages</a> (<tt>*.deb</tt>, <tt>*.udeb</tt>)</li>
al@811 605 <li><a href="http://rpmfind.net/linux/rpm2html/search.php"
al@811 606 target="_blank">RPM packages</a> (<tt>*.rpm</tt>)</li>
al@811 607 <li><a href="http://www.slax.org/" target="_blank">Slax packages</a>
al@811 608 (<tt>*.sb</tt>)</li>
al@811 609 <li><a href="http://puppylinux.org/" target="_blank">Puppy packages</a>
al@811 610 (<tt>*.sfs</tt>, <tt>*.pet</tt>)</li>
al@811 611 <li><a href="http://www.slackware.com/packages/" target="_blank">Slackware
al@811 612 packages</a> (<tt>*.tgz</tt>)</li>
al@811 613 <li><a href="http://www.nutyx.org/" target="_blank">NuTyX packages</a>
al@811 614 (<tt>*.cards.tar.xz</tt>)</li>
al@811 615 <li><a href="https://www.archlinux.org/packages/" target="_blank">Arch
al@811 616 Linux</a> / <a href="http://pkgs.alpinelinux.org/packages"
al@811 617 target="_blank">Alpine Linux packages</a> (<tt>*.apk</tt>,
al@811 618 <tt>*.pkg.tar.gz</tt>, <tt>*.pkg.tar.xz</tt>)</li>
al@811 619 <li><a href="http://wiki.openwrt.org/doc/packages" target="_blank">OpenWrt
al@811 620 packages</a> (<tt>*.ipk</tt>, <tt>*.opk</tt>)</li>
al@811 621 <li><a href="http://0.tuxfamily.org/doku.php/paquets/start"
al@811 622 target="_blank">0Linux packages</a> (<tt>*.spack</tt>)</li>
al@811 623 <li><a href="http://www.paldo.org/index-section-packages.html"
al@811 624 target="_blank">paldo packages</a> (<tt>*.tar.bz2</tt>)</li>
al@811 625 <li><a href="http://www.voidlinux.eu/packages/" target="_blank">Void
al@811 626 packages</a> (<tt>*.xbps</tt>)</li>
al@811 627 <li><a href="http://tinycorelinux.net/" target="_blank">Tinycore
al@811 628 packages</a> (<tt>*.tce</tt>, <tt>*.tcel</tt>, <tt>*.tcem</tt>,
al@811 629 <tt>*.tcz</tt>)</li>
al@811 630 </ul>
al@811 631
al@811 632 <pre>
al@811 633 # tazpkg convert <em>alien-package-file</em>
al@811 634 </pre>
al@811 635
al@811 636
al@811 637 <h3 id="list-suggested">list-suggested</h3>
al@811 638
al@811 639 <p>List suggested packages for each of your installed packages. With option
al@811 640 <tt>--all</tt> it shows all suggested packages, and without option it shows only
al@811 641 not installed suggested packages.</p>
al@811 642
al@811 643 <pre>
al@811 644 $ tazpkg list-suggested
al@811 645 $ tazpkg list-suggested --all
al@811 646 </pre>
al@811 647
al@811 648
al@811 649
al@811 650
al@811 651 <h2>Working with repositories</h2>
al@811 652
al@811 653
al@811 654 <h3 id="recharge">recharge</h3>
al@811 655
al@811 656 <p>Recharge the list of available packages on the mirror. This command will
al@811 657 download the most recent packages database of installable packages on the mirror
al@811 658 and before starting will save the old database. Once the DB is updated, you can
al@811 659 then use the <tt><a href="#list">list</a></tt> and
al@811 660 <tt><a href="#search">search</a></tt> commands. To view and list the
al@811 661 differences, you can use <code>list-mirror --diff</code>; and to view and update
al@811 662 packages, you can simply <tt><a href="#upgrade">upgrade</a></tt>.</p>
al@811 663
al@811 664 <p>Command without options will recharge databases of all your repositories. You
al@811 665 can specify repository to be recharged: "main" for main repo, or undigest
al@811 666 repository name. Option <tt>--root=</tt> allow you to specify root of filesystem
al@811 667 where you want to recharge DB.</p>
al@811 668
al@811 669 <pre>
al@811 670 # tazpkg recharge
al@811 671 # tazpkg recharge main
al@811 672 # tazpkg recharge <em>My_Undigest</em>
al@811 673 # tazpkg recharge --root=<em>/mnt/sda6</em>
al@811 674 </pre>
al@811 675
al@811 676
al@811 677 <h3 id="upgrade">upgrade</h3>
al@811 678
al@811 679 <p>Upgrade allows you to update all installed packages available on the current
al@811 680 mirror (<tt>upgrade</tt> or <tt>up</tt>). Upgrading packages is an important
al@811 681 part of system security, it helps to keep you secure with the latest updates and
al@811 682 fixes. The SliTaz project, although tiny, provides regular updates on security
al@811 683 and generally offers the latest versions of software. Note that this function is
al@811 684 aimed at people with SliTaz installed on a hard drive. Updated packages in
al@811 685 Live CD mode will be lost on system shutdown.</p>
al@811 686
al@811 687 <p>Without options run in interactive mode and ask before install. You can
al@811 688 specify one or more of the next options:</p>
al@811 689
al@811 690 <p><tt>-c</tt> or <tt>--check</tt> to check only for available upgrades;</p>
al@811 691
al@811 692 <p><tt>-r</tt> or <tt>--recharge</tt> to force recharge of packages list and
al@811 693 check;</p>
al@811 694
al@811 695 <p><tt>-i</tt> or <tt>--install</tt> to check for upgrades and install them
al@811 696 all.</p>
al@811 697
al@811 698 <pre>
al@811 699 # tazpkg upgrade
al@811 700 # tazpkg up --recharge --install
al@811 701 # tazpkg up -r -i
al@811 702 </pre>
al@811 703
al@811 704
al@811 705 <h3 id="setup-mirror">setup-mirror</h3>
al@811 706
al@811 707 <p>Setup the URL for the mirror. The <tt>setup-mirror</tt> (or <tt>-sm</tt>)
al@811 708 command will ask for the URL of the new mirror. Note that you can also modify
al@811 709 the main <tt>/var/lib/tazpkg/mirror</tt> file. The URL must point to the
al@811 710 directory containing the <tt>packages.info</tt> and packages.</p>
al@811 711
al@811 712 <pre>
al@811 713 # tazpkg setup-mirror
al@811 714 </pre>
al@811 715
al@811 716
al@811 717 <h3 id="add-undigest">add-undigest, setup-undigest</h3>
al@811 718
al@811 719 <p>Set the URL of an additional unofficial mirror to test packages that are not
al@811 720 yet present on the official mirrors. Note, you can also manually edit the file
al@811 721 in <tt>/var/lib/tazpkg/undigest/<em>repository</em></tt>. The URL must point to
al@811 722 the directory containing the packages and <tt>packages.info</tt>.</p>
al@811 723
pankso@302 724 <pre>
al@571 725 # tazpkg add-undigest <em>public-repository http://my.home.org/slitaz</em>
al@571 726 # tazpkg setup-undigest <em>local-repository /home/slitaz/packages</em>
pankso@302 727 </pre>
pankso@467 728
al@571 729
al@811 730 <h3 id="list-undigest">list-undigest</h3>
al@811 731
al@811 732 <p>Lists additional undigest mirrors. Option <tt>--box</tt> will output list in
al@811 733 the table form.</p>
al@811 734
al@811 735 <pre>
al@811 736 # tazpkg list-undigest
al@811 737 # tazpkg list-undigest --box
al@811 738 </pre>
al@811 739
al@811 740
al@571 741 <h3 id="remove-undigest">remove-undigest</h3>
al@571 742
al@811 743 <p>Removes the URL of an undigest mirror. You will be asked for
al@811 744 confirmation.</p>
al@811 745
pankso@302 746 <pre>
al@571 747 # tazpkg remove-undigest <em>my-repository</em>
pankso@302 748 </pre>
pankso@467 749
al@571 750
al@571 751
pankso@302 752
pankso@302 753 <h2>MAINTAINER</h2>
al@811 754
al@811 755 <p>Christophe Lincoln &lt;pankso at slitaz.org&gt;</p>
pankso@302 756
pankso@302 757 </div>
pankso@302 758 <!-- End content -->
pankso@302 759 </body>
pankso@302 760 </html>