website annotate en/doc/manuals/tazpkg.en.html @ rev 127

en: Add RSS feed + typos
author Paul Issott <paul@slitaz.org>
date Mon Jul 28 20:42:24 2008 +0000 (2008-07-28)
parents 567f75a5b1d8
children cbc3753477f5
rev   line source
paul@70 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
paul@70 2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
paul@70 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
paul@70 4 <head>
paul@70 5 <title>Tazpkg Manual</title>
paul@70 6 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
paul@70 7 <meta name="description" content="" />
paul@70 8 <meta name="expires" content="never" />
MikeDSmith25@117 9 <meta name="modified" content="2008-07-18 19:45:00" />
paul@70 10 <style type="text/css"><!--
paul@70 11 body { font: 90% sans-serif, vernada, arial; margin: 0; }
paul@70 12 #header { background: #f0ba08; color: black; height: 50px;
paul@70 13 border-top: 1px solid black; border-bottom: 1px solid black; }
paul@70 14 #content { margin: 0px 50px 26px 50px; }
paul@70 15 h1 { margin: 14px 0px 0px 16px; }
paul@70 16 li { line-height: 1.4em; }
paul@70 17 pre { padding: 5px; color: black; background: #e1e0b0; }
paul@70 18 pre.script { padding: 10px; color: black; background: #e8e8e8;
paul@70 19 border: 1px inset #333333; }
paul@70 20 code { font-size: 100%; color: #669900; background: transparent; }
paul@70 21 hr { color: white; background: white; height: 1px; border: 0; }
paul@70 22 --></style>
paul@70 23 </head>
paul@70 24 <body bgcolor="#ffffff">
paul@70 25 <div id="header">
paul@70 26 <h1><font color="#3e1220">Tazpkg Manual</font></h1>
paul@70 27 </div>
paul@70 28 <hr />
paul@70 29 <!-- Start content -->
paul@70 30 <div id="content">
paul@70 31
paul@70 32 <h2>NAME</h2>
paul@70 33 <p>
paul@70 34 Tazpkg - Tiny autonomous zone package manager
paul@70 35 </p>
paul@70 36
paul@70 37 <h2>SYNTAX</h2>
paul@70 38 <pre>
paul@70 39 tazpkg [command] [package|dir|pattern|list|cat|--opt] [dir|--opt]
paul@70 40 </pre>
paul@70 41
paul@70 42 <h2>DESCRIPTION</h2>
paul@70 43 <p>
paul@70 44 Tazpkg is an ultralightweight (~ 35KB) package manager to
paul@70 45 install, list, download, update or remove precompiled packages
paul@70 46 on a GNU/Linux system. Tazpkg offers commands for searching
paul@70 47 and creating packages and was created independently.
paul@70 48 The format of the packages using the *.tazpkg extension is a
paul@70 49 cpio archive containing a filesystem compressed with gzip,
MikeDSmith25@117 50 a receipt and an optional description. Tazpkg also manages
paul@71 51 dependencies based on package receipts. Each receipt contains
MikeDSmith25@117 52 all the information about a package and can also include
paul@70 53 pre and post installation functions. The same receipt is
paul@70 54 used by Tazwok to compile sources and generate a .tazpkg
paul@70 55 package.
paul@70 56 </p>
paul@70 57 <p>
paul@70 58 Tazpkg is entirely built from scratch using SHell script,
paul@70 59 compatible with Bash, it runs under Ash - part of the Busybox
paul@70 60 project. Tazpkg is distributed under the free GNU license GPL V3.
paul@70 61 </p>
paul@70 62
paul@70 63 <h2>COMMANDS</h2>
paul@70 64 <h3><font color="#6c0023">list</font></h3>
paul@70 65 <p>
paul@70 66 List packages installed on the system. This command displays
paul@70 67 a column list of all installed packages, It also allows you to list the
paul@70 68 categories, packages based on category and packages placed on hold.
paul@70 69 You can also use the 'search' command for a list based
paul@70 70 on a term or package name:
paul@70 71 </p>
paul@70 72 <pre>
paul@70 73 # tazpkg list
paul@70 74 # tazpkg list cat|categories
paul@70 75 # tazpkg list blocked
paul@70 76 </pre>
paul@70 77 <h3><font color="#6c0023">xhtml-list</font></h3>
paul@70 78 <p>
paul@70 79 The 'xhtml-list' command can create a XHTML list
paul@70 80 of all the packages installed on the system which can be read
MikeDSmith25@117 81 with your preferred Web browser. It can be run as a normal
paul@126 82 user and creates a page 'installed-packages.html' in
paul@70 83 your current directory. Note that you can change the name of the
paul@70 84 generated list via the command line:
paul@70 85 </p>
paul@70 86 <pre>
paul@70 87 # tazpkg xhtml-list
paul@70 88 # tazpkg xhtml-list list-name.html
paul@70 89 </pre>
paul@70 90 <h3><font color="#6c0023">list-mirror</font></h3>
paul@70 91 <p>
paul@70 92 List packages available on the mirror. This command will
paul@70 93 display the 'packages.list' file recharged from the mirror.
paul@70 94 If this doesn't exist, you will be asked to launch
paul@70 95 'tazpkg recharge' as administrator (root) for a list of
paul@126 96 available packages . The --diff option is used to display
paul@70 97 the differences between the last and current list of packages:
paul@70 98 </p>
paul@70 99 <pre>
paul@70 100 # tazpkg list-mirror
paul@70 101 # tazpkg list-mirror --diff
paul@70 102 </pre>
paul@70 103 <h3><font color="#6c0023">info</font></h3>
paul@70 104 <p>
paul@70 105 Display any information available in the receipt for the
MikeDSmith25@117 106 package in question - its version, category, maintainer,
paul@70 107 Web site and any dependencies (see also Tazwok for more
paul@70 108 information on receipts):
paul@70 109 </p>
paul@70 110 <pre>
paul@70 111 # tazpkg info busybox
paul@70 112 </pre>
paul@70 113 <h3><font color="#6c0023">desc</font></h3>
paul@70 114 <p>
paul@70 115 Description of the package (if it exists). This command
paul@70 116 displays the 'description.txt' file of each package (a simple
paul@127 117 text file, no wider than 80 characters to fit in a standard terminal):
paul@70 118 </p>
paul@70 119 <pre>
paul@70 120 # tazpkg desc busybox
paul@70 121 </pre>
paul@70 122 <h3><font color="#6c0023">list-files</font></h3>
paul@70 123 <p>
paul@70 124 List all files installed with a package. This command will
MikeDSmith25@117 125 simply read and display the 'files.list' of each package which is
paul@70 126 automatically generated when the package is created and is
paul@70 127 also used to remove files when uninstalling a package.
paul@70 128 To list the files installed with the package bc:
paul@70 129 </p>
paul@70 130 <pre>
paul@70 131 # tazpkg list-files bc
paul@70 132 </pre>
paul@70 133 <h3><font color="#6c0023">search</font></h3>
paul@70 134 <p>
MikeDSmith25@117 135 Search for packages by owner or package name. This command
paul@70 136 will search for the term wanted in the installed packages and the
paul@70 137 list of available packages on the mirror. To obtain the
paul@70 138 latest list of installable packages on the mirror, just
paul@70 139 run 'tazpkg recharge' before conducting a search:
paul@70 140 </p>
paul@70 141 <pre>
paul@70 142 # tazpkg search gcc
paul@70 143 </pre>
paul@70 144 <h3><font color="#6c0023">search-file</font></h3>
paul@70 145 <p>
paul@70 146 The 'search-file' command allows you to search for a file
paul@70 147 among the files installed by the packages. This command is very
MikeDSmith25@117 148 useful to find the full path to a file and determine if
paul@70 149 a file is present on the system. Example:
paul@70 150 </p>
paul@70 151 <pre>
paul@70 152 $ tazpkg search-file libnss
paul@70 153 </pre>
paul@70 154 <h3><font color="#6c0023">install</font></h3>
paul@70 155 <p>
paul@70 156 This command allows the installation of a local package with
paul@70 157 the .tazpkg extension. See 'get-install' to install a
paul@70 158 package from the internet. Note that you can force the
paul@126 159 installation via the --forced, uninstall and reinstall options.
paul@126 160 You can also specify the root system where you want to install the
paul@70 161 packages via the -root= option:
paul@70 162 </p>
paul@70 163 <pre>
paul@70 164 # tazpkg install package-1.0.tazpkg
paul@70 165 Or :
paul@70 166 # tazpkg install path/to/package-1.0.tazpkg --forced
paul@70 167 Or :
paul@70 168 # tazpkg install path/to/package-1.0.tazpkg --root=/mnt/rootfs
paul@70 169 </pre>
paul@70 170 <h3><font color="#6c0023">install-list</font></h3>
paul@70 171 <p>
paul@70 172 Install a set of packages listed in a file. This command
paul@70 173 allows you to install several packages with a single command
MikeDSmith25@117 174 and can also be forced:
paul@70 175 </p>
paul@70 176 <pre>
paul@70 177 # tazpkg install-list my-packages.list
paul@70 178 # tazpkg install-list my-packages.list --forced
paul@70 179 </pre>
paul@70 180 <h3><font color="#6c0023">remove</font></h3>
paul@70 181 <p>
MikeDSmith25@117 182 Remove a package. You will be asked for confirmation (y/N).
MikeDSmith25@117 183 This command will delete all files installed with the package.
MikeDSmith25@117 184 To view the list of files, use the 'list-files' command
paul@70 185 followed by the name of the package. Example
paul@70 186 with the package bc:
paul@70 187 </p>
paul@70 188 <pre>
paul@70 189 # tazpkg remove bc
paul@70 190 </pre>
paul@70 191 <h3><font color="#6c0023">extract</font></h3>
paul@70 192 <p>
paul@70 193 Extract a package into a directory. If you do not specify
paul@70 194 the destination directory, the package will be extracted
paul@70 195 in the current directory using the name package-version:
paul@70 196 </p>
paul@70 197 <pre>
paul@70 198 # tazpkg extract package.tazpkg
paul@70 199 # tazpkg extract package.tazpkg target/dir
paul@70 200 </pre>
paul@70 201 <h3><font color="#6c0023">pack</font></h3>
paul@70 202 <p>
paul@70 203 The 'pack' command will create a package from a directory
paul@70 204 prepared in advance or from an unpacked package. It can
paul@70 205 also manually create a .tazpkg package (see the Tazwok documentation
paul@70 206 for the automatic creation of packages). To pack a package:
paul@70 207 </p>
paul@70 208 <pre>
paul@70 209 # tazpkg pack package-version
paul@70 210 </pre>
paul@70 211 <h3><font color="#6c0023">repack</font></h3>
paul@70 212 <p>
paul@70 213 The 'repack' command allows us to recreate a package from
paul@70 214 the files on a system where it was previously installed.
paul@70 215 To repack a package:
paul@70 216 </p>
paul@70 217 <pre>
paul@70 218 # tazpkg repack package
paul@70 219 </pre>
paul@70 220 <h3><font color="#6c0023">recharge</font></h3>
paul@70 221 <p>
paul@70 222 Recharge the list of available packages on the mirror.
paul@70 223 This command will download the most recent 'packages.list'
paul@70 224 of installable packages on the mirror and before starting
paul@70 225 will save the old list. Once the list is updated
paul@70 226 you can then use the 'list' and 'search' commands. To view
paul@126 227 and list the differences, you can use 'list-mirror --diff' and to view
paul@70 228 and update packages, you can 'upgrade'. To recharge the
paul@70 229 latest list of packages:
paul@70 230 </p>
paul@70 231 <pre>
paul@70 232 # tazpkg recharge
paul@70 233 </pre>
paul@70 234 <h3><font color="#6c0023">upgrade</font></h3>
paul@70 235 <p>
paul@70 236 Upgrade allows you to update all installed packages available
paul@70 237 on the current mirror. Upgrading packages is an important
paul@126 238 part of system security, it helps to keep you secure with
paul@70 239 the latest updates and fixes. The SliTaz project,
paul@70 240 although tiny, provides regular updates on security and generally
paul@70 241 offers the latest versions of software. Note that this
paul@70 242 function is aimed at people with SliTaz installed on a
paul@70 243 hard drive. Updated packages in LiveCD mode will be lost on
paul@70 244 system shutdown. To upgrade:
paul@70 245 </p>
paul@70 246 <pre>
paul@70 247 # tazpkg upgrade
paul@70 248 </pre>
paul@70 249 <h3><font color="#6c0023">check</font></h3>
paul@70 250 <p>
paul@70 251 The 'check' command can check dependencies on installed
MikeDSmith25@117 252 packages and determine whether all the files needed for the
paul@70 253 repacking of packages are present:
paul@70 254 </p>
paul@70 255 <pre>
paul@70 256 # tazpkg check package
paul@70 257 </pre>
paul@70 258 <h3><font color="#6c0023">block or unblock</font></h3>
paul@70 259 <p>
paul@70 260 The 'block' and 'unblock' commands permit you to block
paul@70 261 installed package versions so that they are not maintained
paul@70 262 by an 'upgrade'. The list of packages on hold are contained
paul@70 263 in the /var/lib/tazpkg/blocked-packages.list, this file can also
paul@70 264 be edited by hand. To block or unblock a package such as
paul@70 265 Grub:
paul@70 266 </p>
paul@70 267 <pre>
paul@70 268 # tazpkg block grub
paul@70 269 Or :
paul@70 270 # tazpkg unblock grub
paul@70 271 </pre>
paul@70 272 <h3><font color="#6c0023">get</font></h3>
paul@70 273 <p>
paul@70 274 Get a package from the mirror (if it exists). The downloaded
MikeDSmith25@117 275 package is stored in the current directory. To find the path
paul@70 276 you can use 'pwd'. To get the Grub package:
paul@70 277 </p>
paul@70 278 <pre>
paul@70 279 # tazpkg get grub
paul@70 280 </pre>
paul@70 281 <h3><font color="#6c0023">get-install</font></h3>
paul@70 282 <p>
paul@70 283 Get and install a package from a mirror on the internet.
paul@70 284 The 'get-install' command begins by checking whether the
paul@70 285 package exists on the mirror and if it has been already downloaded.
paul@70 286 For a list of packages on the mirror, we must
paul@70 287 use the 'list-mirror' command. To install the package Grub:
paul@70 288 </p>
paul@70 289 <pre>
paul@70 290 # tazpkg get-install grub
paul@70 291 </pre>
paul@70 292 <h3><font color="#6c0023">clean-cache</font></h3>
paul@70 293 <p>
paul@71 294 Remove *.tazpkg packages downloaded to the cache. During
paul@70 295 installation, Tazpkg keeps a copy of packages downloaded
MikeDSmith25@117 296 from the web. This is done to save bandwidth in case of
MikeDSmith25@117 297 reinstallation, but you may want to free up space on the hard
paul@71 298 drive or re-download the packages:
paul@70 299 </p>
paul@70 300 <pre>
paul@70 301 # tazpkg clean-cache
paul@70 302 </pre>
paul@70 303 <h3><font color="#6c0023">setup-mirror</font></h3>
paul@70 304 <p>
paul@70 305 Setup the URL for the mirror. The 'setup-mirror' command
paul@70 306 will ask for the URL for the new mirror. You can specify
MikeDSmith25@117 307 multiple URLs separated by spaces. Note that you can also
paul@70 308 modify the main /var/lib/tazpkg/mirror file. The URL must
paul@70 309 point to the directory containing the 'packages.list' and
paul@70 310 packages:
paul@70 311 </p>
paul@70 312 <pre>
paul@70 313 # tazpkg setup-mirror
paul@70 314 </pre>
paul@70 315
paul@70 316 <h2>MAINTAINER</h2>
paul@70 317 <p>
paul@70 318 Christophe Lincoln &lt;pankso at slitaz.org&gt;
paul@70 319 </p>
paul@70 320
paul@70 321 </div>
paul@70 322 <!-- End content -->
paul@70 323 </body>
paul@70 324 </html>
paul@70 325