spk annotate README @ rev 1

Spellcheck and add spk- tools
author Christian Mesh <meshca@clarkson.edu>
date Fri May 11 09:48:50 2012 -0500 (2012-05-11)
parents 6283935f9aef
children 4ce256d47250
rev   line source
pankso@0 1 SliTaz Spk
pankso@0 2 ================================================================================
pankso@0 3
pankso@0 4
pankso@0 5 The SliTaz Spk toolset provide 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
meshca@1 11 packages on cmdline and a wide range of --options which will perform tasks such as
meshca@1 12 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 -------------------------------------------------------------------------------
meshca@1 18 Spk is separated in many small tools following the UNIX philosophy: one tool for
meshca@1 19 one task but do that task well. Here is a list of proposal tools and ther functions:
pankso@0 20
pankso@0 21 * spk-add : Install local or online pkgs
pankso@0 22 * spk-rm : Remove packages: confirm in option ?
pankso@0 23 * spk-up : Upgrade the all system
pankso@0 24 * spk-search : Search for packages or files
meshca@1 25 * spk-archive: Manage pacakge extraction, compression, and packing
meshca@1 26 * spk-mirror : Manage mirrors and undigest
meshca@1 27 * spk-info : Print info about packages
pankso@0 28
pankso@0 29
pankso@0 30 Devnotes
pankso@0 31 -------------------------------------------------------------------------------
pankso@0 32
pankso@0 33 * packages.desc format: package | 1.0 | desc | category | website
pankso@0 34 * packages.md5 format : de9f76250657000958ee0120d376613e package-1.0.tazpkg
pankso@0 35 * ...
pankso@0 36
pankso@0 37
pankso@0 38 Coding style
pankso@0 39 --------------------------------------------------------------------------------
pankso@0 40 Here are the spk coding style notes, follow them if you want your code included
pankso@0 41 in the package. These rules are in addition to cookutils coding style, please
pankso@0 42 read also cookutils/README
pankso@0 43
pankso@0 44
pankso@0 45 * No bash, be Busybox Ash compatible
pankso@0 46 * Use libtaz.sh, slitaz.conf and libpkg.sh
pankso@0 47 * ...
pankso@0 48
pankso@0 49 ================================================================================
pankso@0 50