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