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