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

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