home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-3.iso / Tools / usenet / NewsArchiver.README < prev    next >
Encoding:
Text File  |  1994-01-31  |  5.8 KB  |  148 lines
  1.  
  2. NewsArchiver.app
  3.  
  4. --------------------------------------------------------------------------------------------------- 
  5.                                    
  6. Ever wished you had an app that manages saved usenet
  7. articles, lets you read them  and search through them ?
  8.  
  9. Well, NewsArchiver.app is a step in that direction.
  10. It's not perfect (see below for things missing) but it only took a weekend to write 
  11. and has some nice features like:
  12.  
  13.     -     reads ascii files containing usenet articles, splits
  14.         the articles as records and saves them indexed in one   
  15.         archive
  16.       -    it swallows ascii files as found on ftp sites
  17.         containing postings, nfold and mbox directories which     
  18.         are treated as files (but read important remark below)
  19.     -     provides an easy interface for navigating in the archive
  20.     -     provides an easy interface for constructing queries
  21.     -     communicates with Mail.app 
  22.  
  23. and  some others. 
  24.  
  25. There's also a small unix tool called "archive" as a companion tool 
  26. to NewsArchiver. You can archive large ascii files with it in a terminal
  27. window. It only takes one argument: the name of the ascii file to be
  28. archived. "archive" and NewsArchiver cannot be used at the same time. 
  29. "archive" cannot build the archive file (in ~/.AppInfo/NewsArchiver). 
  30. To build the archive file simply start NewsArchiver.app and quit. 
  31.  
  32. ---------------------------------------------------------------------------------------------------
  33.  
  34. Note:
  35.     NewsArchiver is not FAT right now because I don't
  36.     know how to compile flex fat. I need a fat flex (fl.a)
  37.     library or a makefile that compiles flex fat.
  38.  
  39. ---------------------------------------------------------------------------------------------------
  40.  
  41. Why do I need it ?
  42.  
  43. For example I need to search through usenet  articles for tricks of the trade in programming 
  44. NXBrowsers. I download from a ftp site say all
  45. articles posted in Dec '93 in c.s.n.p. I open the file in Edit.app and 
  46. search for "browser"...Wait a minute, this is a simple way to do it.
  47.  
  48. Another way would be writing a scanner that sets markers in
  49. the file so that DataPhile.app can read the articles as records.
  50. You then have a cool commercial and supported program, can
  51. design your own interface for reading the articles, have multiple
  52.  views etc...
  53.  
  54. NewsGrazer itself gives you a possibility with the NewsFolders.
  55. You can index the NewsFolders with DigitalLibrarian
  56. and work with that. (There's NewsIndex on the ftp archives
  57. by Izumi Ohzawa). 
  58.  
  59. Ok, NewsArchiver gives you yet another alternative.
  60. I've written NewsArchiver primarly for finally doing something
  61. with the IXKit and learning about it.
  62.  
  63. ---------------------------------------------------------------------------------------------------
  64.  
  65. LICENSE
  66. NewsArchiver is PUBLIC DOMAIN !
  67. Everybody can copy and distribute NewsArchiver as often as he wants. 
  68. Commercial distribution is strictly forbidden without the permission of the author.
  69.  
  70. ---------------------------------------------------------------------------------------------------
  71.  
  72. WARRANTY
  73. There is no warranty whatsoever for NewsArchiver. 
  74. The entire risk of using the program lies with you.
  75.  
  76. ---------------------------------------------------------------------------------------------------
  77.  
  78. REMARK
  79. This release is beta. It probably has bugs (read below)
  80. but hey, see License and Warranty and don't expect to much. 
  81.  
  82. ---------------------------------------------------------------------------------------------------
  83.  
  84. IMPORTANT REMARK
  85. NewsArchiver needs perl in this version. It's only a small
  86. perl-script named ccat in the NewsArchiver.app bundle. 
  87.  
  88. Workaround if you don't want to install perl:
  89. - write your own ccat in your favorate unix tool (awk, sed...)
  90.   and insert it in the NewsArchiver.app directory (be sure
  91.   the name is the same)
  92.  
  93. ccat  concatenates the files which are passed as arguments
  94. and inserts a newline after each file.
  95. example:  "ccat  *  >   ~/tmp/test"  writes the contents of all
  96. files in the current directory into  ~/tmp/test.
  97. Plain unix cat does not insert a newline after a file and I only know
  98. how to do it in perl (which is great by the way).   
  99.  
  100. ---------------------------------------------------------------------------------------------------
  101.  
  102. KNOWN BUGS (READ THE WARRANTY AGAIN)
  103. - IXAttributeQuery does only text search so far, so
  104.   if you construct  a query with numbers (like the date)
  105.   it won't work. I didn't have time extending  IXAttributeQuery.
  106.   Maybe I will some day.
  107. - The Indexing Kit  seems to have problems with attributes
  108.   greater than 8K (like some article text is). I cannot consistently
  109.   reproduce this bug but I recommend not to delete your mbox and
  110.   nfold directories after you have added them to NewsArchiver.
  111.   You might still need them.
  112.  
  113. ---------------------------------------------------------------------------------------------------
  114.   
  115. ABOUT THE SOURCES
  116. This app is public domain and so naturally the sources
  117. are available. There's a little problem linked to this:
  118. I have a very tailored development  environment with
  119. lots of things in /LocalDeveloper, /usr/local/lib,...
  120. I could put everything in the project which means
  121. more work (ighh..). So if you are interested in the source
  122. let me know. I should warn you the code is not very
  123. pedagogical (no comments, a few hacks...).
  124.  
  125.  
  126. ---------------------------------------------------------------------------------------------------
  127.  
  128. Send suggestions and bug reports to:
  129.   
  130.      Uwe Hoffmann
  131.      
  132.      hoffmann@fzi.de
  133.  
  134. ---------------------------------------------------------------------------------------------------
  135.      
  136. Things you probably would love to have but are not 
  137. in NewsArchiver at the moment
  138.  
  139.     -     Life span for articles, articles that die vanish from the archive
  140.     -     Multi-Document (Multi-Archive) support
  141.     -     Separate threads for searching and adding new articles 
  142.     -     Communication of some sort with NewsGrazer
  143.     -   more attributes like the newsgroup and so on...
  144.       -  No bugs
  145.  
  146.  
  147.     
  148.