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