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

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