r278 - branches/rewrite/doc

[Marco Presi]

Author: zufus
Date: Wed Nov 10 02:53:34 2004
New Revision: 278

Modified:
   branches/rewrite/doc/README
Log:
Added description to doc/README

Modified: branches/rewrite/doc/README
==============================================================================
--- branches/rewrite/doc/README	(original)
+++ branches/rewrite/doc/README	Wed Nov 10 02:53:34 2004
@@ -47,14 +47,60 @@
 In addition when the Merged Backend is created, it is possible to filter
 between the packages in the selected Backend.
 
+Usage: 
+------
+
+(Note: This is different from the actual implementartion..)
+(Note: the following could be used as trace for the man-page)
+
+
+SYNOPSIS:
+
+	debpartial-mirror [-c=file] 
+			  {update [backend, [....]] | merge [backend, [....]] |
+			  | check | clean [backend, [....]]}
+
+DESCRIPTION
+
+debpartial-mirror will accept some command in the way apt-get does, and
+read conf information from a configuration file (default
+/etc/debpartial-mirror/debpartial-mirror.conf) that in turn can include
+other conf files.
+
+      update
+
+	this command let debpartial-mirror to update the backends that
+	compose the partial mirror. If no backend is specified, all
+	backends will be update. Else, only the listed backends will be
+	updated. 
+
+      merge
+
+	this command will create one (or more) merge backend. The list
+	of backends to be used to merge is specified in the main
+	conf-file.
+	
+      clean
+      
+	this command is used to remove old packages from the various
+	backends. As for the other commands, if no backend is specified,
+	all backends will be cleared.
+
 A description of Backend class:
 -------------------------------
 
 Properties:
+	need_update (boolean)
+
 Members:
 	Dists -> A class that realize backend/dists
+	PackageList -> A class that contains the list of packages that
+		       should be copied into the partial-mirror of this
+		       backend 
+
 Methods:
-	create->
+	create-> 
 	update -> Sync the partial-mirror with the sources repositories
-
+	__create_package_list -> Generate a package list reading from
+				 main conf-file.