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