spk view README @ rev 64
spk-archive: be busybox ash compatible
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Fri May 18 03:19:51 2012 +0200 (2012-05-18) |
| parents | 85543a2e118c |
| children | 2caa9666fc1f |
line source
1 SliTaz Spk
2 ================================================================================
5 The SliTaz Spk toolset provides tools and utils to handle SliTaz packages.
8 Spk
9 -------------------------------------------------------------------------------
10 Spk is the main tool to handle and play with SliTaz packages, it handles multiple
11 packages on a cmdline and a wide range of --options which will perform tasks such
12 as adding or removing packages using the toolset. Spk itself provides some small
13 commands such as ls or info.
16 Toolset
17 -------------------------------------------------------------------------------
18 Spk is separated into many small tools following the UNIX philosophy: one tool
19 for one task but do that task well. Here is a list of proposed tools and their
20 functions:
22 * spk-ls : List packages and packages files
23 * spk-add : Install local or online pkgs
24 * spk-rm : Remove packages with confirm in option
25 * spk-up : Upgrade the whole system
26 * spk-search : Search for packages or files
27 * spk-archive: Manage package extraction, compression, and packing
28 * spk-mirror : Manage official and extra mirrors
31 LibSpk
32 -------------------------------------------------------------------------------
33 Libspk provides base functions and internal variables used by almost all spk-tools.
34 Libspk must be installed via 'make install-lib' to develop spk-tools.
36 * Source: libtaz.sh, libpkg.sh, slitaz.conf
37 * Internal Spk variables (lowercase, not configurable)
38 * Display package info
39 * ...
42 Devnotes
43 -------------------------------------------------------------------------------
44 Some random and useful notes.
46 * packages.desc format: package | 1.0 | desc | category | website
47 * packages.md5 format : de9f76250657000958ee0120d376613e package-1.0.tazpkg
48 * log package/install.log and package/up.log ti keep trace
49 * ...
51 Since we use latest libtaz.sh, slitaz.conf and libpkg.sh code you must install
52 these files to develop the Spk Toolset:
54 $ hg clone http://hg.slitaz.org/slitaz-base-files
55 $ cd slitaz-base-files
56 $ make install-libtaz
57 $ make install-libpkg
58 $ make install-slitaz
61 Coding style
62 --------------------------------------------------------------------------------
63 Here are the spk coding style notes, follow them if you want your code included
64 in the package. These rules are in addition to cookutils coding style, please
65 also read cookutils/README
68 * No bash, be Busybox Ash compatible
69 * Use libtaz.sh, slitaz.conf and libpkg.sh
70 * ...
72 ================================================================================