home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Database / BB-MCF41.LZX / McFiler4.1 / Tools / deaf / deaf.doc next >
Encoding:
Text File  |  1996-02-23  |  5.4 KB  |  144 lines

  1.  
  2.                            dP                   .8888b
  3.                            88                   88   "
  4.                      .d888b88 .d8888b. .d8888b. 88aaa
  5.                      88'  `88 88ooood8 88'  `88 88
  6.                      88.  .88 88.  ... 88.  .88 88
  7.                      `88888P8 `88888P' `88888P8 dP
  8.  
  9.  
  10.                DEAF - Description Extracting And Filenoting
  11.                              (AmiNet oriented)
  12.  
  13.             By Manuel Giorgini (mgiorgin@dsi.unive.it) in 1996
  14.  
  15.  
  16. *** Disclaimer
  17.  
  18. Briefly: (1) this program comes with no warranty.
  19.          (2) if your HD burns (or stuff like that), I won't accept
  20.              any responsibility.
  21.          (3) I can only guarantee that this program will occupy disk space
  22.              and (maybe) some memory.
  23.  
  24. This program is CryWare.  That is, if you like it and you decide it's worth
  25. being used, you're morally obliged to open the window and speak aloud what
  26. you think about it, in a language of your choice ;)
  27.  
  28. And BTW if you leave me an EMail with your comments/bugreports/threats/thanks
  29. or whatever, I'll send you the complete sourcecode in Amiga E (it's so
  30. easy to write down it.  But maybe it can still be useful to someone, just
  31. to laugh sometime, or to have something to read in the bathroom :)
  32.  
  33. My address is mgiorgin@dsi.unive.it
  34.  
  35.  
  36. *** Prologue
  37.  
  38. First of all: Sorry for my bad command of english language.
  39.  
  40. Hi!
  41.  
  42. I run a BBS, and as many other sysops, I like to collect files and put them
  43. at my users' disposal.  Recently (well, not so recently :) I started
  44. leeching megabytes over megabytes of stuff from the AmiNet sites, and moved
  45. all my downloads into my file areas.  Soon I started getting bored of
  46. typing all the filenotes by hand, and after having looked (with no result)
  47. for a fitting utility, I worked on my own.  Thus, DEAF was born.
  48.  
  49.  
  50. *** What is this program for?
  51.  
  52. DEAF will scan an archive, extract the description from inside it, and link
  53. it as a comment for that file.  Suppose you have downloaded "foo.lha" and
  54. you have noticed that it contains "foo.readme":  DEAF will get the
  55. "Short:" line from foov103.readme (or whatever line else) and will put it
  56. as a filenote on "foo.lha" (without the trailing "Short:" and blanks).
  57.  
  58. DEAF will recognize LHA, LZX and ZIP archives, and will operate
  59. successfully with all of them, provided you have LhA, LZX and UnZip in your
  60. path (this is extremely important!); evaluation versions are OK too.  Arj
  61. is not supported simply because it would have taken a whole different
  62. algorithm to work.
  63.  
  64. Maybe such an utility is already existing, but I hadn't been able to find
  65. it.  I found a similar utility, but it required the .readme file to be
  66. already unarchived and in the same directory as the archive file, and this
  67. is rather annoying.  The .readme file could be nested into subdirectories
  68. in the archive structure, so a manual extraction might be very unhandy and,
  69. even worse, difficult to insert in a script.
  70.  
  71.  
  72. *** Syntax
  73.  
  74. This program works via CLI/Shell only.  Nevertheless, it has been developed
  75. for script purpose.
  76.  
  77. 1.Work:> deaf ?
  78. FILE/A,P=PATTERN/K,K=KEYWORD/K,T=TEMPFILE/K,Q=QUIET/S:
  79.  
  80. Where:
  81.  
  82. FILE     - is the Archived (LhA, LZX, ZIP) file you'd like to comment.
  83.            No wildcards allowed (but you can still use SPat, or a list
  84.            LFORMAT).
  85.            DEAF will automatically recognize the compression type basing on
  86.            the file extension and launch the appropriate command.
  87.  
  88. PATTERN  - is the pattern of the file that contains the description
  89.            (default: *.readme). When more than one file is found, DEAF will
  90.            scan the first only.
  91.  
  92. KEYWORD  - is the word (or part of) immediately previous to the description
  93.            string (default: 'hort:'). No wildcards allowed here too, sorry.
  94.            Search is CASE SENSITIVE, therefore pay attention.
  95.            When more than one string is matched in the file, DEAF will get
  96.            the first only.
  97.            BTW, you can insert "uthor:" or "ploader:" here; guess what it would
  98.            produce... :)
  99.  
  100. TEMPFILE - Is the temporaneous workfile for DEAF. It will be (hopefully!)
  101.            deleted during the operation, so you can definitely forget about
  102.            it. (default: 'ram:deaf_temp')
  103.  
  104. QUIET    - Will avoid any message printing; DEAF will anyway still return an
  105.            error code. Obviously there could still be a message printed, that
  106.            is the error relative to an eventual ReadArgs() failure :)
  107.  
  108. If you have DEAF in your path, try this:
  109.  
  110. 1.Work:> list >T:script dh0:comms/downloads/#?.??? LFORMAT "deaf %p%n QUIET"
  111. 1.Work:> execute t:script
  112.  
  113. voila!
  114.  
  115. For a quick check, try deaf with its very archive (provided the .readme
  116. file inside has not been deleted beforeward):
  117.  
  118. 1.Work:> deaf <path>deaf100.lha
  119.  
  120.  
  121. *** History
  122.  
  123. v1.00 - First version
  124. v1.01 - stuff (trust me, this version is better, it's just that I can't
  125.                explain efficiently in English what I have done :)
  126.  
  127.  
  128. *** Credits
  129.  
  130. Nobody helped me for the development of DEAF (it would have been worrying,
  131. for it's so simple :) but there is still someone I'd like to mention:
  132.  
  133. Gabriele Zaverio, Giuseppe Chillemi, and the whole FreakNet network;
  134. Claudio Mazzuco, Guido Vaccari, and all my points;
  135. Peter Van Den Broeck, for his friendship;
  136. The EFF, for his fight for the freedom of speech and privacy in the 'Net;
  137. James McOrmond, for his program JamMail (lightyears beyond TrapDoor :), and
  138. Oliver Wagner, for he accepted my catalog file for AmIRC :)
  139.  
  140. Last but not least, thanks to the Escom, and may our machine live a
  141. wonderful future with its new owner.
  142.  
  143.  
  144. EOF