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