home *** CD-ROM | disk | FTP | other *** search
/ Carsten's PPE Collection / Carstens_PPE_Collection_2007.zip / F / FIDOQ122.ZIP / FIDOQWK.DOC < prev    next >
Text File  |  1994-07-05  |  20KB  |  551 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                FidoQWK v1.21 (July 5, 1994)
  11.                           FidoNet(tm) <=> QWK echomail converter
  12.                     Copyright (C) 1992-1994 Simple Solutions Software
  13.                                    All Rights Reserved
  14.  
  15.  
  16.               FidoQWK is supported by:
  17.  
  18.                                        Geoffrey Sy
  19.                                   1322-14 Blevins Place
  20.                                    Toronto, ON  M5A 3M5
  21.                                           Canada
  22.  
  23.               INTERNET: geoffrey.sy@sshq.tor250.org, FIDONET: 1:250/814
  24.  
  25.               CAP/CANADA      (416) 287-0935 (v.32b/v.FC) 
  26.                               (416) 287-0234 (v.32b)      Conference #4
  27.               CAP/USA         (708) 854-0255 (v.32b/v.FC)
  28.  
  29.               The best source for getting the latest version and support is
  30.               my  support BBS.  If you  can't reach the support BBS, please
  31.               call  the other  sources  listed below.    The FidoQWK  files
  32.               and/or me can be found on these systems.
  33.                
  34.               Systems where FidoQWK can be found:
  35.  
  36.                Toronto Pronet 2   1-905-683-3733 v32bis
  37.                Data Project       1-905-683-3733 HST/v32b
  38.  
  39.               Some of the above systems may  allow download after call-back
  40.               verification (Listed in order of ease of access).
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  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.               ═════[INTRODUCTION]══════════════════════════════════════════
  71.                                                                           
  72.               FidoQWK is for anyone running a FidoNet compatible BBS system
  73.               and wants to carry any .QWK type  nets or vice versa.  It can
  74.               also be used for QWK door to QWK door mail transfer.
  75.  
  76.               The basic concept for FidoNet *.MSG <=> QWK transfer:
  77.  
  78.                  FidoNet *.MSG => BBS_ID.REP => QWK Mail door =>
  79.                  QWK mail door => BBS_ID.QWK => FidoNet *.MSG
  80.  
  81.               Additional step(s) may be required to convert from your BBS's
  82.               native message format into  the standard FidoNet *.MSG format
  83.               and vise versa.  
  84.  
  85.               If  Fido *.MSG  is not  desirable, FidoQWK  also  support the
  86.               FidoNet type 2 packet format  in either StoredMail or ArcMail
  87.               format,  I'll refer to this  format as .PKT  here.  The basic
  88.               concept for .PKT <=> QWK transfer follows:
  89.  
  90.                  FidoNet .PKT  => BBS_ID.REP => QWK Mail door =>
  91.                  QWK mail door => BBS_ID.QWK => FidoNet .PKT
  92.  
  93.               For situations where  a QWK  mail door is  available on  both
  94.               BBS, QWK2REP will allow mail transfers between the doors:
  95.  
  96.                  HOSTBBS.QWK => THISBBS.REP => This BBS mail door =>
  97.                  THISBBS.QWK => HOSTBBS.REP => Host BBS mail door
  98.  
  99.               In  this documentation I'm assuming  that you know  how to do
  100.               this as well as the basic  concept of echomail transfers.  If
  101.               you  are  not  sure,  leave  a  message  on  the  appropriate
  102.               conference  on  the  echo,  the  SysOps  conference  on  most
  103.               echomail network is usually appropriate.
  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.               ═════[OVERVIEW]══════════════════════════════════════════════
  132.                                                                            
  133.               There  are 5 modules to the FidoQWK package.  There's FQSETUP
  134.               that sets up the needed data for the other modules.  
  135.  
  136.               The  MSG2REP module packs the  *.MSG files into  a REP packet
  137.               for uploading to a QWK mail door.  The QWK2MSG module unpacks
  138.               the QWK  packet and tosses  *.MSG files into  the appropriate
  139.               message areas.  The PURGE module  is used to delete all *.MSG
  140.               files in the message areas.
  141.  
  142.               The QWK2REP module  allows conversion of one  BBS's .QWK mail
  143.               packet  into another BBS's .REP  packet.  It  lets BBSes with
  144.               QWK  mail  doors to  exchange  messages  in situations  where
  145.               echomail processors for the BBSes don't exist.
  146.  
  147.               In summary:
  148.  
  149.                    FQSETUP.EXE  - Sets up data files for all modules.
  150.  
  151.               For Fido *.MSG <=> QWK, the following modules are needed:
  152.  
  153.                    MSG2REP.EXE  - Packs *.MSG into a REP packet for sending
  154.                                   out to the host BBS.
  155.                    QWK2MSG.EXE  - Inserts messages from the host BBS into
  156.                                   your BBS.
  157.                    PURGE.EXE    - Wipes out all *.MSG files for a BBS.
  158.  
  159.               For FidoNet .PKT <=> QWK, the following modules are needed:
  160.  
  161.                    PKT2REP.EXE  - Converts FidoNet .PKT  into a REP  packet
  162.                                   for sending to the QWK mail door.
  163.                    QWK2PKT.EXE  - Convert QWK to FidoNet .PKT.
  164.  
  165.               For QWK door <=> QWK door:
  166.  
  167.                    QWK2REP.EXE   - Converts .QWK  packet from one  BBS to a
  168.                                   .REP  packet  for  uploading  to  another
  169.                                   BBS's QWK mail door.
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.               _____________________________________________________________
  184.               FidoQWK echomail processor documentation ................. 3
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.               ═════[FQSETUP]═══════════════════════════════════════════════
  193.  
  194.               When FQSETUP is executed a menu with 3 options will be shown.
  195.               If the  help system was  completed, the  F1 key calls  up the
  196.               context-sensitive help items.  Option 'A' sets up the general
  197.               information.  These general information includes:
  198.  
  199.                  1 - Your name
  200.                  2 - Registration key (if you're registered)
  201.                  3 - Serial number    (if you're registered)
  202.  
  203.                  4 - The location where you want FidoQWK to create the
  204.                      BBS_ID.REP package.
  205.                  5 - The location where you've downloaded the host BBS's   
  206.                      BBS_ID.QWK mail package.
  207.                  6 - The location where FidoQWK can store its temporary 
  208.                      work files.  A RAM or fast hard disk is recommended.
  209.                  7 - The location to store inbound FidoNet .PKT packets.
  210.                  8 - The location to store outbound FidoNet .PKT packets.
  211.  
  212.               Option 'B' sets up the data compressor characteristics.  Each
  213.               compressor definition requires the following information:
  214.  
  215.                  1 - The make and model of the compressor
  216.                  2 - The full pathname (including extension) and switches 
  217.                      needed to compress a file.
  218.                  3 - The full pathname (including extension) and switches 
  219.                      needed to de-compress a file.
  220.                  4 - The ASCII value of  the first byte found in files that
  221.                      have been compressed with  this compressor.  This will
  222.                      be used for detection of the compressed file type.
  223.  
  224.               Option  'C' sets up  host BBS information  and message bases.
  225.               These options include:
  226.  
  227.                  1 - The name of the .QWK packet (Host ID).
  228.                  2 - The BBS name of the host.
  229.                  3 - The tagline of the host BBS to be placed on all 
  230.                      incoming messages.
  231.                  4 - The compressor type used on this BBS.
  232.  
  233.                  5 - The tagline to be placed on all outgoing messages.
  234.  
  235.               There  may  be features  not  documented  here, press  F1  in
  236.               FQSETUP to display additional help.  To insert more host BBS,
  237.               press Alt-I.  To delete a host BBS, press Alt-D.  To locate a
  238.               host BBS, press  F4.  To repeat the same data  for a new BBS,
  239.               press Alt-D.   The  Page Up  and Page  Down keys  selects the
  240.               previous and next host BBS. Press the F2 key at anytime while
  241.               under  option 'C' to edit  the message base  names and paths.
  242.               These include:
  243.  
  244.               _____________________________________________________________
  245.               FidoQWK echomail processor documentation ................. 4
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.                  1 - The conference number used on the host BBS.
  254.                  2 - The name of the message area.
  255.  
  256.                  3 - The location on your hard drive to store these   
  257.                      messages.
  258.                  4 - The last message sent to the host BBS.
  259.                  5 - The last message written to disk by FidoQWK.
  260.  
  261.               The available functions are listed  above, press the Esc  key
  262.               to return to the previous function.
  263.  
  264.               ═════[MSG2REP/QWK2MSG/QWK2REP/QWK2PKT/PKT2REP]═══════════════
  265.  
  266.               To  use the above modules,  type the module  name followed by
  267.               the host BBS ID.
  268.  
  269.               EXAMPLES:
  270.  
  271.               To toss messages from BBS_ID.QWK packet to Fido *.MSG:
  272.                                             QWK2MSG BBS_ID [switches]
  273.  
  274.               To scan messages from Fido *.MSG into BBS_ID.REP:
  275.                                             MSG2REP BBS_ID [switches]
  276.  
  277.               To convert from HOSTBBS.QWK to THISBBS.REP:
  278.                                             QWK2REP HOSTBBS /IN [switches]
  279.  
  280.               To convert from THISBBS.QWK to HOSTBBS.REP:
  281.                                             QWK2REP HOSTBBS /OUT [switches]
  282.  
  283.               SWITCHES:
  284.  
  285.               The following switches are available to all modules:
  286.  
  287.                 /NS - No Shell:
  288.               Use this option to tell FidoQWK not to run the compression or
  289.               decompression programs.   Be sure to  manually decompress the
  290.               QWK  packet into  FidoQWK's  work directory  when using  this
  291.               option.   The resultant BBS_ID.MSG  will need to  be manually
  292.               compressed into BBS_ID.REP also.
  293.  
  294.                 /SWAP /EMS - Swap out when shelling:
  295.               Use these options to  swap to disk or EMS when  executing the
  296.               compression utilities.
  297.  
  298.                 /FS - Full Screen shell:
  299.               Use this option to execute the compression utilities in full-
  300.               screen  mode. This  should be  used in  situations when  your
  301.               compression  utility  writes  all  over  the screen.  FidoQWK
  302.               normally  executes  the  compression  utilities  in  a  small
  303.               window.
  304.  
  305.               _____________________________________________________________
  306.               FidoQWK echomail processor documentation ................. 5
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.                 /TF:      - Translate the "FROM:" field in the messages:
  315.               Ex:  /TF:SYSOP=GEOFFREY;SY would  replace  any occurrence  of
  316.               'SYSOP' from the "FROM:" fields with 'GEOFFREY SY'
  317.  
  318.                 /TT:      - Translate the "TO:" field in messages:
  319.               Ex: /TT:SYSOP=GEOFFREY;SY  would  replace any  occurrence  of
  320.               'SYSOP' from the "TO:" fields with 'GEOFFREY SY'
  321.  
  322.  
  323.               The following switches are available to MSG2REP only:
  324.  
  325.                 /IS - Ignore Sent Marker:
  326.               Normally MSG2REP will NOT send messages that have been marked
  327.               as sent.  Use this message if your messages aren't being sent
  328.               out.
  329.  
  330.                 /IP - Ignore last scanned pointers:
  331.               Normally  MSG2REP  will scan  *.MSG  files  from the  highest
  332.               number it scanned  last.  This may  not be desirable  in some
  333.               cases.  Use this switch to scan all available *.MSG packets. 
  334.  
  335.               The following  switches are available to  MSG2REP and PKT2REP
  336.               modules:
  337.  
  338.                 /NoSEENBY - Strip FidoNet 'SEEN-BY: ' lines.
  339.  
  340.                 /NoOrigin - Strip FidoNet '* Origin: ', lines.
  341.  
  342.               The following switches are available to PKT2REP module only:
  343.  
  344.                 /FSPEC:ArcSpec;PktSpec:
  345.               Normally PKT2REP use the specs *.DA? for compressed and *.PKT
  346.               for uncompressed mail packets.   The .DA? extension indicates
  347.               where the first 2 letters of day of the week and a number  or
  348.               letter  0-Z.   Use  this to  change  the mail  packet  search
  349.               specification.  The default is  spec is /FSPEC:*;*.PKT.   The
  350.               compressed mail packet (ArcSpec) can be any DOS wildcard name
  351.               up  to  8 characters,  the  .DA?  extension is  automatically
  352.               appended.   ArcSpec  may  be preceeded  by  a directory  (ie:
  353.               /FSPEC:d:\path\ArcSpec;PktSpec) to tell  FidoQWK to look  for
  354.               the  mail  packet  in  that  directory  instead  of  the  one
  355.               specified  in FQSetup.  The semicolon is used to separate the
  356.               filespecs.   The uncompressed  mail packets (PktSpec)  can be
  357.               any  DOS wildcard name up  to 13 characters  and must include
  358.               file extension.
  359.  
  360.               The following switches are available to QWK2* modules only:
  361.  
  362.                 /MULTI - Process multiple .QWK packets:
  363.               This  option processes all mail  packets from a  BBS found in
  364.               the  QWK directory.   The  packets must  use the  .QW? naming
  365.  
  366.               _____________________________________________________________
  367.               FidoQWK echomail processor documentation ................. 6
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.               method (ie: BBSID.QWK, BBSID.QW0, BBSID.QW?).
  376.  
  377.                 /MSIZE:n - Maximum message size for QWK2PKT:
  378.               The size  of the messages written  to the PKT can  be limited
  379.               using  the this option.   The size can  be anything from 1024
  380.               bytes to 64384 bytes,  the default is 64384 bytes.   Messages
  381.               larger  than the  specified  size gets  chopped into  several
  382.               small messages.  This option will help anyone struggling with
  383.               the small  message  size limit  imposed  on their  Fido  mail
  384.               tossers.
  385.  
  386.                 /TAG - Causes QWK2MSG to append standard Fidonet Origin and
  387.               Seen-By lines to messages it processed.
  388.  
  389.                 /OUT:d:\out.100   - Causes QWK2PKT to write the .PKT packet
  390.               to  an alternate  output directory.  The above  example would
  391.               send the  packet to the  D:\OUT.100 directory instead  of the
  392.               outbound directory in the FidoQWK configuration file.
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.               _____________________________________________________________
  428.               FidoQWK echomail processor documentation ................. 7
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.               ═════[FREQUENTLY ASKED QUESTIONS]════════════════════════════
  437.  
  438.               Q: FidoQWK can't find messages when it opens my .QWK packet.
  439.               A: Does your .QWK packet contain index (*.NDX) files?    
  440.                  Did you tell FidoQWK where your compression utilities are?
  441.  
  442.               Q: FidoQWK is tossing messages to the wrong areas.
  443.               A: In some network environment, FidoQWK may not be able to
  444.                  delete files in its work directory.  Make sure FidoQWK's
  445.                  work directory is empty before running FidoQWK.
  446.  
  447.               Q: My screen gets messed up when FidoQWK runs my compression
  448.                  utility.
  449.               A: Run FidoQWK with the /FS switch to tell it to give-up
  450.                  screen control to the compression program.
  451.  
  452.               Q: My mail tosser didn't pick up the new messages in the new 
  453.                  area I created.  It scaned the area, but didn't pack the  
  454.                  new messages QWK2MSG tossed there.
  455.               A: Some tossers look for the local attribute bit in the *.MSG
  456.                  files.  Only messages with this bit turned on gets packed.
  457.                  All attribute bits can be set through FQSETUP;  Press F3  
  458.                  while you're editing the message area in FQSETUP to change
  459.                  the attribute bits for that area.
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.               _____________________________________________________________
  489.               FidoQWK echomail processor documentation ................. 8
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.               ═════[REGISTRATION/SUPPORT]══════════════════════════════════
  498.  
  499.               If you have questions,  bugs, comments or suggestions, please
  500.               contact me.  I may be  reached on the PCBoard, Doors, OffLine
  501.               conferences on City2City(tm), Intelec(tm), and ILink(tm), the
  502.               PCBNet  and Offline conference on FidoNet(tm).  I can also be
  503.               reach  on my  support BBS  or by mail  to the  above address.
  504.               Registered users  of my other shareware  packages may contact
  505.               me using the voice number in the registration document.
  506.  
  507.               Since FidoQWK  is user supported software, I don't expect you
  508.               to register if you don't like it or if it doesn't meet your
  509.               needs.  Just stop  using it after a reasonable  trial period.
  510.               The  program is not crippled in any  way, however, there is a
  511.               short delay at the exit of the program when unregistered.  
  512.  
  513.               FidoQWK  is an  on-going  project, it  will  be enhanced  and
  514.               updated as long as I can financially afford to do so.  If you
  515.               like the program  and use it  regularly, please register  it.
  516.               The registration cost is a one-time  fee of $25.00.  With the
  517.               registration  you'll  receive  unlimited  voice  support  and
  518.               upgrades.   Your registration encourages further development,
  519.               enhancement and my continued support of the product.   Please
  520.               send your registration in the form of a Money Order, Personal
  521.               cheque, or Cashier's cheque to the above address.
  522.  
  523.               ═════[STANDARD DISCLAIMER]═══════════════════════════════════
  524.  
  525.               This program is provided on an "AS IS" basis.  No warranty of
  526.               any kind is expressed  or implied.  I take  no responsibility
  527.               for  any damage caused directly or indirectly from the use or
  528.               the  inability to  use this  program.   Only features  in the
  529.               current .EXE, including bugs, critters and anything else that
  530.               might be pressent, are available to the users.  Users are not
  531.               to expect future upgrades or additional features. The program
  532.               will not  change to suit the needs of the users if such needs
  533.               change  in  the  future.   By  using  this  program the  user
  534.               automatically accepts these terms and conditions.
  535.  
  536.               ═════[CREDITS/COPYRIGHTS]════════════════════════════════════
  537.  
  538.               QWK  and Qmail  are Copyrights  of  Mark "Sparky"  Herring of
  539.               Sparkware, the original creator of QWK.
  540.  
  541.               Fido and  FidoNet  are trademarks  of  Tom Jennings  of  Fido
  542.               Software.
  543.  
  544.               Other: Respected copyright/trademark holders.
  545.  
  546.  
  547.  
  548.  
  549.               _____________________________________________________________
  550.               FidoQWK echomail processor documentation ................. 9
  551.