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

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