home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / maxsync2.zip / maxsync.doc < prev    next >
Text File  |  1996-10-08  |  9KB  |  155 lines
  1. /*========================================================================*/
  2. /*  Version  2.0 07/Oct/96            written by Greg Matheson (C)        */
  3. /*  OS/2 only version.                                                    */
  4. /*  MaxSync :- Reads Maximus V3 Msgarea.ctl and Squish.cfg files.         */
  5. /*  Writes a Msgarea.lst and Squish.lst filtered on the Maximus Divisions */
  6. /*                                                                        */
  7. /*  Description :- Maximus Message area generator and Squish Syncronizer  */
  8. /*                                                                        */
  9. /*  Purpose :- This program is intended to syncronize your Maximus and    */
  10. /*  Squish control files message areas. It will report differences it     */
  11. /*  encounters, generate maximus areas definitions for new areas, format  */
  12. /*  the squish file to be in the same order as the maximus file including */
  13. /*  msgdivsions.                                                          */
  14. /*                                                                        */
  15. /*  It has been written to allow a semi automatic way of ensuring         */
  16. /*  that current Maximus areas are still arriving in squish and that      */
  17. /*  new squish areas are added to the maximus setup.                      */
  18. /*                                                                        */
  19. /*  To install new message areas in Maximus you just need to move the     */
  20. /*  newly created maximus areas to the section of the file where you wish */
  21. /*  it to appear and ensure the area name is how you want it to appear.   */
  22. /*                                                                        */
  23. /*  Any Maximus Area not in Squish will be removed from the Msgarea.lst   */
  24. /*  and reported in Lost.lst.                                             */
  25. /*                                                                        */
  26. /*  Any Areas in Squish.cfg not presently in Msgarea.ctl, with the        */
  27. /*  exception of pass-thru areas, are created in a New Division of the    */
  28. /*  msgarea.lst file generated. These additions are reported in lost.lst  */
  29. /*                                                                        */
  30. /*  Edit Maxsync.cfg to suit your system before running Maxsync.          */
  31. /*  Local areas to your BBS, should be included in Squish.cfg using the   */
  32. /*  (undocumented) LOCALAREA keyword. If they do not appear in squish.cfg */
  33. /*  they will be reported as lost, and not created in msgarea.lst.        */
  34. /*                                                                        */
  35. /*  Study the Lost.lst file to see if there are any typos or incorrect    */
  36. /*  paths causing areas to be reported as lost.                           */
  37. /*                                                                        */
  38. /*  You should move the new areas from the New Division to the divisions  */
  39. /*  they are to appear in the BBS in msgarea.lst. Ensure all your areas   */
  40. /*  have unique names when you relocate them to their correct locations.  */ 
  41. /*                                                                        */
  42. /*  Rename the Msgarea.lst to Msgarea.ctl.                                */
  43. /*                                                                        */
  44. /*  Run Maxsync again to generate a new synced squish.lst                 */
  45. /*                                                                        */
  46. /*  All the Areas in Squish.lst should now appear in the same order as    */
  47. /*  in Maximus, including divisions. All existing settings for the Max    */
  48. /*  Areas and Squish Areas will be preserved.                             */
  49. /*                                                                        */
  50. /*  If you have no msgarea.ctl, an attempt will be made to create one     */
  51. /*  based on the squish.cfg file.                                         */
  52. /*                                                                        */
  53. /*  If you have no Squish.cfg file, an attempt will be made to create the */
  54. /*  Areas section based on msgarea.ctl                                    */
  55. /*                                                                        */
  56. /*  Squish.lst has the Areas section to replace the existing one in       */
  57. /*  your Squish.cfg. Replace the Areas section of your Squish.cfg with    */
  58. /*  Squish.lst                                                            */
  59. /*                                                                        */
  60. /*  Rename Msgarea.lst to Msgarea.ctl and resilt Max and your BBS has all */
  61. /*  the Squish areas in it, other than pass-thru areas                    */
  62. /*                                                                        */
  63. /*  Beta    Version  2.0 30/9/96                                          */
  64. /*  (c)     Greg Matheson                                                 */
  65. /*  Not for distribution                                                  */
  66. /*========================================================================*/
  67.  
  68. Performance
  69.  
  70. This program will process 1300 max and squish areas in less than      
  71. 2 minutes on a 120Mhz DX4 with 16megs of ram. 150 areas takes ~10 sec 
  72. Maxsync should handle 2000 or more message areas without problem.
  73.  
  74. System Requirements:-
  75.  
  76. A computer running OS/2 with Rexx system components installed.
  77.  
  78.  
  79. Installing & Running Maxsync :-
  80.  
  81. Create a directory for the program to live in eg C:\Maxsync
  82. Edit Maxsync.cfg configuration file to suit your system requirements
  83. Ensure your local message areas from Maximus are in Squish.cfg using
  84. the LocalArea keyword. As this is an undocumented word you may not find it 
  85. in Squish.doc
  86.  
  87. use this format :-
  88. LocalArea <TAG> <PATH> -$ (squish flags -$m100 etc)
  89.  
  90. Run Maxsync
  91.  
  92. Comments are added to msgarea.lst and squish.lst that inform you of
  93. the syncronised state of your system setup, and what steps to take if
  94. they dont match up.
  95.  
  96. This program has limited support for Seal ;Echospec lines in
  97. squish.cfg The limitation is that Maxsync only supports the
  98. ;Echospec line being the the form of EchoArea line followed by
  99. ;Echospec line.  The format of all the echoarea lines in a group
  100. followed by all the ;echospec lines is not supported.
  101.  
  102. As the idea behind maxsync is to have all the information about your
  103. message areas syncronized, some squish areas such as BadArea,
  104. DupeArea will appear in your maximus system.  Ensure they are in a
  105. Sysop only area.
  106.  
  107. Running Seal and Maxsync, it should be possible to    keep your
  108. Maximus message areas syncronized with the Squish areas, with the
  109. descriptions being obtained from fidonet.na with Seal and stored in
  110. the Echospec line, Maxsync generating new areas and dropping old
  111. ones, with little manual configuring.
  112.  
  113. Why not just use Seal to make areas ?  Because Seal has no cross
  114. referencing to your existing message areas (for existing names and
  115. divisions), and insists on creating alphabeticaly sorted lists of
  116. areas.
  117.  
  118. Advantages on using Maxsync are that your existing Maximus setup is
  119. not altered, except for the removal of dropped message areas, the
  120. names and settings are all preserved, squish.cfg is formatted to the
  121. layout of the BBS areas which makes maintance easier.  By examining
  122. the lost.lst you can see at a glance what areas are no longer
  123. imported by squish or what new areas have arrived in Squish.
  124.  
  125. Dont forget to re-silt Maximus after changing the msgarea.ctl file.
  126.  
  127. Please report on how this program behaves on your system to :-
  128. Greg Matheson   3:626/661.0  / 3:626/661.1 (Fidonet)
  129. or 
  130. greg@teleport.apana.org.au    (Internet)
  131.  
  132. Thanks to Ian Smith for suggestions and the beta testers.
  133. Greg.
  134.  
  135.  
  136. Beta Version Licence agreement.
  137.  
  138. This product is free to use for non commercial users of Maximus BBS
  139. and Squish mailer software.
  140.  
  141. Commercial users of the above software, who find Maxsync to be of some
  142. use are encouraged to send $10 Australian Dollars to Greg Matheson 
  143. Po Box 9 Nimbin 2480 Australia. This will make you feel real good.
  144.  
  145. Any payment is received as a donation towards develpoment costs of 
  146. this and other projects. Receipt of any money will be acknowledged by
  147. a virtual postcard.
  148.  
  149. This program is only warranted to take up disk space and provide no 
  150. functional use other than as a time consumer.
  151.  
  152. All rights reserved    (C)
  153. Distribution without this licence agreement is prohibited.
  154. Greg Matheson Mon 07-Oct-1996 21:46:42  
  155.