home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / comm / misc / 020 / fidoqwk.doc < prev    next >
Encoding:
Text File  |  1993-04-17  |  15.1 KB  |  429 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                               FidoQWK v1.15 (April 18, 1993)
  11.                           FidoNet(tm) <=> QWK echomail processor
  12.                              Copyright (C) 1992,3 Geoffrey Sy
  13.                                    All Rights Reserved
  14.  
  15.  
  16.               FidoQWK is supported by:
  17.  
  18.                Geoffrey Sy                       Toronto Twilight BBS
  19.                51 Wyatt Walk                     1-416-733-9012
  20.                Toronto, Ontario  CANADA          Join conference #16
  21.                M5A 3T3
  22.  
  23.               ═════[INTRODUCTION]══════════════════════════════════════════
  24.                                                                           
  25.               FidoQWK is for anyone running a FidoNet compatible BBS system
  26.               and wants to carry any .QWK type nets or vice versa.   It can
  27.               also be used for QWK door to QWK door mail transfer.
  28.  
  29.               The basic concept for FidoNet <=> QWK tranfer:
  30.  
  31.                  FidoNet *.MSG => BBS_ID.REP => QWK Mail door =>
  32.                  QWK mail door => BBS_ID.QWK => FidoNet *.MSG
  33.  
  34.               Additional step(s) may be required to convert from your BBS's
  35.               native message format into  the standard FidoNet *.MSG format
  36.               and vise versa.  
  37.  
  38.               For situations where  a QWK  mail door is  available on  both
  39.               BBS, QWK2REP will allow mail transfers between the doors:
  40.  
  41.                  HOSTBBS.QWK => THISBBS.REP => This BBS mail door =>
  42.                  THISBBS.QWK => HOSTBBS.REP => Host BBS mail door
  43.  
  44.               In  this documentation I'm assuming  that you know  how to do
  45.               this as well as the basic  concept of echomail transfers.  If
  46.               you  are  not  sure,  leave  a  message  on  the  appropriate
  47.               conference  on  the  echo,  the  SysOps  conference  on  most
  48.               echomail network is usually appropriate.
  49.                                                            
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.               _____________________________________________________________
  62.               FidoQWK echomail processor documentation ................. 1
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.               ═════[OVERVIEW]══════════════════════════════════════════════
  71.                                                                            
  72.               There  are 5 modules to the FidoQWK package.  There's FQSETUP
  73.               that sets up the needed data for the other modules.  
  74.  
  75.               The  MSG2REP module packs the  *.MSG files into  a REP packet
  76.               for uploading to a QWK mail door.  The QWK2MSG module unpacks
  77.               the QWK  packet and tosses  *.MSG files into  the appropriate
  78.               message areas.  The PURGE module  is used to delete all *.MSG
  79.               files in the message areas.
  80.  
  81.               The QWK2REP module  allows conversion of one  BBS's .QWK mail
  82.               packet  into another BBS's .REP  packet.  It  lets BBSes with
  83.               QWK  mail  doors to  exchange  messages  in situations  where
  84.               echomail processors for the BBSes don't exist.
  85.  
  86.               In summary:
  87.  
  88.                    FQSETUP.EXE  - Sets up data files for all modules.
  89.  
  90.               For Fido *.MSG <=> QWK, the following modules are needed:
  91.  
  92.                    MSG2REP.EXE  - Packs *.MSG into a REP packet for sending
  93.                                   out to the host BBS.
  94.                    QWK2MSG.EXE  - Inserts messages from the host BBS into
  95.                                   your BBS.
  96.                    PURGE.EXE    - Wipes out all *.MSG files for a BBS.
  97.  
  98.               For QWK door <=> QWK door:
  99.  
  100.                    QWK2REP.EXE   - Converts .QWK  packet from one  BBS to a
  101.                                   .REP  packet  for  uploading  to  another
  102.                                   BBS's QWK mail door.
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.               _____________________________________________________________
  123.               FidoQWK echomail processor documentation ................. 2
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.               ═════[FQSETUP]═══════════════════════════════════════════════
  133.  
  134.               When FQSETUP is executed a menu with 3 options will be shown.
  135.               If  the help system  was completed, the  F1 key  calls up the
  136.               context-sensitive help items.  Option 'A' sets up the general
  137.               information.  These general information includes:
  138.  
  139.                  1 - Your name
  140.                  2 - Registration key (if you're registered)
  141.                  3 - Serial number    (if you're registered)
  142.  
  143.                  4 - The location where you want FidoQWK to send the 
  144.                      BBS_ID.REP package.
  145.                  5 - The location where you've downloaded the host BBS's   
  146.                      BBS_ID.QWK mail package.
  147.                  6 - The location where FidoQWK can store its temporary 
  148.                      work files.  A RAM or fast hard disk is recommended.
  149.  
  150.               Option 'B' sets up the data compressor characteristics.  Each
  151.               compressor definition requires the following information:
  152.  
  153.                  1 - The make and model of the compressor
  154.                  2 - The full pathname (including extension) and switches 
  155.                      needed to compress a file.
  156.                  3 - The full pathname (including extension) and switches 
  157.                      needed to de-compress a file.
  158.                  4 - The ASCII value of the first byte found  in files that
  159.                      have been compressed with  this compressor.  This will
  160.                      be used for detection of the compressed file type.
  161.                    (* NOTE: Automatic detection of compressed file type has
  162.                            not yet been programmed into v1.00 of FidoQWK *)
  163.  
  164.               Option 'C' sets  up host BBS  information and message  bases.
  165.               These options include:
  166.  
  167.                  1 - The name of the .QWK packet (Host ID).
  168.                  2 - The BBS name of the host.
  169.                  3 - The tagline of the host BBS to be placed on all 
  170.                      incoming messages.
  171.                  4 - The compressor type used on this BBS.
  172.  
  173.                  5 - The tagline to be placed on all outgoing messages.
  174.  
  175.               There  may  be  features  not documented  here,  press  F1 in
  176.               FQSETUP to display additional help.  To insert more host BBS,
  177.               press Alt-I.  To delete a host BBS, press Alt-D.  To locate a
  178.               host BBS,  press F4.  To repeat the  same data for a new BBS,
  179.               press  Alt-D.  The  Page Up  and Page  Down keys  selects the
  180.               previous and next host BBS. Press the F2 key at anytime while
  181.               under  option 'C' to edit  the message base  names and paths.
  182.  
  183.               _____________________________________________________________
  184.               FidoQWK echomail processor documentation ................. 3
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.               These include:
  193.  
  194.                  1 - The conference number used on the host BBS.
  195.                  2 - The name of the message area.
  196.  
  197.                  3 - The location on your hard drive to store these   
  198.                      messages.
  199.                  4 - The last message sent to the host BBS.
  200.                  5 - The last message written to disk by FidoQWK.
  201.  
  202.               The available functions are  listed above, press the Esc  key
  203.               to return to the previous function.
  204.  
  205.               ═════[MSG2REP/QWK2MSG/QWK2REP]═══════════════════════════════
  206.  
  207.               MSG2REP: Scans *.MSG from your BBS to send to the host BBS
  208.  
  209.               QWK2MSG: Inserts messages from the host BBS into your BBS
  210.  
  211.               To  use the above modules,  type the module  name followed by
  212.               the host BBS ID.
  213.  
  214.               EXAMPLES:
  215.  
  216.               To toss messages from BBS_ID.QWK packet to Fido *.MSG:
  217.  
  218.                 QWK2MSG BBS_ID [switches]
  219.  
  220.               To scan messages from Fido *.MSG into BBS_ID.REP:
  221.  
  222.                 MSG2REP BBS_ID [switches]
  223.  
  224.               To convert from HOSTBBS.QWK to THISBBS.REP:
  225.  
  226.                 QWK2REP HOSTBBS /IN [switches]
  227.  
  228.               To convert from THISBBS.QWK to HOSTBBS.REP:
  229.  
  230.                 QWK2REP HOSTBBS /OUT [switches]
  231.  
  232.               SWITCHES:
  233.  
  234.               The following switches are available to all modules:
  235.  
  236.                 /NS - No Shell:
  237.                    Use  this  option  to  tell  FidoQWK  not  to  run   the
  238.                    compression/decompression programs.  Be sure to manually
  239.                    decompress the  QWK packet into FidoQWK's work directory
  240.                    when using  this option.  The  resultant BBS_ID.MSG will
  241.                    need to be manually compressed into BBS_ID.REP also.
  242.  
  243.  
  244.               _____________________________________________________________
  245.               FidoQWK echomail processor documentation ................. 4
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.                 /SWAP /EMS - Swap out when shelling:
  254.                    Use  these options to swap to disk or EMS when executing
  255.                    the compression utilities.
  256.  
  257.                 /FS - Full Screen shell:
  258.                    Use this option to  execute the compression utilities in
  259.                    full-screen mode. This should be used in situations when
  260.                    your  compression utility  writes all  over the  screen.
  261.                    FidoQWK normally executes the compression utilities in a
  262.                    small window.
  263.  
  264.                 /TF:      - Translate the "FROM:" field in the messages:
  265.                    Ex: /TF:SYSOP=GEOFFREY;SY would  replace any  occurrence
  266.                    of 'SYSOP' from the "FROM:" fields with 'GEOFFREY SY'
  267.  
  268.                 /TT:      - Translate the "TO:" field in messages:
  269.                    Ex: /TT:SYSOP=GEOFFREY;SY would  replace any  occurrence
  270.                    of 'SYSOP' from the "TO:" fields with 'GEOFFREY SY'
  271.  
  272.  
  273.               The following switches are available to MSG2REP only:
  274.  
  275.                 /IS - Ignore Sent Marker:
  276.                    Normally MSG2REP  will NOT send messages  that have been
  277.                    marked  as  sent.   Use  this message  if  your messages
  278.                    aren't being sent out.
  279.  
  280.                 /IP - Ignore last scanned pointers:
  281.                    Normally MSG2REP will scan  *.MSG files from the highest
  282.                    number  it scanned last.   This may not  be desirable in
  283.                    some cases.  Use this switch to scan all available *.MSG
  284.                    packets. 
  285.  
  286.                 /NoSEENBY - Strip FidoNet 'SEEN-BY: ' lines.
  287.  
  288.                 /NoOrigin - Strip FidoNet '* Origin: ', lines.
  289.  
  290.               The following switches are available to QWK2* modules only:
  291.  
  292.                 /MULTI - Process multiple .QWK packets:
  293.                    This option processes all mail packets from a  BBS found
  294.                    in the QWK  directory.   The packets must  use the  .QW?
  295.                    naming method (ie: BBSID.QWK, BBSID.QW0, BBSID.QW?).
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.               _____________________________________________________________
  306.               FidoQWK echomail processor documentation ................. 5
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.               ═════[FREQUENTLY ASKED QUESTIONS]════════════════════════════
  315.  
  316.               Q: QWK2MSG can't find messages when it opens my .QWK packet.
  317.               A: Does your .QWK packet contain index (*.NDX) files?
  318.                  Did you tell FidoQWK where your compression utilities are?
  319.  
  320.               Q: QWK2MSG is tossing messages to the wrong areas.
  321.               A: In some network environment, FidoQWK may not be able to
  322.                  delete files in its work directory.  Make sure FidoQWK's
  323.                  work directory is empty before running QWK2MSG.
  324.  
  325.               Q: My screen gets messed up when FidoQWK runs my compression
  326.                  utility.
  327.               A: Run FidoQWK with the /FS switch to tell it to give-up
  328.                  screen control to the compression program.
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.               _____________________________________________________________
  367.               FidoQWK echomail processor documentation ................. 6
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.               ═════[REGISTRATION/SUPPORT]══════════════════════════════════
  376.  
  377.               If you have questions,  bugs, comments or suggestions, please
  378.               contact me.  I may be  reached on the PCBoard, Doors, OffLine
  379.               conferences on City2City(tm), Intelec(tm), and ILink(tm), the
  380.               PCBNet  and Offline conference on FidoNet(tm).  I can also be
  381.               reach  on  my  support BBS  or  by  snail-mail  to the  above
  382.               address. Registered users of any one of my shareware packages
  383.               may  contact me using  the voice  number in  the registration
  384.               document.
  385.  
  386.               Since FidoQWK is user supported  software, I don't expect you
  387.               to register if you don't like it or if it doesn't meet your
  388.               needs. Just stop using it after a reasonable trial period
  389.               (1-2 weeks). The program is not crippled in any way, there is
  390.               a few seconds delay at the exit of the program.  
  391.  
  392.               FidoQWK  is  an on-going  project,  as  with all  programming
  393.               projects,  it will never be finished.   I have a long list of
  394.               features I'm ready to  implement, but your support is  needed
  395.               if these features are to be implemented.  I have to know that
  396.               I'm not wasting my time and efforts on this, if  you find the
  397.               program useful, please send your support.
  398.  
  399.               If you like the program and use it regularly, please register
  400.               it. The registration cost is a  one-time fee of $20.00.  With
  401.               the registration you'll receive  unlimited voice support  and
  402.               upgrades. Your registration  encourages further  development,
  403.               enhancement and  my continued support of the product.  Please
  404.               send your registration in the form of a Money Order, Personal
  405.               cheque, or Cashier's cheque to the above address.
  406.  
  407.               ═════[STANDARD DISCLAIMER]═══════════════════════════════════
  408.  
  409.               This program  is provided on an "AS IS" basis. No warranty of
  410.               any kind is expressed or implied. YOU USE THIS PROGRAM AT
  411.               YOUR OWN RISK. I take no responsibility for any damage caused
  412.               directly or indirectly from  the use or the inability  to use
  413.               this program.
  414.  
  415.               ═════[CREDITS/COPYRIGHTS]════════════════════════════════════
  416.  
  417.               QWK/Qmail:  Copyrights of Mark "Sparky" Herring of
  418.               Sparkware, the original creator of QWK.
  419.  
  420.               "Fido", "FidoNet":  U.S.   registered   trademarks   of   Tom
  421.               Jennings of Fido Software.
  422.  
  423.               Other: Respected copyright/trademark holders.
  424.  
  425.  
  426.  
  427.               _____________________________________________________________
  428.               FidoQWK echomail processor documentation ................. 7
  429.