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