spk view README @ rev 131
Tiny edits
| author | Paul Issott <paul@slitaz.org> |
|---|---|
| date | Mon Mar 03 16:06:46 2014 +0000 (2014-03-03) |
| parents | 0df5690de5fd |
| children | 1ab690b993b4 |
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-mirror : Manage official and extra mirrors
30 LibSpk
31 -------------------------------------------------------------------------------
32 Libspk provides base functions and internal variables used by almost all spk-tools.
33 Libspk must be installed via 'make install-lib' to develop spk-tools.
35 * Source: libtaz.sh, libpkg.sh, slitaz.conf
36 * Internal Spk variables (lowercase, not configurable)
37 * Display package info
38 * ...
41 Devnotes
42 -------------------------------------------------------------------------------
43 Some random and useful notes.
45 * packages.desc format: package | 1.0 | desc | category | website
46 * packages.md5 format : de9f76250657000958ee0120d376613e package-1.0.tazpkg
47 * log package/install.log and package/up.log to keep trace
48 * ...
50 Since we use latest libtaz.sh, slitaz.conf and libpkg.sh code you must install
51 these files to develop the Spk Toolset:
53 $ hg clone http://hg.slitaz.org/slitaz-base-files
54 $ cd slitaz-base-files
55 $ make install-libtaz
56 $ make install-libpkg
57 $ make install-slitaz
60 Coding style
61 --------------------------------------------------------------------------------
62 Here are the spk coding style notes, follow them if you want your code included
63 in the package. These rules are in addition to cookutils coding style, please
64 also read the cookutils/README
67 * No bash, be Busybox Ash compatible
68 * Use libtaz.sh, slitaz.conf and libpkg.sh
69 * ...
71 ================================================================================