[Ngetsuite-cvs] ngetsuite HOWTO,1.1,1.2

[<bla...@us...>]

Update of /cvsroot/ngetsuite/ngetsuite
In directory sc8-pr-cvs1:/tmp/cvs-serv31212

Modified Files:
	HOWTO 
Log Message:
added some details

Index: HOWTO
===================================================================
RCS file: /cvsroot/ngetsuite/ngetsuite/HOWTO,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** HOWTO	15 Jan 2004 11:13:10 -0000	1.1
--- HOWTO	20 Jan 2004 23:15:54 -0000	1.2
***************
*** 1,16 ****
  How to use ngetsuite :
- Before everything, start the daemon and optionnaly the httpd
- 
- ./daemon.rb >/dev/null 2>&1 &
- ./testhttpd.rb >testhttpd.log 2>&1 &
- disown -a
  
  
  you can show the groups watched with
  
! ./ngetsuite.rb -s
  
  
! you must regularly update the news reader cache with for example a crontab like this :
  
  10 5 * * * ~/ngetupdate.sh
--- 1,29 ----
  How to use ngetsuite :
  
+ I) Launching the daemon and the web server
+ ------------------------------------------
+ Before everything, start the daemon and optionnaly the httpd :
+ 	./daemon.rb >/dev/null 2>&1 &
+ 	./testhttpd.rb >testhttpd.log 2>&1 &
+ 	disown -a
  
  you can show the groups watched with
+ 	./ngetsuite.rb -s
  
! II) Add some groups
! -------------------
! Add one or more groups with :
! 	./ngetsuite.rb -a alt.binaries.pictures.linux,linux-pics,/home/me/download/abpl
  
+ The last two arguments are optional (see ./ngetsuite.rb -h for the full list of
+ possible arguments). If no id is provided, it will be created from the first
+ letter of each component of the full name (alt.binaries.pictures.linux => abpl).
  
! You can get the full list of registered newsgroup with the command :
! 	./ngetsuite.rb -s
! 
! III) Update the headers from the news server
! --------------------------------------------
! you must update the news reader cache with for example a crontab like this :
  
  10 5 * * * ~/ngetupdate.sh
***************
*** 21,35 ****
  ./ngetsuite.rb -v
  
  you can void the output if you don't want mails from cron.
  
  
! Add one or more groups with
  
! ./ngetsuite.rb -a alt.binaries.martine.xxx,abmx28,/home/me/downloadMartine
  
  
! Then you select the things you want to download with
! TODO
  
  
  happy download !
--- 34,65 ----
  ./ngetsuite.rb -v
  
+ This will fetch the headers from the news server, parse the cache file and
+ insert the headers into the mysql database.
+ 
  you can void the output if you don't want mails from cron.
  
+ Alternatively, you can update a specific group with :
+ 	./ngetsuite.rb -u groupid
  
! IV) Add a regexp to the download queue
! --------------------------------------
! You must add a queue to download with :
! 	./ngetsuite.rb -r groupid,regexp,prio
  
! ie : 
! 	./ngetsuite.rb -r linux-pics,penguin,7
  
+ Finally, you must start the monitoring with ./ngetsuite.rb -m : the daemon will
+ then look for the queue with a 'PENDING' status and the greatest priority,
+ mark this queue as 'PROCESSING' and start a nget instance with the corresponding
+ regexp.
  
! When the nget process has finished, the queue will be marked as 'FINISHED'. If
! you want to start processing this queue again (because of a network failure),
! you just have to change the status of the queue to 'PENDING' with :
! 	./ngetsuite.rb -i queueid,PENDING
  
+ You can get the list of queued items with :
+ 	./ngetsuite.rb -m
  
  happy download !