home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast2.iso / citadel / k2ne603c.zip / CITAGATE.ZIP / CITAGATE.DOC next >
Text File  |  1991-01-06  |  11KB  |  192 lines
  1. To:  Citadel:K2NE Sysops and other interested folk
  2. Fr:  Vince Quaresima t/a K2NE Software
  3. Re:  CITAGATE.EXE v1.02 release
  4. On:  January 2, 1991
  5.  
  6. NOTE:  CITAGATE.EXE Version 1.02 is the FIRST officially released
  7.        version of this software.  Please consult this file closely
  8.        before attempting to use this software.  Please read
  9.        "Section IV.  License and Distribution" before you use this
  10.        software.  Use of this software constitutes agreement with
  11.        the terms and conditions stipulated in that section.
  12.  
  13.  
  14. I.  What is CITAGATE?
  15.  
  16.  CITAGATE is a utility to use with your Citadel:K2NE bulletin board
  17. system beginning with Citadel:K2NE version 5.15, which will enable
  18. you to link your Citadel message file with FIDOnet messages, and will
  19. allow you to bring Citadel messages over to FIDOnet, and also to bring
  20. FIDOnet messages over to Citadel.
  21.  
  22.  
  23. II.  What CITAGATE is not!
  24.  
  25.  CITAGATE is NOT a FIDOnet utility.  CITAGATE will not help you set up
  26. or maintain your FIDOnet-related files.  Quite to the contrary, CITAGATE
  27. operates under the assumption that you already have set up your FIDOnet
  28. software, already have a FIDOnet node assignment, and already have your
  29. FIDOnet software operating correctly and that you can successfully dial up,
  30. network, and import/export messages to/from your FIDOnet feed system.
  31.  
  32.  For further information on setting up, operating, and maintaining your
  33. FIDOnet system, please consult the FIDO-compatible software that you are
  34. using (or intend to use).  We strongly recommend that you use FIDO software
  35. that is compatible with ConfMail, as CITAGATE was written specifically to
  36. handle FIDO messages generated to work with the ConfMail utility.  The
  37. ConfMail software is readily available at many FIDOnet systems, but if you
  38. can't find it, please contact Jersey Devil Citadel at (609) 893-2152.
  39.  
  40.  
  41. III.  The many "hats" of CITAGATE
  42.  
  43.  CITAGATE will do a number of things for you, and to work best you should
  44. put CITAGATE.EXE in your ROOT directory.  It will probably work from any
  45. directory listed in your PATH environment variable, but...
  46.  
  47.  CITAGATE operates in three different modes depending on what you want it
  48. to do at any given time:
  49.  
  50.   1.  CITAGATE PUTFIDO:  When called in this manner, CITAGATE will
  51.       search your Citadel "home area" directory for any messages
  52.       that need to be brought INTO your FIDOnet areas.  Thus, you
  53.       should only call CITAGATE FIDO from your Citadel "home area"
  54.       directory if you expect this to work properly.  As CITAGATE
  55.       finds messages to process, it moves them to the proper FIDOnet
  56.       area and parses them into proper "ConfMail message" format.  In
  57.       addition, it will "stamp" each FIDO area so that it will "know"
  58.       the highest message-number in that area the next time it returns.
  59.  
  60.       Technical Particulars:
  61.       --------- -----------
  62.       When CITAGATE is used in the PUTFIDO mode (see next section), it parses
  63.       a set of temporary files built by Citadel:K2NE during normal user
  64.       sessions.  If these files exist, then the result is the generation of
  65.       a properly numbered ###.MSG file (in the proper FIDO area) for each
  66.       Citadel-generated message waiting to be processed.  Each ###.MSG file
  67.       generated conforms to FIDO layered-protocol-modem specifications
  68.       in accordance with the document FTS-0001.015 (dated August 1990).
  69.  
  70.  
  71.   2.  CITAGATE GETFIDO:  When called in this manner, CITAGATE will retrieve
  72.       all messages higher in number than the "high message stamp" that it
  73.       finds.  To use CITAGATE in this mode, you must call it from the FIDO
  74.       message area that you want to process.  This is easily handled via
  75.       batchfile processing.  If you need an example:
  76.  
  77.       echo off                      | Just keeps things neat!
  78.       c:                            | I always do this to be safe.
  79.       cd \                          |
  80.       f:                            | On my bbs, FIDO stuff is on F: drive
  81.       cd \binkley\bikes             | BIKENET is in F:\BINKLEY\BIKES
  82.       CITAGATE getfido              | Tells CITAGATE to process this area
  83.       c:                            | Back "home" again...
  84.       cd \k2ne                      |  "     "      "
  85.       copy f:*.alt                  | The *.alt files are what CITAGATE found.
  86.       del  f:*.alt                  | Cleans up the F:\BINKLEY\BIKES area.
  87.       if not exist 1.alt goto step1 | If we didn't find any, we skip next line.
  88.       ctdl altlink=FIDOnet          | Tells Citadel to bring them in!
  89.       :step1                        | Continuation "break-point."
  90.  
  91.       REST OF BATCHFILE CONTINUES
  92.       HERE, followed by...
  93.  
  94.       e:                            | I keep my BINKLEYTERM stuff on E: drive
  95.       cd \binkley                   | ... and in the E:\BINKLEY directory
  96.       CITAGATE scandir              | Make CITAGATE reset all CTDLHIGH pointers
  97.                                     | (note - this DIR must contain AREAS.BBS)
  98.       c:                            | Back home!
  99.       cd \k2ne                      | My Citadel:K2NE "home area" directory
  100.       CITAGATE putfido              | Checks for messages FROM Citadel TO FIDO
  101.                                     | ... and processes any it finds.
  102.       runbbs.bat                    | Back to Citadel!
  103.  
  104.       If you take a few minutes to study that example batchfile, you will
  105.       readily see that once you have it all set up, it will "do its thing"
  106.       automatically with a minimum of work on your part.  Setting it up,
  107.       however, may seem a bit arcane.  However, if you already have your
  108.       FIDOnet stuff working, you know the true meaning of "arcane."
  109.  
  110.   3.  CITAGATE SCANDIR:  When called in this manner, CITAGATE will use the
  111.       file AREAS.BBS to step through each of your FIDOnet directories and
  112.       reset the Citadel high-message-processed pointer in each FIDO area.
  113.       This pointer is stored in the file CTDLHIGH.DAT which CITAGATE SCANDIR
  114.       will generate in each FIDO directory.  You MUST call CITAGATE from the
  115.       directory containing your AREAS.BBS file for it to operate in this
  116.       mode.  However, there is absolutely no reason why you cannot make a
  117.       copy of your AREAS.BBS file and move it to a different directory and
  118.       then call CITAGATE SCANDIR from that directory.  There is also no reason
  119.       why you could not edit your "cloned" AREAS.BBS file to only have
  120.       CITAGATE SCANDIR process those FIDO areas you are actually linking into
  121.       your Citadel:K2NE system.  On slower PCs, this may be a significant
  122.       way of shortening execution time.
  123.  
  124.       If you prefer to only scan the actual FIDO areas you are importing
  125.       to your Citadel:K2NE BBS, you may edit a COPY of your AREAS.BBS file
  126.       to only include those areas involved in Citadel.  Name the edited
  127.       copy AREAS.CIT and move it to the directory of your choice.
  128.       You may then invoke CITAGATE SCANDIR from the directory containing
  129.       the AREAS.CIT file.  If CITAGATE finds both AREAS.BBS and AREAS.CIT
  130.       in the same directory, it will use AREAS.CIT and ignore AREAS.BBS.
  131.  
  132.       Please note:  The last line of the AREAS.CIT file should NOT be
  133.       terminated with a carriage-return.  If it is, CITAGATE will scan
  134.       the final area in the file twice.  This does not cause any problem,
  135.       but is a needless time-waster.
  136.  
  137.   4.  CITAGATE HELP or CITAGATE ?:  This will cause a brief synopsis of
  138.       the various modes of CITAGATE to be displayed on your console.
  139.  
  140. IV.  License and Distribution
  141.  
  142.   1.  System Operators of Citadel:K2NE bulletin board software are
  143.       licensed for UNLIMITED NON-COMMERCIAL usage of this utility
  144.       on their own, personally-owned computers, ONLY in conjunction
  145.       with the use of the Citadel:K2NE bulletin board software,
  146.       version 5.15 and newer.  Such system operators are authorized
  147.       to give copies of this software and its documentation ONLY to
  148.       other non-commercial system operators using Citadel:K2NE bulletin
  149.       board software.
  150.  
  151.   2.  System Operators of Citadel:K2NE bulletin board software operating
  152.       in a commercial environment, or under the jurisdiction of any
  153.       federal, state or local government agency MUST pay a $25.00
  154.       licensing fee for EACH COMPUTER on which this utility will run,
  155.       whether such computer be a file-server, LAN-node, or independently-
  156.       operating BBS.  Quantity discount licensing is available for
  157.       any commercial entity requiring more than FIVE licenses for this
  158.       software.  For details, contact:
  159.  
  160.              K2NE Software
  161.              30 Marygold Avenue
  162.              Browns Mills, New Jersey 08015
  163.  
  164.       Note:  Educational institutions (as defined by the federal
  165.              Internal Revenue code) are totally exempt from this requirment
  166.              and will be considered to be non-commercial users.
  167.  
  168.   3.  All other usage of this software is by LICENSE ONLY.  Such license is
  169.       available ONLY from K2NE Software at the address given in the previous
  170.       section.  All rights to this software other than those specifically
  171.       cited in this documentation are completely and strictly reserved to
  172.       the copyright holder.  This includes, but is not limited to, "reverse-
  173.       engineering" or any similar non-intended use.  This software, and
  174.       this documentation, are NOT public domain or "shareware."
  175.  
  176.   4.  This software is provided strictly on an "as-is" basis, and is not
  177.       warranteed in any way.  Specifically, the "warranty of merchantability"
  178.       and "warranty of fitness for a specific purpose" are disclaimed, in
  179.       addition to any and all implied or specific warrantees.  Neither the
  180.       author nor K2NE Software shall be held liable for any direct or indirect
  181.       damages resulting out of the use of this software, including any damage
  182.       for loss-of-use or damage to hardware or other software.  Use of this
  183.       software, by any entity and for any reason, constitutes acceptance of
  184.       these conditions.
  185.  
  186.  
  187. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  188. + Citadel:K2NE <tm> Vincent Quaresima t/a K2NE Software.                      +
  189. + CITAGATE.EXE and its source-code is copyright 1991 by Vincent Quaresima,    +
  190. + with all rights reserved.  Distribution by any means, without the express   +
  191. + written permission of the copyright holder, is a violation of Federal law.  +
  192. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+