home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / nlmerge.zip / NLMERGE.DOC next >
Text File  |  1994-01-16  |  5KB  |  107 lines

  1. NLMERGE Documentation, Revision 1.00
  2. Copyright 1993 by Edward J. Beroset.  All rights reserved.
  3.  
  4.                              NLMERGE
  5.                              -------
  6.  
  7. Purpose
  8. -------
  9. NLMERGE.EXE is a freeware OS/2 program which merges FidoNet(r) NodeDiff
  10. files with their corresponding NodeList files.
  11.  
  12. How to Use NLMERGE
  13. ------------------
  14. NLMERGE is a text-based OS/2 program which can run either by running it
  15. from the OS/2 command line. or by double-clicking its icon.  When run
  16. from the command line, NLMERGE automatically searches for the latest
  17. uncompressed NODELIST and NODEDIFF which are assumed to be in the
  18. current directory.  These file names have the form NODELIST.nnn and
  19. NODEDIFF.nnn where the nnn specifies the day of the year (from 0 to 365)
  20. that the file was issued.  When NLMERGE finds a NodeList and NodeDiff
  21. file, it opens them both, verifies that they are compatible (e.g. the
  22. NodeDiff file refers to that version of the NodeList) and generates an
  23. output NodeList file which corresponds to the same file naming
  24. convention.  On completion, the CRC of the output NodeList file is
  25. checked and if it's verified, the old NodeList and NodeDiff files are
  26. deleted.  If the CRC is not correct, the new NodeList file is deleted.
  27.  
  28. Command Line Switches
  29. ---------------------
  30. -s save the old nodelist and nodediff files.  (default is to delete)
  31. -r recursively process multiple nodediff files. (default is single)
  32. -? displays this help text.
  33.  
  34. When a command line switch is specified, it has the effect listed above.
  35. Multiple switches may be combined except for the -? switch.  When the -?
  36. switch is specified, only the help text is printed and no merge is done.
  37. If for some reason, you wish to keep the old nodediff and nodelist
  38. files, you may use the -s switch to save them.  Note that if NLMERGE
  39. generates a new nodelist which fails the CRC verification, it will
  40. delete this bad file regardless of whether the -s switch was used.  The
  41. -r switch allows multiple nodediff files to be applied successively to a
  42. nodelist.  This is useful if, for example, you haven't automated your
  43. point or BBS setup and wish to apply a number of nodediffs at once to
  44. obtain the current nodelist.
  45.  
  46. Return Errorlevel Codes
  47. -----------------------
  48. NLMERGE will return zero only when at exactly one nodelist has been
  49. successfully merged.  In the case that multiple nodelists are merged in
  50. a single pass, NLMERGE will return normally return 1, but it is assumed
  51. that multipass mode will not be used in a batch file.  NLMERGE will
  52. return 1 if no nodelists are merged, and -1 if the syntax was incorrect.
  53.  
  54. Explanation
  55. -----------
  56. The FidoNet(r) NodeList is an electronically distributed text list of
  57. FidoNet electronic bulletin board systems (BBSs). The list details
  58. information on some subset of these BBSs, including their FidoNet
  59. addresses, sysop name, telephone number, and various descriptive flags.
  60. With the explosion of the network, the NodeList has gotten very large.
  61. As of this writing, the NodeList just for zone 1 (roughly North and
  62. South America) is about 2.2 megabytes of data.  Because of its large
  63. size, weekly updates to the NodeList are currently distributed as
  64. NodeDiff files instead of complete NodeLists.  The NodeDiff file is a
  65. text file which contains instructions on how to modify the current
  66. NodeList to bring it up to date.  A computer program is used to
  67. interpret and apply these instructions to the old NodeList.  NLMERGE is
  68. such a program.
  69.  
  70. This program, NLMERGE.EXE was written mixed in C++ and assembly language
  71. and follows the specifications described in FTS-0005 (FTS = FidoNet
  72. Technical Standards) which is available on many FidoNet bulletin boards.
  73.  
  74. The Author
  75. ----------
  76. NLMERGE.EXE is Copyright (c) 1994 by Edward J. Beroset.
  77. You may contact me via email through my FidoNet address 1:3641/1.250.
  78.  
  79. Registration
  80. ------------
  81. NLMERGE is freeware.  You don't have to send me money to use it, but
  82. none will be refused.  I think it's worth about $10, and if you agree,
  83. go ahead and send it to me at the address below to earn my gratitude.
  84. That's all I can guarentee you'll receive.  Suggestions for new
  85. versions, improvements, bug fixes, general accolades, etc. may be sent
  86. as well and would be (almost) as appreciated as a crisp ten dollar bill.
  87.  
  88. Ed Beroset
  89. P.O. Box 16142
  90. Chapel Hill, NC  27516
  91.  
  92. Future Developments
  93. -------------------
  94. The next major revision of this program may include a FrontDoor
  95. compatible nodelist compiler and possible some other additional
  96. features.  Those who send in ten bucks for this version will be fondly
  97. remembered at that time.  :-)
  98.  
  99.  
  100. Legal Stuff
  101. -----------
  102. Fido(r) and FidoNet(r) are registered marks of Tom Jennings and Fido
  103. Software.
  104.  
  105. OS/2 is a trademark of International Business Machines, Inc.
  106.  
  107.