home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 6 File / 06-File.zip / fbd099.zip / fbdiff.INF (.txt) < prev    next >
OS/2 Help File  |  1995-11-15  |  14KB  |  367 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Introduction ΓòÉΓòÉΓòÉ
  3.  
  4. FBDIFF (File Base DIFFerencer) is a monitoring program that tracks changes made 
  5. to a given set of files between its executions.  This program can be used for 
  6. virus detection (although I recommend that this program not be used as your 
  7. only means of detecting viruses) and poor-man's audit trails for networks 
  8. (trace changes in private directories between each user's logon).  There are 
  9. surely many more uses for FBDIFF than I have thought of. 
  10.  
  11.  
  12. ΓòÉΓòÉΓòÉ 2. Contact Information ΓòÉΓòÉΓòÉ
  13.  
  14. Contact information: 
  15.  
  16. Internet email: csbh@tcsconcordia.tor250.org 
  17. Fidonet: C. Henshaw 1:250/820 
  18. Snailmail: 
  19.  
  20.    Mr C. Henshaw, 
  21.    48 Millwood Road, 
  22.    Toronto, Ontario 
  23.    Canada.  M4S-1J7. 
  24.  
  25. Don't bother looking in the phonebook for my number.  I'm not listed. 
  26.  
  27.  
  28. ΓòÉΓòÉΓòÉ 3. Requirements ΓòÉΓòÉΓòÉ
  29.  
  30. FBDIFF requires the following minimum configuration: 
  31.  
  32. o A computer running OS/2 2.0 or greater. 
  33.  
  34. o 4MB RAM.  8MB is recomended for the extended version. 
  35.  
  36. o At least 500KB of free disk space. 
  37.  
  38. o HPFS long file names are supported but not required. 
  39.  
  40.  
  41. ΓòÉΓòÉΓòÉ 4. Legal Issues ΓòÉΓòÉΓòÉ
  42.  
  43. The FBDIFF package is Copyright 1995 C. Henshaw.  All rights reserved. 
  44.  
  45. OS/2 is a trademark of the IBM Corporation. 
  46.  
  47. UNIX is a trademark of AT&T. 
  48.  
  49. Macintosh is a trademark of Apple Computers. 
  50.  
  51. Netscape, The Stentor Group, Bell Canada, Roger's Communications and their 
  52. agents and employees may not use this program without a special agreement. 
  53.  
  54. FBDIFF is supplied as is.  The author disclaims all warranties, either 
  55. expressed or implied, including, without limitation, the warranties of 
  56. merchantability and of fitness for any purpose.  The author assumes no 
  57. liability for damages, even if the author is aware of a problem, direct or 
  58. consequential, which may result from the use of FBDIFF.  This includes loss of 
  59. data, profit or other damages resulting from the use of FBDIFF. 
  60.  
  61. FBDIFF is not even guaranteed to take up space on your disk.  You may use this 
  62. program at your own risk. 
  63.  
  64.  
  65. ΓòÉΓòÉΓòÉ 5. Getting Started ΓòÉΓòÉΓòÉ
  66.  
  67. Getting started is easy.  All you need to do is load FBDIFF.CFG into your 
  68. favorite text editor and edit it to suit your needs.  The provided FBDIFF.CFG 
  69. is an example only.  Refer to the next section for information on all supported 
  70. configuration keywords. 
  71.  
  72.  
  73. ΓòÉΓòÉΓòÉ 6. FBDIFF.CFG ΓòÉΓòÉΓòÉ
  74.  
  75. FBDIFF.CFG is a human-readable text file that controls FBDIFF's operation.  You 
  76. can edit this file with any standard text editor, such as OS/2's Editor or EPM. 
  77.  
  78. The Type: footer on every keyword in this reference tells you if the keyword is 
  79. optional or required for the operation of FBDIFF and how many times it may be 
  80. used.  Depending on the keyword, uses over the maximum number will result in 
  81. prior keywords of the same type being ignored or an error message being 
  82. generated. 
  83.  
  84.  
  85. ΓòÉΓòÉΓòÉ 6.1. CRCSCAN ΓòÉΓòÉΓòÉ
  86.  
  87. Syntax: CRCSCAN <mask> 
  88.  
  89. Directs FBDIFF to calculate CRCs for all files matching the specifed include 
  90. mask. 
  91.  
  92. The mask structure is slightly different from the standard OS/2 wildcard 
  93. system.  FBDIFF's masks are compared as text masks, so CRCSCAN does not have 
  94. any knowledge of the path system.  This is not a bug, but a feature.  The mask 
  95. structure is much more flexible, so, for example, large groups of files may be 
  96. included for CRC calculation in all directories in only one CRCSCAN. 
  97.  
  98. Note:  This keyword will slow FBDIFF's operation considerably. 
  99.  
  100. Example: 
  101.  
  102. CRCSCAN *.exe 
  103.  
  104. Directs FBDIFF to calculate CRCs for all .EXE files in it's scanlist. 
  105.  
  106. Type:  Optional.  Maximum 1 
  107.  
  108.  
  109. ΓòÉΓòÉΓòÉ 6.2. DBNAME ΓòÉΓòÉΓòÉ
  110.  
  111. Syntax: DBNAME <filename> 
  112.  
  113. Directs FBDIFF to store its file index in a file other than FBDIFF.IDX.  This 
  114. keyword is most useful in multi-user environments where each user may wish to 
  115. maintain different scanlists and index. 
  116.  
  117. Example: 
  118.  
  119. DBNAME H:\FBDIFF\user01.idx 
  120.  
  121. Directs FBDIFF to store its file list in H:\FBDIFF\user01.idx instead of 
  122. FBDIFF.IDX. 
  123.  
  124. Type:  Optional.  Maximum 1 
  125.  
  126.  
  127. ΓòÉΓòÉΓòÉ 6.3. DUPEDETECT ΓòÉΓòÉΓòÉ
  128.  
  129. Syntax: DUPEDETECT <criteria> 
  130.  
  131. Sets the criteria which FBDIFF will use to determine if two given files are 
  132. duplicates of each other. Any combination of the following keywords may be used 
  133. to define a criteria: name, size, date, time, attr and crc.  The keywords are 
  134. not case sensitive. 
  135.  
  136. Example: 
  137.  
  138. DUPEDETECT name size date time 
  139.  
  140. Directs FBDIFF to consider files with the same name, size, date and time to be 
  141. duplicates. 
  142.  
  143. Type:  Optional.  Maximum 1 
  144.  
  145.  
  146. ΓòÉΓòÉΓòÉ 6.4. DUPESCAN ΓòÉΓòÉΓòÉ
  147.  
  148. Syntax: DUPESCAN 
  149.  
  150. Enables duplicate scanning.  If this option is present in FBDIFF.CFG, FBDIFF 
  151. will find all duplicates in the scanlist.  DUPESCAN also switches EXCLUDE from 
  152. change exclusions to duplicate exclusions.  All occurrences of EXCLUDE *above* 
  153. DUPESCAN prevent files from being monitored for removal, addition or changes. 
  154. All EXCLUDE's below DUPESCAN prevent files from being reported as duplicates. 
  155. The same wildcard rules apply to duplicate EXCLUDE as to monitor EXCLUDE. 
  156. Duplicate EXCLUDEs are stored in a different internal table, so you will always 
  157. have 64 duplicate EXCLUDEs available even if you have used all 64 monitor 
  158. excludes. 
  159.  
  160. Example: 
  161.  
  162. DUPESCAN 
  163.  
  164. Directs FBDIFF to scan for duplicates in the scanlist and to consider all 
  165. EXCLUDE entries after the current line to be duplicate-report excludes. 
  166.  
  167. Type:  Optional.  Maximum 1 
  168.  
  169.  
  170. ΓòÉΓòÉΓòÉ 6.5. EXCLUDE ΓòÉΓòÉΓòÉ
  171.  
  172. Syntax: EXCLUDE <mask> 
  173.  
  174. If occurring before before the DUPESCAN keyword, this keyword directs FBDIFF to 
  175. exclude a given file or group of files from monitoring for changes, addition or 
  176. deletion.  If occurring after the DUPESCAN keyword, this keyword directs FBDIFF 
  177. to ignore a file or group of files in duplicate file searches. 
  178.  
  179. The mask structure is slightly different from the standard OS/2 wildcard 
  180. system.  FBDIFF's masks are compared as text masks, so EXCLUDE does not have 
  181. any knowledge of the path system.  This is not a bug, but a feature.  The mask 
  182. structure is much more flexible, so, for example, large groups of files may be 
  183. excluded from monitoring across all directories in only one EXCLUDE. 
  184.  
  185. Examples: 
  186.  
  187. EXCLUDE C:\*\FILES.BBS 
  188.  
  189. Excludes all FILES.BBS files on drive C: from monitoring. 
  190.  
  191. DUPESCAN 
  192.  
  193. EXCLUDE C:\*\FILES.BBS 
  194.  
  195. Excludes all FILES.BBS files from duplicate scanning. 
  196.  
  197. Type:  Optional.  Maximum 64 for changes, with an aditional 64 for duplicates. 
  198.  
  199.  
  200. ΓòÉΓòÉΓòÉ 6.6. REPORT ΓòÉΓòÉΓòÉ
  201.  
  202. Syntax: REPORT <filename> 
  203.  
  204. Directs FBDIFF to write a text file containing a report of changes and 
  205. duplicates (if enabled, see DUPESCAN) to the specified file.  The file will be 
  206. overwriten every time FBDIFF is run. 
  207.  
  208. Example: 
  209.  
  210. REPORT G:\NETWORK\LOGS\DIFFLIST 
  211.  
  212. Directs FBDIFF to write a human-readable list of all files that have been 
  213. added, deleted or modified since FBDIFF was last run.  If duplicate scanning is 
  214. enabled (See EXCLUDE), all found duplicates will also be listed. 
  215.  
  216. Type:  Optional.  Maximum 1 
  217.  
  218.  
  219. ΓòÉΓòÉΓòÉ 6.7. REPORTWIDTH ΓòÉΓòÉΓòÉ
  220.  
  221. Syntax: REPORTWIDTH <width> 
  222.  
  223. Sets the column width for FBDIFF's text report.  The default screen width is 80 
  224. columns.  All data is still displayed in narrow report widths, but it may take 
  225. more than one line to display it.  The default value is 132. 
  226.  
  227. Example: 
  228.  
  229. REPORTWIDTH 120 
  230.  
  231. Directs FBDIFF to write its human-readable report for 120 column display. 
  232.  
  233. Type:  Optional.  Maximum 1 
  234.  
  235.  
  236. ΓòÉΓòÉΓòÉ 6.8. SCAN ΓòÉΓòÉΓòÉ
  237.  
  238. Syntax: SCAN <path\fmask> 
  239.  
  240. Directs FBDIFF to scan the specified drive and path for modified files.  If 
  241. duplicate scanning is enabled (see DUPESCAN), FBDIFF will also scan for 
  242. duplicates in the specified drive and path. 
  243.  
  244. Example: 
  245.  
  246. SCAN C:\*.* 
  247.  
  248. Directs FBDIFF to scan all files (unless EXCLUDEd) for changes or duplicates 
  249. (if enabled). 
  250.  
  251. Note:   FBDIFF will read only 4096 files in the unregistered version.  Be sure 
  252.        to SCAN 4096 or fewer files.  EXCLUDEs do not remove files from the scan 
  253.        list. 
  254.  
  255. Type:  Required.  Maximum 26 
  256.  
  257.  
  258. ΓòÉΓòÉΓòÉ 7. Command Line Options ΓòÉΓòÉΓòÉ
  259.  
  260. FBDIFF supports only one command line option - '@.'  The @ directive is used to 
  261. specify a different configuration file than the default FBDIFF.CFG.  This 
  262. directive is most useful in a network environment.  Any other options are 
  263. ignored. 
  264.  
  265. Example: 
  266.  
  267. FBDIFF @someotherconfig.cfg 
  268.  
  269. Directs FBDIFF to use the configuration information contained in 
  270. someotherconfig.cfg instead of FBDIFF.CFG for its current execution.  Combined 
  271. with the DBNAME keyword, this feature can be used to keep multiple databases 
  272. and multiple scan/excude lists. 
  273.  
  274.  
  275. ΓòÉΓòÉΓòÉ 8. Known Bugs ΓòÉΓòÉΓòÉ
  276.  
  277. Please read the Legal Issues section before continuing. 
  278.  
  279. I currently know of no major bugs that could cause FBDIFF to report the wrong 
  280. information or destroy data during normal operation.  FBDIFF should perform 
  281. correctly assuming that it is provided with correct information. 
  282.  
  283. It is highly recomended that you delete FBDIFF's index (FBDIFF.IDX unless 
  284. DBNAME has been used) if you change either the SCAN or EXCLUDE lists.  If you 
  285. do not delete the index, FBDIFF may report bad data the first time it is run. 
  286.  
  287. Note:  If you disable OS/2's hard error popup box, FBDIFF will NOT handle hard 
  288.        errors gracefully.  Cavat Emptor! 
  289.  
  290.  
  291. ΓòÉΓòÉΓòÉ 9. Registration ΓòÉΓòÉΓòÉ
  292.  
  293. Note:   People who register this beta will receive a free upgrade to the first 
  294.        release version. 
  295.  
  296. This means that you may copy and distribute FBDIFF freely, but if you intend to 
  297. continue using it after 20 days, you are expected to register your copy or stop 
  298. using it.  By registering, you are helping to pay my expenses and are giving me 
  299. a good reason to continue to work on this software. 
  300.  
  301. FBDIFF's standard edition is not suitable for use on systems that contain more 
  302. than 32,767 files.  The extended edition will process up to 128,000 files.  The 
  303. extended edition also supports exclusions from CRC scanning.  These are the 
  304. only differences between the extended and standard editions. 
  305.  
  306. Registered users will be receive notices and special upgrade prices for new 
  307. releases.  While a registration is vaild for all minor releases with the same 
  308. major version number, minor release updates will not be mailed out.  Minor 
  309. updates for the registered versions will be made available as publicly 
  310. distributed patches. 
  311.  
  312. FBDIFF's registration cost is on a sliding scale.  Private users pay less than 
  313. comercial users. Users are considered private if this program will be used on 
  314. equipment that they personally own or rent.  If you make more than $100,000 a 
  315. year, consider yourself a comerical user. 
  316.  
  317. Users are considered comercial if this program will be used on equipment owned 
  318. or rented by a comercial, industrial or military establishment.  If FBDIFF is 
  319. used to monitor files generated by multiple workstations, multiple licenses 
  320. must be purchased, even if each workstation does not actually use the program. 
  321. I.E.  If FBDIFF is used to monitor work from 15 computers, you must buy at 
  322. least 15 licenses. 
  323.  
  324. If you are a shareware author, a registered copy of one of your programs may be 
  325. accepted at my descretion as payment for a registered copy of FBDIFF. 
  326.  
  327. Order form for private users 
  328.  
  329. Order form for comercial users 
  330.  
  331.  
  332. ΓòÉΓòÉΓòÉ 10. Future Changes and History ΓòÉΓòÉΓòÉ
  333.  
  334. Future Changes:  A full file manager and report front end is in the works. 
  335.  
  336. History: 
  337.  
  338. 0.9.9     First public release version. 
  339. 0.0.6     Used internally for testing (1 month). 
  340. 0.0.0     Used internally for testing (2 months). 
  341.  
  342.  
  343. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  344.  
  345. Fatal errors caused by hardware faults, such as a disk that has not been 
  346. formatted or a disk that has been formatted by Some Other Operating System. 
  347.  
  348.  
  349. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  350.  
  351. Latin; meaning 'let the buyer beware.'  If you are running with AUTOFAIL=YES, 
  352. be careful. 
  353.  
  354.  
  355. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  356.  
  357. AUTOFAIL=YES in CONFIG.SYS 
  358.  
  359.  
  360. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  361.  
  362. Another operating system, such as UNIX or the Macintosh System. 
  363.  
  364.  
  365. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  366.  
  367. Report widths narrower than 80 columns.