tazpkg view doc/tazpkg.en.html @ rev 519

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