home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / 4dizzy96.zip / 4dizzy.txt < prev    next >
Text File  |  1996-10-28  |  10KB  |  280 lines
  1. 4dizzy 0.96ß help file
  2.  
  3. The program 4dizzy is copyright (c) Olli Männistö 1995, 1996
  4.  
  5. Index:
  6.         DESCRIPTION
  7.         CONFIGURATION
  8.         COMMAND LINE PARAMETERS
  9.         SERIAL FILES
  10.         FILTERING
  11.         DOS CONSIDERATIONS
  12.         OS2 CONSIDERATIONS
  13.         REGISTRATION
  14.         LEGAL STUFF
  15.         AUTHOR
  16.         HISTORY
  17.  
  18.  
  19. DESCRIPTION
  20.  
  21. 4dizzy is an utility for importing information from file_id.diz files found
  22. in most distributed archives into 4dos/4os2 file descriptions -
  23. Due to the 511byte-limit in description, only first 12 lines are used.
  24. 4dos/4os2 stores the description info into a hidden file descript.ion, so you
  25. may remove any descriptions simply by deleting this file.
  26.  
  27. 4dizzy.exe is the dos-executable, 4dizzy2.exe is the OS/2 executable.
  28.  
  29. 4dizzy will process user-defined archives, while any descriptions for
  30. any files are preserved. 4dizzy will put a marker description for
  31. new archive-files it cannot find a file_id.diz-file for -
  32. Any previously processed files are ignored by default.
  33.  
  34.  
  35. CONFIGURATION
  36. You should put line
  37. Descriptionmax  =       511
  38. into your 4dos.ini/4os2.ini file, making it possible to use 511 character
  39. descriptions.
  40.  
  41. 4dizzy.ini or 4dizzy2.ini is used to store information about extraction
  42. programs 4dizzy is to use, eg. unzip.exe. It must reside in the same
  43. directory with 4dizzy executable.
  44. 4dizzy currently supports 16 different archive programs, which should be
  45. enough for anyone..
  46.  
  47. The format is
  48. executable name, file extension, parameter 1, parameter 2, parameter 3
  49. All options are separated by spaces, make sure there are no trailing 
  50. spaces or extra spaces between options.
  51.  
  52. Parameters are optional, and are intended for 'shut up' options such
  53. as -qq in unzip.exe and for a possible 'extract' command in some archivers,
  54. or whatever else is approciate.
  55.  
  56. 4dizzy invokes the executable with
  57. <executable> <param1> <param2> <param3> <archivename> <file_id.diz>
  58. if your program cannot handle this format, too bad. 
  59.  
  60. Example 4dizzy.ini-file:
  61. UNZIP.EXE ZIP -qq -C
  62. RAR.EXE RAR e -c-
  63.  
  64. If you omit path, 4dizzy will look for the file along the path.
  65. 4dizzy will include full path info with the executable name so there's no 
  66. performance penalty with this method.
  67.  
  68. Make sure dos can't see the OS/2 version of unzip and
  69. vice versa.
  70.  
  71.  
  72. 4dizzy/2 has been tested and should work with:
  73.  
  74. OS/2 Warp, OS/2 Warp Connect and OS/2 Merlin
  75. Any version of OS/2 since 2.0 should be able to run 4dizzy/2.
  76.  
  77.  
  78. 4dizzy/D has been tested and should work with:
  79.  
  80. OS/2 Warp, OS/2 Warp Connect and OS/2 Merlin
  81. (in VDM)
  82. PC-dos 7.0
  83. Ms-dos 6.22
  84.  
  85. Operation under Microsoft Windows'95 (tm) has not been tested and any
  86. attempt to run 4dizzy/D from Microsoft Windows'95 (tm) could cause
  87. unpredictable results.
  88.  
  89.  
  90. COMMAND LINE PARAMETERS
  91. Usage: 4DIZZY.EXE [-h|-?] [-afnilt]
  92. h, ?   Online help.
  93. a      process All - No checking for serial files.
  94. f      Filter - Filters lines without n number of alphabetical characters
  95. n      [1-9] - Required min. number of alphabetical characters. Default: 4
  96. i      Ignore - Ignores existing descriptions, deleting them.
  97. l      include Last - Full file_id.diz for first and last file in series.
  98. t      Touch - Sets date from file_id.diz for the archive file.
  99.  
  100. example: 4dizzy -tfi6
  101.  
  102.  
  103. SERIAL FILES
  104. 4dizzy has a capability to detect whether an archive is a part of series -
  105. So, if you've got files koolmpg1.zip->koolmpg9.zip, 4dizzy will use
  106. one-line description for the last 8 files and use full description for the
  107. first file in series only.
  108. This feature is not too useful without alphabetically sorted directories,
  109. so you ought to use parameter /ON with dir. NB, current 4dos version seems
  110. to show alphabetically sorted dir-list by default.
  111. HPFS maintains files sorted by default.
  112.                        
  113. This feature *should* work with practically unlimited amount of parts long as
  114. the ordering is numerical. This means Kitty_Yung.mpg.[0-1000].zip should give
  115. full description only for the first packet.
  116.  
  117. Alphabetical serialization has limited support, eg. Z->AA transition
  118. is not recognized.
  119.  
  120. You may optionally use full description for both first and last file in
  121. series.
  122.  
  123.  
  124. FILTERING
  125. 4Dizzy can optionally filter out lines from file_id.diz which do not
  126. contain enough alphanumerical characters - This is meant to weed out the
  127. cute ascii-art logos found in many file_id.diz files.
  128.  
  129. By default this feature filters out lines without at least 4 characters.
  130.  
  131.  
  132. DOS CONSIDERATIONS
  133. 4Dizzy now uses straightforward memory allocation routine, so you need
  134. at least as much free *base* memory as the finished descript.ion file, plus
  135. about 64kB for various buffers.
  136.  
  137. In practice you should be able to handle 1000+ files in worst-case scenario
  138. with 600kB free base memory, so I can't see anyone running out of memory
  139. anyway. In any case, 4dizzy reports the amount of free memory after execution
  140. so you can tell if you're going to run out. As executables need some RAM
  141. to run (unzip.exe will run on <64k) 4dizzy should not crash on low memory
  142. situation as there will not be any more new file_di.diz files to store..
  143.  
  144. You should use a disk-caching program with write-cache capability as this
  145. will speed up 4dizzy file processing tremendously.
  146.  
  147. Note that while unzip386 claims to be faster than the real-mode version,
  148. for purposes of 4dizzy it is actually about 20% slower than normal
  149. unzip.
  150.  
  151. Pkunzip may be used instead of unzip and there is no practical performance
  152. difference between them, but pkunzip insists on showing zipfile comments,
  153. which looks messy in my opinion.
  154.  
  155.  
  156. OS/2 CONSIDERATIONS
  157. Since HPFS reserves by default more screen-estate for file information, no
  158. descriptions are shown -
  159. With /Z parameter dir will show descriptions, while truncating any long
  160. filenames into 13 characters.
  161. Same goes for CD-ROM's.
  162.  
  163. example:DIR /ZON
  164.  
  165. 4dizzy/2 supports long filenames on HPFS partitions.
  166.  
  167. The amount of files 4dizzy/2 can process is limited only by the amount of
  168. memory provided by OS/2 ie. enough.
  169.  
  170. 4dizzy/2 might work with ext2ifs driver on linux partitions, but I have
  171. not had the chance to personally verify this.
  172.  
  173.  
  174. REGISTRATION
  175. 4dizzy is cardware.
  176.  
  177. I would appreciate it if you would send me a postcard if you find 4dizzy
  178. useful. Send a dirty postcard if you can get one.
  179.  
  180.  
  181. LEGAL STUFF
  182. 4dizzy is provided *as is*, author takes no responsibility whatsoever about
  183. any damage 4dizzy might cause, even if used according to instructions. You
  184. use it at your own risk.
  185.  
  186. The author retains copyright to the 4dizzy program, so you may not legally
  187. use it for commercial purposes without permission.
  188. Otherwise, you may use 4dizzy however you'd like and copy it around as much
  189. as you'd like, as long as the 4dizzy.txt file is included with the copy.
  190.  
  191. Source is available on request - BC++ 3.1 for 4dizzy/D, watcom for 4dizzy/2.
  192. You may modify and re-distribute 4dizzy as long as you give me credit for
  193. sources and do not sell 4dizzy for profit.
  194. 4Dizzy/2 is a straight port of 4Dizzy/D, using standard C library functions
  195. instead of OS/2 API calls.
  196.  
  197. AUTHOR
  198. 4dizzy is written by Olli Männistö, currently of the Espoo-Vantaa Institute
  199. of Technology - You can contact me at ollittm@evitech.fi until 1999 at least.
  200.  
  201. READ THIS FILE COMPLETELY BEFORE CONTACTING ME!
  202. I have many cheap insults reserved for people asking about things explained
  203. in this document.
  204.  
  205. I am not currently interested in adding any additional features into
  206. 4dizzy, so unless you think you have found a bug, don't bother me about
  207. 4dizzy. Unless, of course, you wish to say what a great app it is ;-)
  208.  
  209. Any bugs will be fixed as time permits.
  210.  
  211. Postcards can be sent to:
  212. Olli Männistö
  213. Kirjanpitäjänkuja 4 A11
  214. 02770 Espoo
  215. Finland
  216.  
  217.  
  218. HISTORY
  219. 4dizzy 1.00 is a complete rewrite, using no code from version 0.42.
  220.  
  221. New since 0.42
  222. OS/2 version
  223.  
  224. 4dizzy.ini/4dizzy2.ini - You can define what file extensions and
  225. (de)compression apps you want to use.
  226.  
  227. Filtering - You can specify how many alphanumerical characters a file_id.diz
  228. line must contain to be included in description.
  229.  
  230. Serialization - 4dizzy now attempts to recognize multi-part archives
  231. and will use full file_id.diz only for the first file.
  232.  
  233. Touch - 4dizzy can optionally set archive date/time from file_id.diz date.
  234.  
  235. Any existing descriptions for any files are preserved.
  236.  
  237. Optionally ignores old description-file.
  238.  
  239. New command-line parameter format.
  240.  
  241. Some features have been fixed - Failed sometimes to to kill file_id.diz,
  242. would not always extract file_id.diz, etc..
  243.  
  244. 0.51ß
  245. [NEW] Touch implemented
  246. 0.52ß
  247. [FIX] If descript.ion file did not exist, 4dizzy would not work.
  248. [FIX] Exit-on-error did not work as intended.
  249. 0.9ß
  250. [NEW] Serialization implemented
  251. 0.91ß
  252. [NEW] Implemented l-switch for including full description for last file in
  253.       series, also.
  254. 0.92ß
  255. [FIX] Several memory allocation problems fixed.
  256. [FIX] l-switch did not work for last file in directory.
  257. 0.93ß
  258. [FIX] Multiple memory allocation problems fixed.
  259. [NEW] OS/2 executable (watcom)
  260. 0.94ß - First public beta
  261. [NEW] 4dizzy/D should now be able to handle extensions shorter than 3
  262.       characters
  263. [NEW] You can now define 16 files in the ini-file, with 3 separate
  264.       parameters, max parameter-lenght increased to 9 chars.
  265. [FIX] -i parameter could cause problems.
  266. 0.95ß
  267. [NEW] Implemented filtering
  268. 0.96ß
  269. [CHN] All spaces in file_id.diz are now converted into ascii 255, so no
  270.       wordwrap will occur and I can use 40chr/line format for description.
  271.       This feature was in 4dizzy 0.42 but was missing from 0.50->0.95
  272.  
  273. Unless there are any bugs in this version, I will release it as 4dizzy
  274. 1.0 in near future.
  275. Since watcom does not support "detach" unlike borlandc, quiet-feature for
  276. 4dizzy/2 has been dropped.
  277.  
  278. Any new features will be implemented in exchange of nubile sisters of
  279. at least age of consent (16 in Finland) ;-)
  280.