spk annotate README @ rev 144
Mini up in doc
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Sun Apr 06 22:33:53 2014 +0200 (2014-04-06) |
| parents | 218ee0ee6502 |
| children |
| 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 |
| paul@141 | 24 * spk-rm : Remove packages with confirming option |
| paul@12 | 25 * spk-up : Upgrade the whole system |
| pankso@0 | 26 * spk-search : Search for packages or files |
| pankso@60 | 27 * spk-mirror : Manage official and extra mirrors |
| pankso@3 | 28 |
| pankso@5 | 29 |
| meshca@4 | 30 LibSpk |
| meshca@4 | 31 ------------------------------------------------------------------------------- |
| paul@12 | 32 Libspk provides base functions and internal variables used by almost all spk-tools. |
| pankso@57 | 33 Libspk must be installed via 'make install-lib' to develop spk-tools. |
| pankso@5 | 34 |
| pankso@5 | 35 * Source: libtaz.sh, libpkg.sh, slitaz.conf |
| pankso@5 | 36 * Internal Spk variables (lowercase, not configurable) |
| meshca@4 | 37 * Display package info |
| meshca@4 | 38 * ... |
| pankso@0 | 39 |
| pankso@5 | 40 |
| pankso@0 | 41 Devnotes |
| pankso@0 | 42 ------------------------------------------------------------------------------- |
| paul@12 | 43 Some random and useful notes. |
| pankso@0 | 44 |
| pankso@0 | 45 * packages.desc format: package | 1.0 | desc | category | website |
| pankso@0 | 46 * packages.md5 format : de9f76250657000958ee0120d376613e package-1.0.tazpkg |
| pankso@128 | 47 * log package/install.log and package/up.log to keep trace |
| pankso@0 | 48 * ... |
| pankso@0 | 49 |
| pankso@2 | 50 Since we use latest libtaz.sh, slitaz.conf and libpkg.sh code you must install |
| pankso@2 | 51 these files to develop the Spk Toolset: |
| pankso@2 | 52 |
| pankso@2 | 53 $ hg clone http://hg.slitaz.org/slitaz-base-files |
| pankso@2 | 54 $ cd slitaz-base-files |
| pankso@2 | 55 $ make install-libtaz |
| pankso@2 | 56 $ make install-libpkg |
| pankso@2 | 57 $ make install-slitaz |
| pankso@2 | 58 |
| pankso@0 | 59 |
| pankso@0 | 60 Coding style |
| pankso@0 | 61 -------------------------------------------------------------------------------- |
| pankso@0 | 62 Here are the spk coding style notes, follow them if you want your code included |
| pankso@0 | 63 in the package. These rules are in addition to cookutils coding style, please |
| paul@98 | 64 also read the cookutils/README |
| pankso@0 | 65 |
| pankso@0 | 66 |
| paul@12 | 67 * No bash, be Busybox Ash compatible |
| paul@12 | 68 * Use libtaz.sh, slitaz.conf and libpkg.sh |
| pankso@0 | 69 * ... |
| pankso@0 | 70 |
| pankso@0 | 71 ================================================================================ |
| pankso@0 | 72 |