home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / MXP001.ZIP / MXP.DOC < prev    next >
Text File  |  1990-12-17  |  19KB  |  487 lines
  1.  
  2.                               ----------------                              
  3.  
  4.                                MX v0.01a.OS/2                               
  5.  
  6.                               ----------------                              
  7.  
  8.  
  9.                         Mail eXpress for Maximus CBCS                       
  10.  
  11.                            (C) David Luong, 1990.                           
  12.  
  13.                             All rights reserved.                            
  14.  
  15.  
  16.  
  17.                         FIDOnet address: 3:712/631.0                        
  18.  
  19.      
  20.  
  21.  
  22.      Distribution Rights 
  23.      ^^^^^^^^^^^^^^^^^^^ 
  24.      You  are hereby granted a limited licence to use MX in any way you see
  25.      fit,  and  to  distribute it in any way you wish, so long as you don't
  26.      charge  any  money  for  it.  If  I  catch you selling my software for
  27.      profit, I'll sue you for every penny of it. So there! 
  28.  
  29.  
  30.      License fee & Support 
  31.      ^^^^^^^^^^^^^^^^^^^^^ 
  32.      Please  send  me  a  post  card if you decide to use MX on your BBS. I
  33.      enjoy collecting postcards from _anywhere_ around the world and I mean 
  34.      ANYWHERE, doesn't matter even if it's from Sydney Australia! 
  35.  
  36.      My postal address is included at the end of this document. 
  37.  
  38.      If you have any problems with the installation of MX, or if you'd like 
  39.      to see more features then don't hesitate to contact me via netmail. 
  40.  
  41.  
  42.      Warranty 
  43.      ^^^^^^^^ 
  44.      I  grant  no  warranty  of any kind, either expressed or implied. This
  45.      includes,   but   is   not   limited   to,   implied   warranties   of
  46.      merchantability,  and  fitness for any particular purpose with respect
  47.      to both the software and the documentation included in this package. 
  48.  
  49.      In  NO event shall I or any of EDEN BBS's principals be liable for any
  50.      direct,  indirect, consequential, or incidental damages arising out of
  51.      the  use  or  inability  to  use MX even if I have been advised of the
  52.      possibility of such damages or claim. 
  53.  
  54.      The  warranties  set  forth above are in lieu of all other express and
  55.      implied  warranties,  whether  oral,  written,  or  implied,  and  the
  56.      remedies set forth above are your sole and exclusive remedies. 
  57.  
  58.      This  document  constitutes  the  entire  agreement  and understanding
  59.      between   the   parties   and   supersedes   any  prior  agreement  or
  60.      understanding  whether  oral  or  written, relating to the use of this
  61.      package. 
  62.  
  63.  
  64.      Absolute Requirements! 
  65.      ^^^^^^^^^^^^^^^^^^^^^^ 
  66.      *  OS/2 v1.1 or higher is essential.
  67.  
  68.      *  A  communications  library(COMM.DLL)  must be present to handle the
  69.      high  level  comm  port  communications.  This  'COMM.DLL'  library is
  70.      distributed as part of the OS/2 Maximus CBCS package. 
  71.  
  72.      *  At  least one stand-alone file compression program. Eg, ARC2.EXE by
  73.      System Enhancement & Associates. 
  74.  
  75.      *  At least one stand-alone file transfer program. Eg, M2ZMODEM.EXE by
  76.      Mikael Wahlgren. 
  77.  
  78.  
  79.      Highlights 
  80.      ^^^^^^^^^^ 
  81.  
  82.      * MX  is a fast and efficient express-mail door for your BBS.  Callers
  83.      of  your BBS can now download messages from your message base and then
  84.      read them off-line at their own leisure. 
  85.  
  86.      * MX will export ONE plain text file containing all new messages  from
  87.      the  chosen  areas.  Callers  don't  need  an  IBM PC or compatible to
  88.      benefit from MX. 
  89.  
  90.      * To further reduce the time in transferring the exported mail bundle, 
  91.      MX  will  compress  the mail bundle using an external file compression
  92.      program. 
  93.  
  94.      * Upto  5 file compression and 10 external file transfer programs  can
  95.      be installed for the use by MX.
  96.  
  97.      * Support for multi-line sites.
  98.  
  99.      * MX  will  keep  track of upto 100 message  areas(out of the possible
  100.      1296 areas) for each caller. 
  101.  
  102.      * Two packing methods supported in each individual message area: 
  103.  
  104.              ALL new messages.
  105.              PERSONAL messages.
  106.  
  107.      * Sysop  configurable  upper  limits  on the number of messages to  be
  108.      exported per scanning session for each class of callers. 
  109.  
  110.      * Access to each area is based on privilege levels and locks. 
  111.  
  112.  
  113.      Contents of this archive 
  114.      ^^^^^^^^^^^^^^^^^^^^^^^^ 
  115.          MXP.EXE       The  main MX executable file.
  116.          MXP.DOC       This document.
  117.          MXP.HST       An MX history file outlining the changes made between
  118.                        versions of MX.OS/2
  119.          MX.CTL        Sample MX control file.
  120.          MX_AREAP.EXE  MX areas info file construction program.
  121.          MX_UDELP.EXE  The MX Users Database Maintenance Utility.
  122.          DLOAD.CMD     Mail download batch file for use with MX.
  123.          PACK.CMD      Mail packing batch file for use with MX.
  124.  
  125.      
  126.  
  127.      Overview 
  128.      ^^^^^^^^ 
  129.      MX  is merely a mail export door program; MX would update the caller's
  130.      last-read pointers accordingly after messages are exported. 
  131.  
  132.      MX  relies  on standalone external programs for the compression of the
  133.      exported  message  bundle as well as the downloading of the compressed
  134.      mail bundle. 
  135.  
  136.      After messages are exported, MX would spawn a batch file 'PACK.CMD' to 
  137.      call  upon other standalone file compression utilities to compress the
  138.      exported message bundle. 
  139.  
  140.      When  the  message bundle is successfully compressed, MX would inspect
  141.      the  file  size of the compressed mail bundle to see if the caller has
  142.      enough time to download the compressed message bundle. 
  143.  
  144.      If  the  caller  has  enough  time  to download the compressed message
  145.      bundle,  MX  would  then  spawn  a batch file 'DLOAD.CMD' to call upon
  146.      other standalone file transfer programs to send the compressed message 
  147.      bundle to the caller. 
  148.  
  149.  
  150.  
  151.      MX - Mail eXpress for Maximus CBCS 
  152.      ---------------------------------- 
  153.  
  154.      Command line syntax of MX 
  155.      ^^^^^^^^^^^^^^^^^^^^^^^^^ 
  156.  
  157.             MXp -Pn -B -K -Tn
  158.  
  159.  
  160.  
  161.             Command line options of MX
  162.             ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  163.  
  164.                 -p ,specifies which comm port handle.
  165.                     No default.
  166.  
  167.                     IMPORTANT NOTE:
  168.                     ---------------
  169.                     * On a zero based comm port assignment, '-p0' does NOT
  170.                       necessarily mean COM1.
  171.  
  172.                     * This comm port handle should be the one passed on by
  173.                     Maximus's  '%L' or '%p' translation sequence for
  174.                     external door programs.
  175.  
  176.                 -b ,caller's baud rate.
  177.  
  178.                     MX does NOT need to change the current comm port's
  179.                     operating parameters. However, this parameter is used
  180.                     to calculate the time needed to transfer the mail
  181.                     bundles.
  182.  
  183.                 -k ,forces local mode. No communication libraries required
  184.                     in this mode.
  185.  
  186.                 -t ,where n is the task number for this node.
  187.  
  188.                     LEAVE THIS OPTION OUT COMPLETELY if the 'TASK' token is
  189.                     NOT in effect in your MAX.CTL.
  190.  
  191.             NOTE:
  192.             * Command line options may be presented in any order.
  193.  
  194.      
  195.  
  196.  
  197.      Installation 
  198.      ^^^^^^^^^^^^ 
  199.      1. Create  a  separate  directory  for  MX(will  use  d:\MX  for  this
  200.      example). 
  201.  
  202.      2. Copy all the files in this archive to d:\MX 
  203.  
  204.      3. Modify  the  control file 'MX.CTL'. Please consult the  'MX Control
  205.      File' section for more information on the syntax of MX.CTL. 
  206.  
  207.      4. Create the directory indicated as your MX Export path in MX.CTL. 
  208.  
  209.      5. Run MX_AREAP.EXE to construct the MX specific areas data file. 
  210.  
  211.      6. Modify the mail packing batch file(pack.cmd) as appropriate. 
  212.  
  213.      7. Modify  the mail downloading batch file(dload.cmd) as  appropriate.
  214.      See my comments in dload.cmd about non-locked ports.
  215.  
  216.      'Dload.cmd'  supplied  with  this  package  is  designed  to work with
  217.      M2Zmodem by Mikael Wahlgren.
  218.  
  219.  
  220.      8. Modify  your  BBS's  menus  to  call  up MX and pass all  necessary
  221.      command line options to MX. For Example,
  222.  
  223.  
  224.        * I have it set up on my Messages menu in the Maximus MENUS.CTL as:
  225.  
  226.                  Xtern_Run d:\MX\MXP.exe_%L_-t%k Normal "Xpress Mail"
  227.  
  228.            Maximus will translate:
  229.  
  230.                 %L into either '-K' or '-Pn -bxxxx'
  231.                    depending on whether the caller is remote or not.
  232.  
  233.                 %k into the task number of this node.
  234.  
  235.      
  236.  
  237.      9.  Make  sure you read the section titled 'What you Should Know About
  238.      MX' towards the end of this document. 
  239.  
  240.      10. Modify the custom header file 'MX.INC' if you wish.
  241.  
  242.      ┌────────────────────────────────────────────────────────────────────┐
  243.      │ TASK NUMBER?!?                                                     │
  244.      │ --------------                                                     │
  245.      │                                                                    │
  246.      │ * If you run a single line Maximus BBS and haven't specified a     │
  247.      │   'Task' number in your MAX.CTL, then LEAVE OUT the '-t%k' in      │
  248.      │    the above example.                                              │
  249.      │                                                                    │
  250.      │   MX  uses the '-T' command line switch to find out which          │
  251.      │   'lastus??.BBS' to use.                                           │
  252.      │                                                                    │
  253.      │   For example:                                                     │
  254.      │                                                                    │
  255.      │         * If '-T' is ABSENT from the command line then MX would    │
  256.      │           look for 'Lastuser.bbs' for more info on the current     │
  257.      │           caller.                                                  │
  258.      │                                                                    │
  259.      │         * If '-T1' is present on the command line then MX would    │
  260.      │           look for 'Lastus01.bbs' for more info on the current     │
  261.      │           caller.                                                  │
  262.      │                                                                    │
  263.      └────────────────────────────────────────────────────────────────────┘
  264.  
  265.      
  266.  
  267.      MX_AREA - MX Areas Info File Construction Utility 
  268.      ------------------------------------------------- 
  269.      MX  makes uses  of  a  simplified data  file(mx_area.dat) which  holds
  270.      information on each message area. 
  271.  
  272.      MX_AREAp  is  used  to  translate  an  already  compiled Maximus areas
  273.      information  file  (eg. area.dat) into the simplified MX specific area
  274.      file. 
  275.  
  276.  
  277.  
  278.             Command line options of MX_AREAp
  279.             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  280.  
  281.             MX_AREAp -Afilename
  282.  
  283.             -A ,where filename is the full path and file name of the
  284.                compiled Maximus Areas information file.
  285.  
  286.                Eg. MX_AREAp -Ad:\max\area.dat
  287.  
  288.      
  289.  
  290.      MX_UDEL - The MX Users Database Maintenance Utility 
  291.      -------------------------------------------------- 
  292.  
  293.      The MX users information database maintained by MX comes in two parts: 
  294.  
  295.              MX_USER.IDX  This is the index file for the MX user info file.
  296.  
  297.              MX_USER.DAT  This is the actual data file used to hold various
  298.                           information on each user of MX.
  299.  
  300.      
  301.  
  302.      You  can  run  MX_UDELp  once in a while to remove old caller-accounts
  303.      from the MX users information database. 
  304.  
  305.  
  306.             Command line syntax of MX_UDELp
  307.             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  308.  
  309.             MX_UDELp n
  310.  
  311.  
  312.             Where n is an integer number.
  313.  
  314.             Callers who hasn't used MX for 'n' days would be removed from the
  315.             MX Users Database.
  316.  
  317.      
  318.  
  319.  
  320.      MX Control File Syntax: 
  321.      ^^^^^^^^^^^^^^^^^^^^^^^ 
  322.  
  323.        Key Words:
  324.        ----------
  325.  
  326.              Lastuser_Path
  327.                              This tells MX where to find your 'lastus??.bbs'
  328.                              files. The 'lastus??.bbs' files are written out
  329.                              by Maximus each time an external program is
  330.                              called from within Maximus.
  331.  
  332.                              MX make use of these files to find out the
  333.                              callers' names, time remaining etc.
  334.  
  335.                              For example,
  336.  
  337.                                  LASTUSER_PATH    E:\MAX\
  338.  
  339.  
  340.              Export_Path
  341.                              This tells MX where to put its exported message
  342.                              text file.
  343.  
  344.                              For example,
  345.  
  346.                                  EXPORT_PATH      E:\MAX\MX\DLOAD\
  347.  
  348.  
  349.              MSG_Limit priv n
  350.  
  351.                              This option defines the MAXIMUM number of
  352.                              messages that MX is to export for each class of
  353.                              callers.
  354.  
  355.                              For example,
  356.  
  357.                                  MSG_Limit       Twit        100
  358.                                  MSG_Limit       Disgrace    100
  359.                                  MSG_Limit       Limited     100
  360.                                  MSG_Limit       Normal      500
  361.                                  MSG_Limit       Worthy      600
  362.                                  MSG_Limit       Privil      600
  363.                                  MSG_Limit       Favored     600
  364.                                  MSG_Limit       Extra       600
  365.                                  MSG_Limit       Clerk       600
  366.                                  MSG_Limit       AsstSysop   800
  367.                                  MSG_Limit       Sysop      1000
  368.  
  369.              PACKER ext cmd : Desc
  370.  
  371.                              This option defines the type of file compressor
  372.                              that you'll be supporting on your MX system.
  373.  
  374.                              You may define upto 5 packers for use with MX.
  375.                              The first one defined would be used as the
  376.                              default.
  377.  
  378.                              ext    defines what file name extension to use
  379.                                     for this archiver.
  380.  
  381.                              cmd    the hotkey used to activate this option.
  382.  
  383.                              Desc   defines what MX should display on the
  384.                                     archiver preference menu.
  385.  
  386.                              For example,
  387.  
  388.                                  PACKER ARC A : Arc   v6.0
  389.                                  PACKER ZIP Z : PKzip v1.01
  390.                                  PACKER LZH L : Lharc
  391.                                  PACKER TXT N : No compression
  392.  
  393.                              Note:
  394.                              -----
  395.                                  Where cmd is 'N', NO compression would be
  396.                                  applied.
  397.  
  398.  
  399.              PROTOCOL cmd : Desc
  400.  
  401.                              This option defines the type of file transfer
  402.                              protocols that you'll be  supporting on your
  403.                              MX system.
  404.  
  405.                              You may define upto 10 external protocols.
  406.                              The first one defined would be used as the
  407.                              default.
  408.  
  409.                              cmd    the hotkey used to activate this option.
  410.  
  411.                              Desc   defines what MX should display on the
  412.                                     protocol selection menu
  413.  
  414.  
  415.                              For example,
  416.  
  417.                                  PROTOCOL X : Xmodem
  418.                                  PROTOCOL Y : Ymodem
  419.                                  PROTOCOL G : Ymodem/G
  420.                                  PROTOCOL 1 : Xmodem1K
  421.                                  PROTOCOL Z : Zmodem
  422.  
  423.      
  424.  
  425.      WHAT YOU SHOULD KNOW ABOUT MX 
  426.      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  427.  
  428.      *  The  'Protocol' definition in MX.CTL with the hotkey 'X' is ASSUMED
  429.      to be Xmodem. Xmodem has a rather low throughput rate of approximately 
  430.      73% of the true baud rate. This is accounted for in the calculation of 
  431.      the time required to transfer the compressed mail bundle. 
  432.  
  433.      *  The  'Protocol' definition in MX.CTL with the hotkey 'Z' is ASSUMED
  434.      to  be  Zmodem. Zmodem has a good throughput rate of approximately 96%
  435.      of the true baud rate. This is accounted for in the calculation of the 
  436.      time required to transfer the compressed mail bundle. 
  437.  
  438.      *  All  other  protocols  defined  in  MX.CTL  are  assumed  to be 90%
  439.      efficient.  This should serve as a good average for most file transfer
  440.      protocols. 
  441.  
  442.      *  MX_AREAp would ONLY convey the base-level access information to MX.
  443.      In  other  words,  ONLY  what you defined as 'MessageAccess'  in  your
  444.      Maximus  Areas.Ctl are  observed.  The  notion of 'Barricaded' message
  445.      areas are NOT supported by MX.
  446.  
  447.      * After ANY restructuring of your message areas, MAKE SURE that you: 
  448.  
  449.           1) Delete the MX user database files, AND
  450.           2) Run MX_AREAp again AFTER you've recompiled your Maximus
  451.              Areas.ctl
  452.  
  453.      Although  Step  '1'  can  be  skipped  for  the mere additions of more
  454.      message areas AND/OR change of paths.
  455.  
  456.  
  457.  
  458.      Hard-coded Error levels of MX 
  459.      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  460.  
  461.            255: Fatal error. You should  take note of the error message on
  462.                 the screen.
  463.  
  464.      
  465.  
  466.  
  467.      -=[WELL, THAT'LL BE ALL FOLKS]=- 
  468.  
  469.  
  470.      Future enhancement, bug report etc.
  471.      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  472.  
  473.      Netmail  me your wish list and bug reports, and I'll see what I can do
  474.      in the next version. 
  475.  
  476.      Please  send  in  those  post-cards,  they  serve  as an incentive for
  477.      further developments in this BBS utility program. 
  478.  
  479.      Post cards should be directed to: 
  480.  
  481.                       Mr. David Luong
  482.                       308/232 Pitt Street,
  483.                               Waterloo, N.S.W. 2017
  484.                               Australia.
  485.  
  486.  
  487.