home *** CD-ROM | disk | FTP | other *** search
/ synchro.net / synchro.net.tar / synchro.net / modem.madness / SMMNETML / WWGT109A.ZIP / CONFIG.DOC < prev    next >
Encoding:
Text File  |  1993-05-19  |  8.8 KB  |  228 lines
  1. Included below are a few words on each of the configuration records
  2. currently defined for the WWIVGATE.DAT file.
  3.  
  4. Note that anything after a ; on a line is treated as a comment.  This is
  5. convenient for toggling options on and off - simply insert a ; as the
  6. first character of the line to disable the option.
  7.  
  8. Registration_number = xxx
  9.  
  10.     This record, if present, defines your registration number so that
  11.     you will quit getting the tones and Please Register type message.
  12.     Simply substitute the registration number I e-mail you for the xxx
  13.     above and the tones and messages should never appear again.  Note
  14.     that each registration number is keyed to a particular FIDOnet zone,
  15.     net, and node, so giving it out will probably not help your friends.
  16.     Invalid values (like "unregistered") are simply ignored.
  17.  
  18. Debug = n
  19.  
  20.     This record enables various levels of debugging messages to be
  21.     generated by the code.  Level 1 may be useful when initially
  22.     setting up the product, Level 0 is recommended after everything
  23.     is set up and working.  Higher levels are only for those that are
  24.     very curious, or if you are assisting the author in tracking down 
  25.     a bug.
  26.  
  27. Zone = z
  28.  
  29.     Your FIDOnet Zone number.  The z in z:nnn/fff.  It is critical
  30.     that you get this one right, or mail and echomail post will be
  31.     mis-marked.
  32.  
  33. Net = nnn
  34.  
  35.     Your FIDOnet Net number.  The n in z:nnn/fff.  It is critical
  36.     that you get this one right, or mail and echomail post will be
  37.     mis-marked.
  38.  
  39. Node = fff
  40.  
  41.     Your FIDOnet Node number.  The f in z:nnn/fff.  It is critical
  42.     that you get this one right, or mail and echomail post will be
  43.     mis-marked.
  44.  
  45. User_rec_len = nnnn
  46.  
  47.     This record allows you to specify your WWIVnet User record length.
  48.     It defaults to 832, which is the standard length of a WWIV 4.21A
  49.     system using the 64 sub support.  This number has a maximum of
  50.     2048 for you truely mod crazy folks <grin>.  The only dependance
  51.     WWIVgate has on the User Record is that the first two fields be
  52.     the normal default of handle and name, with their normal field
  53.     lengths.
  54.  
  55. Keep_after_processing
  56.  
  57.     This record, if it exist, prevents WWIVgate from removing files
  58.     after it is done processing them.  It's main usage is during initial
  59.     setup when WWIVgate may be being run by hand.  Note that WWIVgate
  60.     may be called repeatably by your calling batch file if this record
  61.     is left uncommented out, since the files your calling batch file
  62.     keys off of, will be left when WWIVgate is done processing.  I know,
  63.     I've done it...
  64.  
  65. Local_mail_only
  66.  
  67.     This record, if it exist, prevents WWIVgate from exporting e-mail
  68.     from WWIV nodes other than yours.  If this record does not exist,
  69.     anyone on WWIVnet (or equavalent) can route mail to FIDOnet through
  70.     your node.
  71.  
  72. Crash_mail = n
  73.  
  74.     This record allows you to control the FIDOnet Crash bit setting on
  75.     generated FIDOnet e-mail.  When set to 0, the Crash bit will never
  76.     be set.  When set to 1, e-mail destined to another node in your
  77.     zone and net will have the Crash bit set.  When set to 2, e-mail 
  78.     will always have the Crash bit set, even if the mail is to another
  79.     net or zone.
  80.  
  81. Direct_mail = n
  82.  
  83.     This record allows you to control the FIDOnet Direct bit setting on
  84.     generated FIDOnet e-mail.  When set to 0, the Direct bit will never
  85.     be set.  When set to 1, e-mail destined to another node in your
  86.     zone and net will have the Direct bit set.  When set to 2, e-mail 
  87.     will always have the Direct bit set, even if the mail is to another
  88.     net or zone.
  89.  
  90.  
  91. High_Ascii
  92.  
  93.     This record, if it exist, prevents WWIVgate from removing any
  94.     character in the ASCII code range of 128 to 170.  Normally, all
  95.     "high_ascii" (codes 128-255) are removed from text when processed.
  96.     This feature was added to allow non-english character sets to be
  97.     successfully processed.
  98.  
  99. Pass_WWIV
  100.  
  101.     This record, if it exist, prevents WWIVgate from stripping out
  102.     WWIV control characters (colors, and centering).  This flag 
  103.     should not be used unless the output is going directly to another
  104.     BBS that understands WWIV control codes.
  105.  
  106. Pass_All
  107.     
  108.     This record, if it exist, prevents WWIVgate from removing any
  109.     "high_ascii" control codes.  Again, only use this keyword if you
  110.     know what your doing.  Most FIDOnet networks do not allow "high 
  111.     ascii" characters in their messages.  Added by request.
  112.  
  113. Always_Center
  114.  
  115.     This record, if it exist, overrides the Pass_WWIV and Pass_All
  116.     flags in regards to centering.  If this record is used, the WWIV
  117.     center codes will always be honored.
  118.  
  119. Alias_ok
  120.  
  121.     This record, if it exist, prevents WWIVgate from translating
  122.     incomming user names from what is assumed to be a real name to
  123.     the users alias.  In other words, it tells WWIVgate that Aliases
  124.     are the norm for the FIDOnet compatible network you are running.
  125.  
  126. Skip_Sysop_Mail
  127.  
  128.     This record, if it exist, prevents WWIVgate from processing any
  129.     inbound mail destined for the Sysop.  This is any netmail, not
  130.     echomail, addressed to "Sysop", "ALL", or the real name of WWIV
  131.     user number 1.
  132.  
  133. Areafix
  134.  
  135.     This record, if it exist, prevents WWIVgate from processing any
  136.     inbound mail destined for the user "Areafix".  This is useful
  137.     for folks that run programs like GEcho who use the name Areafix
  138.     for managing echo feeds.
  139.  
  140. Add_CR
  141.  
  142.     This record, if it exist, will tell WWIVgate to add a CR after
  143.     every 78 characters of inbound text.  This is useful if your editor
  144.     does not gracefully handle things like quoteing...  Many FIDOnet
  145.     mail processes just ship a unbroken stream of characters without
  146.     any line breaks.  Line breaks should occur on word boundries.
  147.  
  148. Soft_CR
  149.  
  150.     This record, if it exist, will tell WWIVgate to allow soft CRs
  151.     commonly present in FIDOnet messages to be passed through to 
  152.     WWIV.  Since soft CRs (hex 8D) are not normally displayable, this
  153.     might cause some viewing discomfort.
  154.  
  155. Soft_to_HardCR
  156.  
  157.     This record, if it exist, will tell WWIVgate to convert soft CRs
  158.     to hard CRs.
  159.  
  160. Kill_tag
  161.  
  162.     This record, if it exist, will tell WWIVgate to kill all tag lines
  163.     it finds while exporting messages.  This option is dependant upon
  164.     the tag line starting with a Ctrl-D.
  165.  
  166. WWIVnet_name = xxx
  167.  
  168.     This record, if it exist, allow folks running WWIVnet compatible
  169.     networks to use WWIVgate.  xxx should be replaced with whatever
  170.     you define your network name to be in INIT (WWIVlink, ICEnet, etc.).
  171.     An alternative is to set the WWIV_Net environmental variable to
  172.     point to the INIT defined network.  
  173.  
  174. Force_fake = xxx
  175.  
  176.     This record, if it exist, forces the fake_net node number that
  177.     WWIVgate will use.  This takes a bit of explaining...
  178.  
  179.     WWIVgate was originally written using the WWIV 4.21a facility of
  180.     supporting multiple networks.  This WWIV feature was utilized so
  181.     that when I person posted, or e-mailed, someone on FIDOnet, the
  182.     message comming from WWIV would indicate that (ie. "This message
  183.     will go out on FIDOnet").  The main goal of the original WWIVgate
  184.     was to allow the Sysop to have their board participate in FIDOnet;
  185.     not to gate FIDOnet echos into WWIVnet land.
  186.  
  187.     In part due to its name, and in part due to the functionality of
  188.     similar programs like NETSex, some folks expected WWIVgate to 
  189.     literally gate messages between the FIDOnet world and the WWIVnet
  190.     world.  WWIV 4.22 appears to allow that, if the sysop sets it up 
  191.     properly.
  192.  
  193.     Force_fake is an alternative to using the WWIV 4.22 setup.  It
  194.     will force the fakenet number to be whatever is specified.  It
  195.     is designed to be used in conjuction with either one of the
  196.     command line options.
  197.     For instance, if WWIVnet is defined in INIT as network
  198.     1, and WWIVgate is called via the command line: "WWIVgate 1",
  199.     WWIVgate will port described subboards directly into WWIVnet.
  200.  
  201.     When this option is used, it should be noted that no indication
  202.     will be given to the use that their post is destined for FIDOnet.
  203.  
  204. Non_Local
  205.  
  206.     This option, if it exist, will cause WWIVGate to process all
  207.     *.MSG files that have the LOCAL bit set.  It will also prevent
  208.         WWVIGate from marking messages generated as LOCAL.  Use this
  209.         option carefully, and only if you understand what this means.
  210.         The option was added by request of a registered user who was
  211.         using WWIVgate to move messages between BBSes...  It is NOT for
  212.         general usage but is documented here because it IS available.
  213.  
  214. Origin: <string>
  215.  
  216.     This record allows you to specify the origin line you would like to
  217.     appear on echomail posts.
  218.  
  219. Subboard <sub-type> <directory>
  220.  
  221.     These records map for WWIVgate the relationship between WWIV sub-types
  222.     and FIDOnet message folders.  A special sub-type keyword of "mail"
  223.     should be used for your FIDOnet e-mail folder.  Failure to specify
  224.     a mail folder will typically cause WWIVgate to die while trying to
  225.     process mail.  This is another common source of program looping, 
  226.     since the mail would not be processed, but would remain waiting to
  227.     be processed.
  228.