website view en/doc/manuals/tazpkg.en.html @ rev 538

en: Update tazpkg manual and add link to dev page
author Paul Issott <paul@slitaz.org>
date Wed Aug 26 20:24:46 2009 +0000 (2009-08-26)
parents a52d8135ce42
children 773e49b29b16
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">
31
32 <h2>NAME</h2>
33 <p>
34 Tazpkg - Tiny autonomous zone package manager
35 </p>
36
37 <h2>SYNTAX</h2>
38 <pre>
39 tazpkg [command] [package|dir|pattern|list|cat|--opt] [dir|--opt]
40 </pre>
41
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.
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>
62
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 <h3><font color="#6c0023">xhtml-list</font></h3>
78 <p>
79 The 'xhtml-list' 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 'installed-packages.html' 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 list-name.html
89 </pre>
90 <h3><font color="#6c0023">list-mirror</font></h3>
91 <p>
92 List packages available on the mirror. This command will
93 display the 'packages.list' file recharged from the mirror.
94 If this doesn't exist, you will be asked to launch
95 'tazpkg recharge' as administrator (root) for a list of
96 available packages . The --diff option is used to display
97 the differences between the last and current list of packages:
98 </p>
99 <pre>
100 # tazpkg list-mirror
101 # tazpkg list-mirror --diff
102 </pre>
103 <h3><font color="#6c0023">info</font></h3>
104 <p>
105 Display any information available in the receipt for the
106 package in question - its version, category, maintainer,
107 Web site and any dependencies (see also Tazwok for more
108 information on receipts):
109 </p>
110 <pre>
111 # tazpkg info busybox
112 </pre>
113 <h3><font color="#6c0023">desc</font></h3>
114 <p>
115 Description of the package (if it exists). This command
116 displays the 'description.txt' file of each package (a simple
117 text file, justified to 80 characters to fit in a standard terminal):
118 </p>
119 <pre>
120 # tazpkg desc busybox
121 </pre>
122 <h3><font color="#6c0023">list-config</font></h3>
123 <p>
124 Lists the system configuration files. The --box option displays
125 in table format:
126 </p>
127 <pre> # tazpkg list-config
128 # tazpkg list-config --box
129 </pre>
130 <h3><font color="#6c0023">list-files</font></h3>
131 <p>
132 List all files installed with a package. This command will
133 simply read and display the 'files.list' of each package which is
134 automatically generated when the package is created and is
135 also used to remove files when uninstalling a package.
136 To list the files installed with the package bc:
137 </p>
138 <pre>
139 # tazpkg list-files bc
140 </pre>
141 <h3><font color="#6c0023">search</font></h3>
142 <p>
143 Search for packages by owner or package name. This command
144 will search for the term wanted in the installed packages and the
145 list of available packages on the mirror. To obtain the
146 latest list of installable packages on the mirror, just
147 run 'tazpkg recharge' before conducting a search:
148 </p>
149 <pre>
150 # tazpkg search gcc
151 </pre>
152 <h3><font color="#6c0023">search-file</font></h3>
153 <p>
154 The 'search-file' command allows you to search for a file
155 among the files installed by the packages. This command is very
156 useful to find the full path to a file and determine if
157 a file is present on the system. Example:
158 </p>
159 <pre>
160 $ tazpkg search-file libnss
161 </pre>
162 <h3><font color="#6c0023">install</font></h3>
163 <p>
164 This command allows the installation of a local package with
165 the .tazpkg extension. See 'get-install' to install a
166 package from the internet. Note that you can force the
167 installation via the --forced, uninstall and reinstall options
168 or specify the root system where you want to install the
169 packages via the -root= option:
170 </p>
171 <pre>
172 # tazpkg install package-1.0.tazpkg
173 Or :
174 # tazpkg install path/to/package-1.0.tazpkg --forced
175 Or :
176 # tazpkg install path/to/package-1.0.tazpkg --root=/mnt/rootfs
177 </pre>
178 <h3><font color="#6c0023">install-list or get-install-list</font></h3>
179 <p>
180 Install a set of packages listed in a file. This command
181 allows you to (download and) install several packages with a single command
182 and can also be forced:
183 </p>
184 <pre> # tazpkg install-list my-packages.list
185 # tazpkg get-install-list my-packages.list --forced
186 </pre>
187 <h3><font color="#6c0023">link</font></h3>
188 <p>
189 This command allows the installation of a package from another media
190 device. The set up is done through symbolic links and consumes very little
191 memory. It is generally used within the system RAM to install add-ons
192 from an USB key:
193 </p>
194 <pre>
195 # tazpkg link openoffice /media/usbdisk
196 </pre>
197 <h3><font color="#6c0023">remove</font></h3>
198 <p>
199 Remove a package. You will be asked for confirmation (y/N).
200 This command will delete all files installed with the package.
201 To view the list of files, use the 'list-files' command
202 followed by the name of the package. Example
203 with the package bc:
204 </p>
205 <pre>
206 # tazpkg remove bc
207 </pre>
208 <h3><font color="#6c0023">extract</font></h3>
209 <p>
210 Extract a package into a directory. If you do not specify
211 the destination directory, the package will be extracted
212 in the current directory using the name package-version:
213 </p>
214 <pre>
215 # tazpkg extract package.tazpkg
216 # tazpkg extract package.tazpkg target/dir
217 </pre>
218 <h3><font color="#6c0023">pack</font></h3>
219 <p>
220 The 'pack' command will create a package from a directory
221 prepared in advance or from an unpacked package. It can
222 also manually create a .tazpkg package (see the Tazwok documentation
223 for the automatic creation of packages). To pack a package:
224 </p>
225 <pre>
226 # tazpkg pack package-version
227 </pre>
228 <h3><font color="#6c0023">repack</font></h3>
229 <p>
230 The 'repack' command allows you to recreate a package from
231 the files on a system where it was previously installed.
232 To repack a package:
233 </p>
234 <pre>
235 # tazpkg repack package
236 </pre>
237 <h3><font color="#6c0023">repack-config</font></h3>
238 <p>
239 The 'repack-config' command recreates a package
240 of the system configuration files (see list-config). It is enough
241 to install the package to find the current configuration. To repack
242 the configuration files:
243 </p>
244 <pre> # tazpkg repack-config
245 </pre>
246 <h3><font color="#6c0023">recharge</font></h3>
247 <p>
248 Recharge the list of available packages on the mirror.
249 This command will download the most recent 'packages.list'
250 of installable packages on the mirror and before starting
251 will save the old list. Once the list is updated
252 you can then use the 'list' and 'search' commands. To view
253 and list the differences, you can use 'list-mirror --diff', and to view
254 and update packages, you can simply 'upgrade'. To recharge the
255 latest list of packages:
256 </p>
257 <pre>
258 # tazpkg recharge
259 </pre>
260 <h3><font color="#6c0023">upgrade</font></h3>
261 <p>
262 Upgrade allows you to update all installed packages available
263 on the current mirror. Upgrading packages is an important
264 part of system security, it helps to keep you secure with
265 the latest updates and fixes. The SliTaz project,
266 although tiny, provides regular updates on security and generally
267 offers the latest versions of software. Note that this
268 function is aimed at people with SliTaz installed on a
269 hard drive. Updated packages in LiveCD mode will be lost on
270 system shutdown. To upgrade:
271 </p>
272 <pre>
273 # tazpkg upgrade
274 </pre>
275 <h3><font color="#6c0023">check</font></h3>
276 <p>
277 The 'check' command can check dependencies on installed
278 packages and determine whether all the files needed for the
279 repacking of packages are present:
280 </p>
281 <pre>
282 # tazpkg check package
283 </pre>
284 <h3><font color="#6c0023">block or unblock</font></h3>
285 <p>
286 The 'block' and 'unblock' commands permit you to block
287 installed package versions so that they are not maintained
288 by an 'upgrade'. The list of packages on hold are contained
289 in the /var/lib/tazpkg/blocked-packages.list. This file can also
290 be edited by hand. To block or unblock a package such as
291 Grub:
292 </p>
293 <pre>
294 # tazpkg block grub
295 Or :
296 # tazpkg unblock grub
297 </pre>
298 <h3><font color="#6c0023">get</font></h3>
299 <p>
300 Get a package from the mirror (if it exists). The downloaded
301 package is stored in the current directory. To find the path
302 you can use 'pwd'. To get the Grub package:
303 </p>
304 <pre>
305 # tazpkg get grub
306 </pre>
307 <h3><font color="#6c0023">get-install</font></h3>
308 <p>
309 Get and install a package from a mirror on the internet.
310 The 'get-install' command begins by checking whether the
311 package exists on the mirror and if it has been already downloaded.
312 For a list of packages on the mirror, we must
313 use the 'list-mirror' command. To install the package Grub:
314 </p>
315 <pre>
316 # tazpkg get-install grub
317 </pre>
318 <h3><font color="#6c0023">clean-cache</font></h3>
319 <p>
320 Remove *.tazpkg packages downloaded to the cache. During
321 installation, Tazpkg keeps a copy of packages downloaded
322 from the web. This is done to save bandwidth in case of
323 reinstallation, but you may want to free up space on the hard
324 drive or re-download the packages:
325 </p>
326 <pre>
327 # tazpkg clean-cache
328 </pre>
329 <h3><font color="#6c0023">setup-mirror</font></h3>
330 <p>
331 Setup the URL for the mirror. The 'setup-mirror' command
332 will ask for the URL of the new mirror. You can specify
333 multiple URLs separated by spaces. Note that you can also
334 modify the main /var/lib/tazpkg/mirror file. The URL must
335 point to the directory containing the 'packages.list' and
336 packages:
337 </p>
338 <pre>
339 # tazpkg setup-mirror
340 </pre>
341 <h3><font color="#6c0023">reconfigure</font></h3>
342 <p>
343 Replays the post-install script from the package.
344 Example using gcc:
345 </p>
346 <pre> # tazpkg reconfigure gcc
347 </pre>
348 <h3><font color="#6c0023">depends or rdepends</font></h3>
349 <p>
350 Displays a dependency tree or reverse dependency tree for a package.
351 Examples using mpd:
352 </p>
353 <pre> # tazpkg depends mpd
354 # tazpkg rdepends mpd
355 </pre>
356 <h3><font color="#6c0023">add-undigest or setup-undigest</font></h3>
357 <p>
358 Set the URL of an additional unofficial mirror to test packages that
359 are not yet present on the official mirrors. Note, you can also
360 manually edit the file in /var/lib/tazpkg/undigest/'repository'. The URL
361 must point to the directory containing the packages and 'packages.list':
362 </p>
363 <pre>
364 # tazpkg add-undigest public-repository http://my.home.org/slitaz
365 # tazpkg setup-undigest local-repository /home/slitaz/packages
366 </pre>
367 <h3><font color="#6c0023">remove-undigest</font></h3>
368 <p>
369 Removes the URL of an undigest mirror:
370 </p>
371 <pre>
372 # tazpkg remove-undigest my-repository
373 </pre>
374 <h3><font color="#6c0023">list-undigest</font></h3>
375 <p>
376 Lists additional undigest mirrors:
377 </p>
378 <pre>
379 # tazpkg list-undigest
380 </pre>
381 <h3><font color="#6c0023">convert</font></h3>
382 <p>
383 Converts a Debian package (.deb), Redhat (.rpm), Slackware (.tgz) or
384 Archlinux (.pkg.tar.gz) package into a SliTaz package (.tazpkg):
385 </p>
386 <pre>
387 # tazpkg convert alien-package
388 </pre>
389 <h3><font color="#6c0023">set-release</font></h3>
390 <p>
391 The 'set-release' command changes the current version and
392 upgrades the packages to the latest release:
393 </p>
394 <pre> # tazpkg set-release cooking
395 </pre>
396 <h3><font color="#6c0023">bugs</font></h3>
397 <p>
398 Generates a list of known bugs in the packages:
399 </p>
400 <pre> # tazpkg bugs
401 </pre>
402
403 <h2>MAINTAINER</h2>
404 <p>
405 Christophe Lincoln &lt;pankso at slitaz.org&gt;
406 </p>
407
408 </div>
409 <!-- End content -->
410 </body>
411 </html>
412