home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume36 / slurp / part01 / README < prev    next >
Encoding:
Text File  |  1993-03-12  |  8.4 KB  |  220 lines
  1.                 SLURP - An advanced passive NNTP client
  2.                 =======================================
  3.  
  4.                              Version 1.05
  5.                       Written by Stephen Hebditch
  6.                      (C) 1992/3 TQM Communications
  7.                                     
  8.                                  ------
  9.  
  10. Slurp is an advanced passive NNTP client for UNIX. It will connect to a
  11. remote NNTP server and retrieve articles in a specified set of Usenet
  12. newsgroups that have arrived after a particular date (typically the
  13. last time it was invoked) for processing by your local news system. It
  14. replaces nntpxfer from the NNTP 1.5.11 reference implementation and
  15. nntpget from the INN distribution.
  16.  
  17.  
  18. The Feature List.
  19.  
  20. - No restriction on the number of newsgroups that can be retrieved in a
  21.   session. The client does a series of NEWNEWS requests if necessary to
  22.   build up a list of articles which need to be retrieved from the
  23.   server.
  24.  
  25. - Compatible with C News and INN.
  26.  
  27. - No lost articles due to unsynchronised clocks. By default, the time
  28.   for the next NEWNEWS is set by a call to the tcp time service on the
  29.   remote machine. This fixes a problem in nntpxfer and nntpget where
  30.   articles can be missed if the clock on the server is behind that on
  31.   the client.
  32.  
  33. - Faster article throughput. If configured to do so, slurp stacks up
  34.   the next article request before the current article is received,
  35.   decreasing the total article transfer time by around 30%. Unlike
  36.   nntpget, article batches can be written to the rnews spool directory
  37.   for processing with 'rnews -U' later, rather than being offered to
  38.   innd in turn. When used with C News, batches are written to the
  39.   in.coming directory. This provides a big speedup over nntpxfer which
  40.   created a new pipe to rnews for each article, lowering the transfer
  41.   speed and increasing the load on the client machine. These speed
  42.   improvements are of most use to the growing number of people
  43.   retrieving news over a dialup SLIP/PPP connection.
  44.  
  45. - Error recovery. In the event of an error occurring while articles are
  46.   being fetched, the message IDs of unretrieved articles are dumped to
  47.   a file. The next session can then retrieve the remaining articles
  48.   without having to restart from the previous start time.
  49.  
  50. - Easy configuration.
  51.  
  52.   slurp.sys defines which groups you wish to get from which server in a
  53.   similar way to the normal C News sys file, e.g.
  54.  
  55.     news.demon.co.uk:demon.*,!demon.msdos.announce,uk.*,\
  56.     !uk.net.maps/world,uk
  57.  
  58.   slurp.<hostname> contains the time to be used for the NEWNEWS request
  59.   at each server.
  60.  
  61.   The newsgroups list, start time and distributions can be overridden
  62.   on the command line. There are also settings to enable debugging
  63.   output, prevent writing the time for the next NEWNEWS to
  64.   slurp.<hostname>, issue a 'MODE READER' command to switch innd to
  65.   nnrpd, not dump unfetched message IDs in the event of an error, and
  66.   use the local time for the next NEWNEWS rather than the time at the
  67.   server.
  68.  
  69. - Support for the NNTP simple authorisation protocol.
  70.  
  71. - Logging to syslog of the number of new, missing and duplicate
  72.   articles at the end of a session plus, if required, the transfer
  73.   speed of the article fetching stage.
  74.  
  75. - Independent of the NNTP 1.5.11 code.
  76.  
  77. Slurp was written in ANSI C under Dell's SVR4/386, but ports easily to
  78. SunOs 4.x, Linux, BSDI BSD/386, HPUX and most other recent versions of
  79. UNIX.
  80.  
  81.  
  82.  
  83. CONTENTS
  84. --------
  85.  
  86. In this archive you should have the following files:-
  87.  
  88. HISTORY        How we got from there to here.
  89. Makefile    The Makefile (yes, really!)
  90. README        What you're reading now
  91. articles.c    Routines for reading articles and batching them up
  92. conf.h        Compilation configuration file
  93. fakesyslog.c    Fake version of syslog for those without
  94. fakesyslog.h    Definitions needed for the above
  95. history.c    Routines to open and interrogate the news history file
  96. misc.c        Miscellaneous routines
  97. newnews.c    Routines to retrieve new message ids from the server
  98. nntp.h        Definitions of nntp response codes
  99. slurp.1        Slurp manual page
  100. slurp.c        Main program
  101. slurp.h        Definitions used by everything
  102. slurp.sys    Configuration file for groups to take from a server
  103. sockets.c    Server interface routines
  104. space.c        Determines space available on news disk
  105. time.c        Retrieves current time at remote server
  106.  
  107.  
  108.  
  109. COMPILATION AND INSTALLATION
  110. ----------------------------
  111.  
  112. 1. Edit conf.h to reflect your reflect your local configuration. This
  113. file contains full details about each item that you may need to change.
  114.  
  115. 2. Edit Makefile. If you have not installed dbz.h in /usr/include then
  116. you will need to add -Ipathname to CFLAGS so that the compiler does a
  117. search of the directory where it can be found. LIBS will need to
  118. contain entries to pick up the dbz library and possibly the sockets
  119. library depending on your system. If you don't have syslog then you
  120. will need to uncomment the FAKESRC and FAKEOBJ lines.
  121.  
  122. 3. Type 'make' and hopefully you will get the slurp executable.
  123.  
  124. 4. Copy slurp to wherever it is that you store your news binaries.
  125.  
  126. 5. Copy slurp.sys to whichever location you selected for it in conf.h.
  127.  
  128. 6. Copy the manual page to wherever you keep your manual pages.
  129.  
  130.  
  131.  
  132. QUICK START
  133. -----------
  134.  
  135. The slurp manual page contains full details on how to operate slurp. As
  136. a quick start all you need to do is:-
  137.  
  138. 1. Edit slurp.sys to set the hostname of the server you wish to connect
  139. to for retrieving articles and the groups you wish to receive.
  140.  
  141. 2. Edit slurp.<hostname> and enter a single line containing the time a
  142. couple of days previously, say, in 'YYMMDD HHMMSS' format.
  143.  
  144. 3. Run 'slurp <hostname>' and sit back while the articles flood into
  145. your local news system.
  146.  
  147. If you are running C News, then the next time that newsrun is invoked
  148. from cron, the articles in the in.coming directory will be added to the
  149. news system.
  150.  
  151. If you are running INN and do not have RNEWS defined, then it will be
  152. necessary to run 'rnews -U' to have the files from the rnews spool
  153. directory processed by the news system. If RNEWS is defined then they
  154. will be piped to innd as they arrive - doing this will lower the speed
  155. at which articles are transferred from the remote server.
  156.  
  157. Patches for the NNTP 1.5.11 server are available on request which
  158. implement caching of article locations during a NEWNEWS so that a
  159. further access of the history file is not required when an article is
  160. retrieved. I hope to have an equivalent patch available for INN soon.
  161.  
  162.  
  163.  
  164. CONDITIONS OF USE
  165. -----------------
  166.  
  167. The Slurp package and individual code as detailed is Copyright 1992/3
  168. TQM Communications, BCM Box 225, London, WC1N 3XX. All rights reserved.
  169.  
  170. This package may be freely distributed provided the following
  171. conditions are met. The files detailed in the contents section of this
  172. file must all be included. No charge, other than basic online charges
  173. or media costs, may be levied. You are permitted to make alterations to
  174. the code for your own personal use, but please feed back any bug fixes
  175. or enhancements to us so they may be included in any future releases.
  176.  
  177.  
  178.  
  179. DISCLAIMER
  180. ----------
  181.  
  182. TQM Communications makes no warranty of any kind in respect to this
  183. documentation and the software described. The user assumes any risk as
  184. to the quality and performance of this product. In no event will TQM
  185. Communications be liable for direct, indirect, incidental or
  186. consequential damages arising from any defect in the performance and
  187. use of this product.
  188.  
  189. All trademarks acknowledged.
  190.  
  191.  
  192.  
  193. ACKNOWLEDGEMENTS
  194. ----------------
  195.  
  196. The original inspiration for slurp came from nntpxfer, written by Brian
  197. Kantor. The article batching code is inspired by batch.c in the NNTP
  198. 1.5.11 package, written by Stan Barber and 'based on work by Henry
  199. Spencer and Geoff Collyer'. The fakesyslog code is taken from the NNTP
  200. 1.5.11 package where it is credited to John Robert LoVerso and Paul
  201. McKenny. The space code to determine whether there is enough space on
  202. the news disk was originally taken from the NNTP 1.5.11 package where
  203. it is credited to Stan Barber, Tad Guy, Chris Jepeway and Tom Lane.
  204. Regular expression expansion courtesy of Nick Lai. Network knowledge
  205. thanks to W. Richard Stevens, author of the most readable UNIX books
  206. around. For bug fixing, porting and enhancement ideas, thanks go to Tim
  207. Rylance, Pete Bentley, Stefan Schwarz, David Clunie and David Boyce.
  208.  
  209.  
  210.  
  211. CONTACT INFORMATION
  212. -------------------
  213.  
  214. All comments, bug reports, bug fixes, etc. should be sent to
  215. steveh@orbital.demon.co.uk. I'm also available for consultancy work if
  216. you want help in getting news and mail working.
  217.  
  218.  
  219. ---- END OF DOCUMENTATION
  220.