home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / tktools.zip / extract / extract.doc < prev    next >
Text File  |  1994-09-26  |  5KB  |  104 lines
  1. Usenet File Extractor Version 3.0
  2. (C)1994 Turgut Kalfaoglu <TURGUT@VM3090.EGE.EDU.TR>
  3.  
  4. SHAREWARE
  5. EXTRACT/MERGER package is shareware. Usage over two weeks requires a
  6. registration fee of $20 be sent to the author:
  7.  
  8.        Turgut Kalfaoglu
  9.        1378 Sokak 8/10
  10.        Alsancak, Izmir 35210
  11.        Turkey
  12.  
  13. I highly recommend that you register the associated software as well.
  14.  
  15.  
  16. HIGHLIGHTS
  17.   * Converts Usenet .binaries. group data directly into files you can use
  18.     such as .ZIP, .GIF, .JPG, .ARJ, etc.
  19.   * Retries files that have missing segments.
  20.   * Accepts files with up to 30 segments.
  21.   * Expires old segments.
  22.   * Easily customisable.
  23.   * Requires:  OS/2 2.x or 3.x with Rexx loaded
  24.                IBM TCP/IP (for DUMPGRP.EXE)
  25.                UUDECODE.EXE  (shareware or public domain)
  26.                FORALL.EXE    (shareware or public domain)
  27.                10 MB or more of disk space, depending on how much
  28.                news you receive at once.
  29.  
  30. INSTALLATION
  31.  
  32. You need three directories for this program. Although everything
  33. is configurable, here is how I have mine set up:
  34.   C:
  35.   |
  36.   +-- DOCS
  37.        +--- S
  38.             +---- PARTIAL
  39.  
  40. I recommend this hierarchical setup. In this case, put everything
  41. into DOCS (or somewhere on your PATH..), leave the other two blank.
  42. When DUMPALL terminates, you will have your binaries in the 'S' directory.
  43.  
  44. The package contains two .CFG files, EXTRACT.CFG and MERGER.CFG. These
  45. two need to be configured - simply use your text editor such as 'E' or
  46. 'EPM' to configure these files. If you have not used DUMPGRP.EXE before,
  47. you need to configure its configuration file as well - see its
  48. documentation. Examine and/or Edit DUMPALL.CMD file.
  49.  
  50. DESCRIPTION
  51.  
  52. This package will collect news from an NNTP server (from any .binaries.
  53. group) and extract the received information into files. Meaning, it will
  54. 'reconstruct' files sent in UUENCODE format, and in several pieces,
  55. automatically. It will keep the incomplete sections for 20 runs,
  56. attempting to complete the files at each run.
  57.  
  58. The package is run by DUMPALL.CMD that invokes each of the programs in
  59. the necessary order. First, the old incomplete sections are backed up
  60. into another file, and DUMPGRP.EXE is invoked. DUMPGRP.EXE will collect
  61. the "new news" from your NNTP server, and place them into a file, (by
  62. default, into "S.UUE") Then, S.UUE is processed by EXTRACT, which will
  63. split the files it finds in this file into its temporary "partials"
  64. directory, where segments of each file are kept. (Default:
  65. "/DOCS/S/PARTIAL"). Information on these files is also kept in a file
  66. called EXTRACT.SUM that has such trivia as filename,number of pieces,
  67. and the number of retries for this partial file. In other words,
  68. EXTRACT.SUM is like a fancy "DIR" for EXTRACT/MERGER package.
  69. To avoid problems, leave this file alone.
  70.  
  71. Extract will recognise three types of headers in the news items it
  72. scans:  BEGIN / END pairs are the first category: They are the surest to
  73. determine. Type two is 'CUT / blank' category: These messages contain
  74. the word 'cut' at the beginning of the message, and sometimes nothing at
  75. the bottom - it is normal to see the warning 'hit the separator' warning
  76. for such files. Type 3 contains either a 'Section...' at the start of
  77. the file, or nothing at all. Depending on how the file begins, it will
  78. expect it to end with one of these three. Even if they don't, your
  79. separator will save it from continuing onto the next file.
  80.  
  81. MERGER is the second step: It takes pieces found in the partials
  82. directory, and puts them together whenever possible. It will ignore
  83. others if segments are missing. Otherwise, it will create
  84. the resulting file, and delete the partial files. Merger attempts to
  85. produce a "clean" file with no blank lines, and no unnecessary headers.
  86.  
  87. (The list of files processed by EXTRACT are kept in EXTRACT.SUM. Normally
  88. it shouldn't be changed, except by EXTRACT and MERGER programs.)
  89.  
  90. Finally, the resulting files, characterised by their two-letter
  91. filetypes, are passed thru a UUdecoder which will convert the files to
  92. their binary form, and delete the two-letter version. It is normal to
  93. see warnings while UUDECODE runs - at least my version of it complains
  94. but creates good files.
  95.  
  96. LAST WORDS
  97.  
  98. Extracting news into files is an inexact science: I recommend that you
  99. report cases where EXTRACT/MERGER pair failed to process, or other
  100. problems you may notice with the software. As with any other software,
  101. I cannot be held liable for its behavior, but would be very grateful for
  102. suggestions and bug reports.
  103.  
  104.