home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / OFFLINE / MM3DEMO.ZIP / MM3DOC.ZIP / QUIKSTRT.TXT < prev   
Text File  |  1994-03-19  |  12KB  |  314 lines
  1. Quick Start Manual for The MainMail System Version 3.x
  2. ──────────────────────────────────────────────────────
  3. This 'Quick Start' manual is NOT intended to be a replacement for the
  4. primary sysop's manual, but rather a suppliment to it.  DO NOT think
  5. that reading this manual and following the directions within will
  6. inform you fully of the features of The MainMail System, or provide
  7. you with all options and enhancements.
  8.  
  9. This manual is ONLY intended to get you 'up and running' quickly and
  10. easily, so you can read the full manual on your own time.
  11.  
  12.        READ THE FULL MANUAL!      READ THE FULL MANUAL!
  13.  
  14.  
  15. Setting up The MainMail System for the first time
  16. ─────────────────────────────────────────────────
  17.  
  18. 1.  Create a directory structure similar to the one shown here:
  19.  
  20.     └─ MAINMAIL
  21.          ├─ GEN
  22.          ├─ HELP
  23.          └─ DUPE
  24.  
  25. This 'tree' can be off of the root of any drive, or below any sub
  26. directory.  The choice is totally up to you.  
  27.  
  28. 2.  Unzip your MainMail archive, or copy your MainMail disk into the
  29.     MAINMAIL directory.
  30.  
  31. 3.  Unzip GEN.ZIP into the GEN directory.
  32.  
  33. 4.  Unzip HELP.ZIP into the HELP directory.
  34.  
  35. When finished, the following files should be present in each of the
  36. respective directories:
  37.  
  38.     MAINMAIL          GEN         HELP        DUPE
  39.     --------          ---         ----        ----
  40.     MM-GAP.EXE        MM-MENU     MMHLP-*     Currently empty.
  41.     MMSETUP.EXE       MM-NEWS
  42.     MMPACK.EXE        MM-NUSER
  43.     MMSYS.DAT
  44.  
  45. 5.  Add the following line to your AUTOEXEC.BAT file:
  46.  
  47.     SET GAPCNF=<full path to your GAP default directory for this node>
  48.  
  49. The above environment variable is used by MainMail to find your GAP
  50. default directory.  You should have a 'SET GAPCNF=d:\path' statement
  51. in EACH node's autoexec.bat file if you are running on a network, or
  52. in EACH node's window startup batch file if you are running Desqview.
  53. Each node's environment variable should 'point' to the correct GAP
  54. default directory for THAT NODE!
  55.  
  56. Once this environment variable is added to autoexec.bat, reboot the
  57. machine so that the change takes affect.
  58.  
  59. 6.  Change to the MAINMAIL directory.
  60.  
  61. 7.  Run MMSETUP.
  62.  
  63.     a) Choose CONFIGURATION.
  64.  
  65.     b) Choose GENERAL.
  66.  
  67.        Check and/or change any necessary information on the screen.
  68.        You will find several fields, most of which will probably
  69.        already be set up correctly.  Special attention showld be
  70.        placed on the "Sysop's Name In Door" field.  Use your REAL name
  71.        in this field, even if you use a fake name in the GAP user
  72.        file.  This is the name that MainMail will use when messages to
  73.        or from you are exported to your users.
  74.  
  75.        When finished with this screen, press ESC.  Your changes will
  76.        be saved and any directories that do not exist will be created.
  77.  
  78.        Note: The 'Local Uploads' and 'Local Downloads' paths are not
  79.              verified by MMSETUP.  These directories must be created
  80.              manually or local operations will fail.
  81.  
  82.     c) Choose COMPRESSION.
  83.  
  84.        You will be shown a screen containing the first four
  85.        compression methods.  Additions and/or changes may be made at
  86.        this time.  This screen should be self-explainatory.
  87.  
  88.        NOTE: To delete a compression method, change the CODE to
  89.              blanks.  Once you exit the screen, MMSETUP will clear out
  90.              the remaining fields of that compression method.
  91.  
  92.              Also, MMSETUP will sort the compression methods
  93.              alphabetically.  You need not do so yourself.
  94.  
  95.        When you are finished with your compression methods, press ESC.
  96.        Your changes will be saved.
  97.  
  98.     d) Choose PROTOCOLS.
  99.  
  100.        This screen works identicaly to the COMPRESSION screen.
  101.  
  102.        When configuring protocols, MainMail allows you to pass certain
  103.        variables to the protocol driver.  These strings are outlined
  104.        at the top of the screen.
  105.  
  106.        NOTE: VARIABLES MUST BE UPPER CASE!  In other words, use '#F#'
  107.        for filename.  '#f#' will _NOT_ work.
  108.  
  109.        When finished with your compression methods, press ESC. Your
  110.        changes will be saved.
  111.  
  112.        Press ESC again to exit the CONFIG section.
  113.  
  114.     e) Choose NETWORKS.
  115.  
  116.        You can think of NETWORKS as a group of forums.  Nothing more.
  117.        Each NETWORK should be given a minimum of a CODE and a NAME.
  118.        These CODES will be used later.
  119.  
  120.        By grouping your forums by network, the user will be shown a
  121.        list of networks whenever s/he chooses [S]elect Forums from the
  122.        MainMail main menu.  This provides an easy way for the user to
  123.        pick and choose forums based on his/her area, preference,
  124.        etc...
  125.  
  126.        In addition, if the user is a network node, then s/he will be
  127.        RESTRICTED to only those forum within the network s/he is also
  128.        assigned.  In other words, if a user is a network node, and is
  129.        assigned network 2, then s/he will ONLY have access to the
  130.        forums in network 2!
  131.  
  132.        HOST ID and TAGLINE are optional, and if you are _NOT_
  133.        operating as a QWK network hub, thay are not used at all.
  134.  
  135.        If you _ARE_ going to operate as a QWK network hub, then any
  136.        messages ENTERED ON YOUR BBS (either online or through MainMail
  137.        or any other mail door) and exported through MainMail to a
  138.        network node, will have the tagline for this network appended
  139.        to it.
  140.  
  141.        MainMail will NOT append a tagline to any message entered FROM
  142.        a network node.  It is assumed that any message FROM a network
  143.        node will already have a tagline appended to it.
  144.  
  145.        When you have all of your NETWORKS configured, press ESC and
  146.        your changes will be saved.
  147.  
  148.     f) Now choose FORUMS.
  149.  
  150.        Choose which network each forum belongs to, and place that
  151.        network number in the last field.
  152.  
  153.        In addition, set all of the flags apropriately.  Here is a
  154.        description of each field:
  155.  
  156.        Forum Number, Forum Name, Net Forum:
  157.           These fields are read from your GAP configuration and cannot
  158.           be edited.
  159.  
  160.        Force This Forum:
  161.           If set to "Y", users will not be able to de-select this
  162.           forum.
  163.  
  164.        Auto Select :
  165.           If set "Y", this forum will be flagged as SELECTED for ALL
  166.           MAIL for a user the first time s/he opens the MainMail door,
  167.           but the user WILL be able to deselect this forum.
  168.  
  169.           Note: The FORCE flag above implies auto-select.  Thus, if a
  170.                 forum is FORCED, there is no need to set the
  171.                 auto-select flag also.
  172.  
  173.        News Optn :
  174.           By default, MainMail includes your news and welcome screens
  175.           in the user's mail packet.  If you toggle this field to "Y",
  176.           any user may then toggle their own news/welcome screens off.
  177.  
  178.        Enable Dupe Checking :
  179.           This flag simply enables dupe checking on messages uploaded
  180.           and downloaded through the MainMail door.
  181.  
  182.           Dupe checking is performed by parsing all uploaded and
  183.           downloaded messages to the TO: name, FROM: name, and
  184.           SUBJECT: of the message, along with the message body, not
  185.           including any detectable taglines, and performing a 32 bit
  186.           CRC of these fields. Then, this 32 bit value is compared to
  187.           all previous 32 bit CRCs on file for this forum, and if a
  188.           match is found, the message is discarded.  MainMail
  189.           maintains a list of the last 1000 CRCs in each forum
  190.           (maximum of 4000 bytes per forum).
  191.  
  192.           MainMail uses a highly buffered CRC table in memory, and
  193.           updates disk only when needed.  This makes CRC checking VERY
  194.           fast, and efficent.
  195.  
  196.           In benchmark tests, importing 1000 messages, there was only
  197.           a slight increase in time (aproximately 4%) needed when dupe
  198.           checking was enabled.
  199.  
  200.           All messages which are _NOT_ duplicates, are appended to the
  201.           CRC table, until 1000 CRCs are reached, then the oldest
  202.           CRC(s) are dropped off of the end of the table.
  203.  
  204.           These 1000 (max) CRCs are saved in a file named <forum
  205.           number>.MMD in the 'dupe' directory configured in the
  206.           GENERAL configuration section above.
  207.  
  208.        Export NonEcho :
  209.           This flag only applies to Network Nodes calling into
  210.           MainMail as a network hub.
  211.  
  212.           If a message is imported to your bbs through MainMail from a
  213.           network node, or from other network software such as GAPNET,
  214.           PCRELAY or POSTLINK, MainMail will recognize that message as
  215.           a message FROM the network, and will not re-export the
  216.           message to a network node.
  217.  
  218.           If this flag is set to "Y", MainMail will override the fact
  219.           that the message came from the network, and will export it
  220.           anyway.
  221.  
  222.           This flag is required if you use BOTH MainMail _AND_ other
  223.           networking software on the same forum.  IE: You call another
  224.           hub using Postlink, and you have nodes calling you using
  225.           MainMail.
  226.  
  227.        Allow [Y]ours :
  228.           This flag only applies to Network Nodes calling into
  229.           MainMail as a network hub.
  230.  
  231.           Normally, a network node will want ALL mail.  This flag
  232.           allows network nodes to choose [Y]our mail only.
  233.  
  234.        Use Tagline :
  235.           This flag only applies to Network Nodes calling into
  236.           MainMail as a network hub.
  237.  
  238.           If toggled "Y", MainMail will append your tagline to any
  239.           messages extracted by a network node that were entered
  240.           (originated) on your bbs.  Messages that originated on
  241.           another network node and imported into your bbs will not
  242.           receive any additional taglines, regardless of the state of
  243.           this flag.
  244.  
  245.        Network Number :
  246.           This selects which network this forum belongs to.
  247.  
  248.           NOTE:  If you choose network number 99, then this forum will
  249.                  appear in EVERY network.
  250.  
  251.                  This is especially usefull if you are acting as a hub
  252.                  for several networks.
  253.  
  254.        Press ESC when finished with the forums, and your changes
  255.        will be saved.
  256.  
  257.        NOTE:  While you are in the FORUM editor, there is one
  258.               other special option, that is the F8, 'global
  259.               change' key.
  260.  
  261.               When chosen, a 'clone' of the forum editor
  262.               appears, in reverse video.  This screen serves as
  263.               an easy way to change EVERY forum in a certain
  264.               manner.
  265.  
  266.               Any field that you place data into will be copied
  267.               to EVERY forum.  Any fields left blank will be
  268.               left unchanged.
  269.  
  270.               For example, if after pressing F8, you place a "Y"
  271.               in the 'Enable Dupe Checking' field, then EVERY
  272.               forum will then have Dupe Checking enabled.
  273.  
  274.     g) Choose USERS.
  275.  
  276.        This screen works much like the FORUMS and NETWORKS screen.
  277.        Any changes made to this screen will be saved in the user's
  278.        record currently being displayed.  If this is a network node,
  279.        set the 'Net Status' flag to "Y" and choose which network
  280.        number to place this user into.
  281.  
  282.        Note:  If you place this user into network 99, then s/he will
  283.               have access to EVERY forum as a network forum!
  284.  
  285.               This is usefull if you are acting as a hub for several
  286.               networks.
  287.  
  288.     h) Press ESC and your changes will be saved.
  289.  
  290.     THE MAINMAIL DOOR WILL NOT RUN UNTIL IT IS CONFIGURED!
  291.  
  292.  
  293. 8.  Create a MAINMAIL.BAT file.  The batch file must change to the
  294.     MAINMAIL directory and run the door.
  295.  
  296.     Example MAINMAIL.BAT file
  297.     -------------------------
  298.     @ECHO OFF
  299.     D:
  300.     CD\MAINMAIL
  301.     MM-GAP
  302.  
  303.  
  304. 9.  Edit your DOORS.DAT file and your DOORM(g) menus to reflect the
  305.     addition of The MainMail System to your board.
  306.  
  307.     Example DOORS.DAT File
  308.     ----------------------
  309.     MAINMAIL 50 C:\GAP\DOORS\MAINMAIL.BAT
  310.  
  311.  
  312. This concludes the configuration portion of MainMail 3.x.
  313.  
  314.