tazpkg view doc/tazpkg.en.html @ rev 715
add "tazpkg list-suggested"
| author | Xander Ziiryanoff <psychomaniak@xakep.ru> |
|---|---|
| date | Tue Dec 16 15:10:58 2014 +0000 (2014-12-16) |
| parents | d059a3effb3a |
| children | a73c9918a5de |
line source
1 <!DOCTYPE html>
2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
3 <head>
4 <meta charset="utf-8" />
5 <title>TazPkg Manual (en)</title>
6 <link rel="stylesheet" type="text/css" href="../slitaz-doc.css" />
7 <script type="text/javascript" src="../slitaz-doc.js"></script>
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>
140 # tazpkg list-config
141 # tazpkg list-config --box
142 </pre>
145 <h3 id="list-files">list-files</h3>
147 <p>
148 List all files installed with a package. This command will
149 simply read and display the <tt>files.list</tt> of each package which is
150 automatically generated when the package is created and is
151 also used to remove files when uninstalling a package.
152 To list the files installed with the package bc:
153 </p>
154 <pre>
155 # tazpkg list-files <em>bc</em>
156 </pre>
159 <h3 id="search">search</h3>
161 <p>
162 Search for packages by owner or package name. This command
163 will search for the term wanted in the installed packages and the
164 list of available packages on the mirror. To obtain the
165 latest list of installable packages on the mirror, just
166 run <code>tazpkg recharge</code> before conducting a search:
167 </p>
168 <pre>
169 # tazpkg search <em>gcc</em>
170 </pre>
173 <h3 id="search-file">search-file</h3>
175 <p>
176 The <tt>search-file</tt> command allows you to search for a file
177 among the files installed by the packages. This command is very
178 useful to find the full path to a file and determine if
179 a file is present on the system. Example:
180 </p>
181 <pre>
182 $ tazpkg search-file <em>libnss</em>
183 </pre>
186 <h3 id="install">install</h3>
188 <p>
189 This command allows the installation of a local package with
190 the <tt>.tazpkg</tt> extension. See
191 <tt><a href="#get-install">get-install</a></tt> to install a
192 package from the internet. Note that you can force the
193 installation via the <tt>--forced</tt>, <tt>uninstall</tt> and
194 <tt>reinstall</tt> options
195 or specify the root system where you want to install the
196 packages via the <tt>--root=</tt> option:
197 </p>
198 <pre>
199 # tazpkg install <em>package-1.0.tazpkg</em>
200 # tazpkg install <em>path/to/package-1.0.tazpkg</em> --forced
201 # tazpkg install <em>path/to/package-1.0.tazpkg</em> --root=<em>/mnt/rootfs</em>
202 </pre>
205 <h3 id="install-list">install-list or get-install-list</h3>
206 <p>
207 Install a set of packages listed in a file. This command
208 allows you to (download and) install several packages with a single command
209 and can also be forced:
210 </p>
211 <pre>
212 # tazpkg install-list <em>my-packages.list</em>
213 # tazpkg get-install-list <em>my-packages.list</em> --forced
214 </pre>
217 <h3 id="link">link</h3>
219 <p>
220 This command allows the installation of a package from another media
221 device. The set up is done through symbolic links and consumes very little
222 memory. It is generally used within the system RAM to install add-ons
223 from an USB key:
224 </p>
225 <pre>
226 # tazpkg link <em>openoffice /media/usbdisk</em>
227 </pre>
230 <h3 id="remove">remove</h3>
232 <p>
233 Remove a package. You will be asked for confirmation (y/N).
234 This command will delete all files installed with the package.
235 To view the list of files, use the <tt><a href="#list-files">list-files</a></tt>
236 command followed by the name of the package. Example
237 with the package bc:
238 </p>
239 <pre>
240 # tazpkg remove <em>bc</em>
241 </pre>
244 <h3 id="extract">extract</h3>
246 <p>
247 Extract a package into a directory. If you do not specify
248 the destination directory, the package will be extracted
249 in the current directory using the name <tt><em>package-version</em></tt>:
250 </p>
251 <pre>
252 # tazpkg extract <em>package.tazpkg</em>
253 # tazpkg extract <em>package.tazpkg target/dir</em>
254 </pre>
257 <h3 id="pack">pack</h3>
259 <p>
260 The <tt>pack</tt> command will create a package from a directory
261 prepared in advance or from an unpacked package. It can
262 also manually create a .tazpkg package (see the Cookutils documentation
263 for the automatic creation of packages). To pack a package:
264 </p>
265 <pre>
266 # tazpkg pack <em>package-version</em>
267 </pre>
270 <h3 id="repack">repack</h3>
272 <p>
273 The <tt>repack</tt> command allows you to recreate a package from
274 the files on a system where it was previously installed.
275 To repack a package:
276 </p>
277 <pre>
278 # tazpkg repack <tt>package</tt>
279 </pre>
282 <h3 id="repack-config">repack-config</h3>
284 <p>
285 The <tt>repack-config</tt> command recreates a package
286 of the system configuration files (see
287 <tt><a href="#list-config">list-config</a></tt>). It is enough
288 to install the package to find the current configuration. To repack
289 the configuration files:
290 </p>
291 <pre>
292 # tazpkg repack-config
293 </pre>
296 <h3 id="recharge">recharge</h3>
298 <p>
299 Recharge the list of available packages on the mirror.
300 This command will download the most recent <tt>packages.list</tt>
301 of installable packages on the mirror and before starting
302 will save the old list. Once the list is updated,
303 you can then use the <tt><a href="#list">list</a></tt> and
304 <tt><a href="#search">search</a></tt> commands. To view
305 and list the differences, you can use <code>list-mirror --diff</code>;
306 and to view and update packages, you can simply
307 <tt><a href="#upgrade">upgrade</a></tt>. To recharge the
308 latest list of packages:
309 </p>
310 <pre>
311 # tazpkg recharge
312 </pre>
315 <h3 id="upgrade">up or upgrade</h3>
317 <p>
318 Upgrade allows you to update all installed packages available
319 on the current mirror. Upgrading packages is an important
320 part of system security, it helps to keep you secure with
321 the latest updates and fixes. The SliTaz project,
322 although tiny, provides regular updates on security and generally
323 offers the latest versions of software. Note that this
324 function is aimed at people with SliTaz installed on a
325 hard drive. Updated packages in LiveCD mode will be lost on
326 system shutdown. To upgrade or display the full <tt>up</tt> options:
327 </p>
328 <pre>
329 # tazpkg up
330 # tazpkg --help-up
331 # tazpkg up --recharge --install
332 # tazpkg up -r -i
333 </pre>
336 <h3 id="check">check</h3>
338 <p>
339 The <tt>check</tt> command can check dependencies on installed
340 packages and determine whether all the files needed for the
341 repacking of packages are present:
342 </p>
343 <pre>
344 # tazpkg check <em>package</em>
345 </pre>
348 <h3 id="block">block or unblock</h3>
350 <p>
351 The <tt>block</tt> and <tt>unblock</tt> commands permit you to block
352 installed package versions so that they are not maintained
353 by an <tt><a href="#upgrade">upgrade</a></tt>. The list of packages
354 on hold are contained
355 in the <tt>/var/lib/tazpkg/blocked-packages.list</tt>. This file can also
356 be edited by hand. To block or unblock a package such as
357 Grub:
358 </p>
359 <pre>
360 # tazpkg block <em>grub</em>
361 # tazpkg unblock <em>grub</em>
362 </pre>
365 <h3 id="get">get</h3>
367 <p>
368 Get a package from the mirror (if it exists). The downloaded
369 package is stored in the current directory. To find the path
370 you can use <code>pwd</code>. To get the Grub package:
371 </p>
372 <pre>
373 # tazpkg get <em>grub</em>
374 </pre>
377 <h3 id="get-install">get-install</h3>
379 <p>
380 Get and install a package from a mirror on the internet.
381 The <tt>get-install</tt> command begins by checking whether the
382 package exists on the mirror and if it has been already downloaded.
383 For a list of packages on the mirror, we must
384 use the <tt><a href="#list-mirror">list-mirror</a></tt> command.
385 To install the package Grub:
386 </p>
387 <pre>
388 # tazpkg get-install <tt>grub</tt>
389 </pre>
392 <h3 id="clean-cache">clean-cache</h3>
394 <p>
395 Remove *.tazpkg packages downloaded to the cache. During
396 installation, TazPkg keeps a copy of packages downloaded
397 from the web. This is done to save bandwidth in case of
398 reinstallation, but you may want to free up space on the hard
399 drive or re-download the packages:
400 </p>
401 <pre>
402 # tazpkg clean-cache
403 </pre>
406 <h3 id="setup-mirror">setup-mirror</h3>
408 <p>
409 Setup the URL for the mirror. The <tt>setup-mirror</tt> command
410 will ask for the URL of the new mirror. You can specify
411 multiple URLs separated by spaces. Note that you can also
412 modify the main <tt>/var/lib/tazpkg/mirror</tt> file. The URL must
413 point to the directory containing the <tt>packages.list</tt> and
414 packages:
415 </p>
416 <pre>
417 # tazpkg setup-mirror
418 </pre>
421 <h3 id="reconfigure">reconfigure</h3>
423 <p>
424 Replays the post-install script from the package.
425 Example using gcc:
426 </p>
427 <pre>
428 # tazpkg reconfigure <em>gcc</em>
429 </pre>
432 <h3 id="depends">depends or rdepends</h3>
434 <p>
435 Displays a dependency tree or reverse dependency tree for a package.
436 Examples using mpd:
437 </p>
438 <pre>
439 # tazpkg depends <em>mpd</em>
440 # tazpkg rdepends <em>mpd</em>
441 </pre>
444 <h3 id="add-undigest">add-undigest or setup-undigest</h3>
446 <p>
447 Set the URL of an additional unofficial mirror to test packages that
448 are not yet present on the official mirrors. Note, you can also
449 manually edit the file in <tt>/var/lib/tazpkg/undigest/<em>repository</em></tt>.
450 The URL must point to the directory containing the packages and
451 <tt>packages.list</tt>:
452 </p>
453 <pre>
454 # tazpkg add-undigest <em>public-repository http://my.home.org/slitaz</em>
455 # tazpkg setup-undigest <em>local-repository /home/slitaz/packages</em>
456 </pre>
459 <h3 id="remove-undigest">remove-undigest</h3>
461 <p>
462 Removes the URL of an undigest mirror:
463 </p>
464 <pre>
465 # tazpkg remove-undigest <em>my-repository</em>
466 </pre>
469 <h3 id="list-undigest">list-undigest</h3>
471 <p>
472 Lists additional undigest mirrors:
473 </p>
474 <pre>
475 # tazpkg list-undigest
476 </pre>
479 <h3 id="convert">convert</h3>
481 <p>
482 Converts a Debian package (.deb), Redhat (.rpm), Slackware (.tgz) or
483 Archlinux (.pkg.tar.gz) package into a SliTaz package (.tazpkg):
484 </p>
485 <pre>
486 # tazpkg convert <em>alien-package</em>
487 </pre>
490 <h3 id="set-release">set-release</h3>
491 <p>
492 The <tt>set-release</tt> command changes the current version and
493 upgrades all of the packages to the latest release:
494 </p>
495 <pre>
496 # tazpkg set-release <em>cooking</em>
497 </pre>
500 <h3 id="bugs">bugs</h3>
501 <p>
502 Generates a list of known bugs in the packages:
503 </p>
504 <pre>
505 # tazpkg bugs
506 </pre>
508 <h2>MAINTAINER</h2>
509 <p>
510 Christophe Lincoln <pankso at slitaz.org>
511 </p>
513 </div>
514 <!-- End content -->
515 </body>
516 </html>