spk rev 128 1.1

Add some documentation :-)
author Christophe Lincoln <pankso@slitaz.org>
date Sun Jan 05 02:38:16 2014 +0100 (2014-01-05)
parents ee5a53b16e51
children 54d995f23775
files COPYING Makefile README data/spk-doc.desktop doc/spk.en.html doc/spk.html
line diff
     1.1 --- a/COPYING	Sat Dec 21 22:15:24 2013 +0100
     1.2 +++ b/COPYING	Sun Jan 05 02:38:16 2014 +0100
     1.3 @@ -2,7 +2,7 @@
     1.4  ===============================================================================
     1.5  
     1.6  
     1.7 -Copyright (C) 2012  SliTaz GNU/Linux - BSD License
     1.8 +Copyright (C) 2014  SliTaz GNU/Linux - BSD License
     1.9  
    1.10  
    1.11  Redistribution and use in source and binary forms, with or without
     2.1 --- a/Makefile	Sat Dec 21 22:15:24 2013 +0100
     2.2 +++ b/Makefile	Sun Jan 05 02:38:16 2014 +0100
     2.3 @@ -35,11 +35,17 @@
     2.4  install-lib:
     2.5  	install -m 0755 -d $(DESTDIR)$(PREFIX)/lib/slitaz
     2.6  	install -m 0755 lib/libspk.sh $(DESTDIR)$(PREFIX)/lib/slitaz
     2.7 +	
     2.8 +install-doc:
     2.9 +	install -m 0755 -d $(DESTDIR)$(PREFIX)/share/doc/spk
    2.10 +	install -m 0755 -d $(DESTDIR)$(PREFIX)/share/applications
    2.11 +	install -m 0644 data/spk-doc.desktop $(DESTDIR)$(PREFIX)/share/applications
    2.12 +	install -m 0644 doc/spk.*.html $(DESTDIR)$(PREFIX)/share/doc/spk
    2.13 +	cp -a doc/spk.html $(DESTDIR)$(PREFIX)/share/doc/spk
    2.14  
    2.15 -install: install-lib
    2.16 +install: install-lib install-doc
    2.17  	install -m 0755 -d $(DESTDIR)$(PREFIX)/bin
    2.18  	install -m 0755 -d $(DESTDIR)$(PREFIX)/sbin
    2.19 -	install -m 0755 -d $(DESTDIR)$(PREFIX)/share/doc/spk
    2.20  	install -m 0755 spk $(DESTDIR)$(PREFIX)/bin
    2.21  	install -m 0755 spk-ls $(DESTDIR)$(PREFIX)/bin
    2.22  	install -m 0755 spk-rm $(DESTDIR)$(PREFIX)/sbin
     3.1 --- a/README	Sat Dec 21 22:15:24 2013 +0100
     3.2 +++ b/README	Sun Jan 05 02:38:16 2014 +0100
     3.3 @@ -44,7 +44,7 @@
     3.4  
     3.5  	* packages.desc format: package | 1.0 | desc | category | website
     3.6  	* packages.md5 format : de9f76250657000958ee0120d376613e  package-1.0.tazpkg
     3.7 -	* log package/install.log and package/up.log ti keep trace
     3.8 +	* log package/install.log and package/up.log to keep trace
     3.9  	* ...
    3.10  
    3.11  Since we use latest libtaz.sh, slitaz.conf and libpkg.sh code you must install
     4.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.2 +++ b/data/spk-doc.desktop	Sun Jan 05 02:38:16 2014 +0100
     4.3 @@ -0,0 +1,6 @@
     4.4 +[Desktop Entry]
     4.5 +Type=Application
     4.6 +Name=SliTaz Packages Doc
     4.7 +Exec=browser file:///usr/share/doc/spk/spk.html
     4.8 +Icon=slitaz-doc
     4.9 +Categories=Documentation;
     5.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     5.2 +++ b/doc/spk.en.html	Sun Jan 05 02:38:16 2014 +0100
     5.3 @@ -0,0 +1,93 @@
     5.4 +<!DOCTYPE html>
     5.5 +<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
     5.6 +<head>
     5.7 +	<meta charset="utf-8" />
     5.8 +	<title>Spk Documentation</title>
     5.9 +	<link rel="stylesheet" type="text/css" href="../slitaz-doc.css" />
    5.10 +	<script type="text/javascript" src="../slitaz-doc.js"></script>
    5.11 +</head>
    5.12 +<body>
    5.13 +
    5.14 +<header>
    5.15 +	<h1>Spk Documentation</h1>
    5.16 +</header>
    5.17 +
    5.18 +<!-- Start content -->
    5.19 +<div id="content">
    5.20 +
    5.21 +<h2>SliTaz Packages Toolset</h2>
    5.22 +
    5.23 +<p>
    5.24 +	Small alternative to TazPKG. Spk consite in small separate programm
    5.25 +	for easier code maintainance and use and shared library. Spk can handle
    5.26 +	multiple packages on cmdline as well as managing your own mirror.
    5.27 +</p>
    5.28 +
    5.29 +<h3>Usage</h3>
    5.30 +<p>
    5.31 +	All spk tools provides a small built-in help usage that you can display 
    5.32 +	with the command 'usage'. It also has some options to perform special 
    5.33 +	tasks on a package before executing a task or afterwards. To get help 
    5.34 +	and usage:
    5.35 +</p>
    5.36 +<pre>
    5.37 +# spk usage
    5.38 +# spk-add usage
    5.39 +</pre>
    5.40 +
    5.41 +<h3>Packages info</h3>
    5.42 +<p>
    5.43 +	To get packages status and information:
    5.44 +</p>
    5.45 +<pre>
    5.46 +# spk busybox glib
    5.47 +</pre>
    5.48 +
    5.49 +<h3>Add packages</h3>
    5.50 +<p>
    5.51 +	Spk will handle dependencies. To install new packages simply use
    5.52 +	'spk-add' or the --add option:
    5.53 +</p>
    5.54 +<pre>
    5.55 +# spk-add package1 package2
    5.56 +# spk package --add
    5.57 +</pre>
    5.58 +
    5.59 +<h3>Remove packages</h3>
    5.60 +<p>
    5.61 +	To remove packages simply:
    5.62 +</p>
    5.63 +<pre>
    5.64 +# spk-rm package1 package2 ...
    5.65 +</pre>
    5.66 +
    5.67 +<h3>Packages update</h3>
    5.68 +<p>
    5.69 +	To get the last list of packages and update your system you have
    5.70 +	to use 'spk-up'. Befor installing anything Spk will ask confirmation.
    5.71 +	Spk let you upgrade the full system at once (skipping blocked packages)
    5.72 +	or you can also upgrade packages individualy:
    5.73 +</p>
    5.74 +<pre>
    5.75 +# spk-up
    5.76 +# spk-up package1 package2 ...
    5.77 +</pre>
    5.78 +
    5.79 +<!-- <h3></h3>
    5.80 +<p>
    5.81 +	
    5.82 +</p>
    5.83 +<pre>
    5.84 +# 
    5.85 +</pre> -->
    5.86 +
    5.87 +
    5.88 +<!-- End content -->
    5.89 +</div>
    5.90 +
    5.91 +<footer>
    5.92 +	Copyright © 2014 <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a>
    5.93 +</footer>
    5.94 +
    5.95 +</body>
    5.96 +</html>
     6.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     6.2 +++ b/doc/spk.html	Sun Jan 05 02:38:16 2014 +0100
     6.3 @@ -0,0 +1,1 @@
     6.4 +spk.en.html
     6.5 \ No newline at end of file