home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / OFFLINE / QWKRQ10.ZIP / QWKREQ.DOC < prev    next >
Text File  |  1994-01-09  |  48KB  |  1,058 lines
  1.  
  2.  
  3.                   ───────────────────────────────────────                 
  4.                           ╗   ╔                       
  5.                           ║   ║                        
  6.                           ╠═══╣╒══╕╞══╕╒══╕╒══╕╤══╕    
  7.                           ║   ║╒══╡│  ││  │╒══╡│       
  8.                           ╝   ╚╘══╛╛  ╛╘══╡╘══╛╧       
  9.                                        └──┘ 
  10.                               ONLINE SERVICES
  11.                   ───────────────────────────────────────                 
  12.  
  13.                            QwkRequest Version 1.0
  14.  
  15.              An Automatic File & Information Request Program 
  16.                                for AutoReq
  17.  
  18.                Copyright (C) 1993,1994 by Jason Hyland and
  19.                           Hangar Online Services
  20.  
  21.        19 Chantry Drive, Worle, Weston-Super-Mare, Avon. BS22 OPP.
  22.                          BBS (44) (0) 934 511751
  23.  
  24.                            All Rights Reserved
  25.  
  26.  
  27.  
  28.      QwkRequest v1.0                                      WHAT IS IT ?                    
  29.      ─────────────────────────────────────────────────────────────────
  30.      What Is It ?
  31.  
  32.      You know what its like when you use a BBS for mail and on the odd
  33.      occasion you require a file. Or when you just want to view one of 
  34.      the Bulletins, or grab a list of conferences available. You have 
  35.      to log into the BBS manually and search for the file then download 
  36.      it, or if its a bulletin, you need to capture the screen. This can
  37.      be a real pain at the best of times, especially if you use an 
  38.      automated mail run script / program, or are just terminally lazy 
  39.      like me ! Well thanks to AutoRequest (see later) and QwkRequest, 
  40.      you now have no need to !
  41.      
  42.      QwkRequest allows you to browse or search a BBS File List and tag
  43.      files for download. You can request to be sent a message containing
  44.      a list of conferences, or request a bulletin. If the SysOp of the 
  45.      BBS you are requesting from has provided you with a '.MGC' file
  46.      for his system, you can request virtually any information about the
  47.      BBS or your account (subscription details, current download ratio,
  48.      logins etc). 
  49.      
  50.      QwkRequest generates specially formatted requests to AutoRequest in
  51.      a standard format REP packet (appending to any existing replies
  52.      you may have). You can then upload your REP packet as normal. 
  53.      Most BBS's running AutoRequest will process your requests once
  54.      a day (The Hangar BBS processes requests at 6am). Normally your 
  55.      requested files or information will be available in the next QWK
  56.      packet you download.
  57.      
  58.      Some of the features you'll find in QwkRequest;
  59.  
  60.         o Easy to use and consistent user interface
  61.         o Smooth integration with SLMR and OLX
  62.         o Work easily with ALL QWK/REP format Offline Mail Readers
  63.         o Appends to any existing REP packets
  64.         o Can run standalone without an OLR
  65.         o Multiple BBS File Lists Supported
  66.         o Fast indexed databases provide quick access to file areas
  67.         o PKZIP/PKUNZIP and ARJ compression supported
  68.         o Fast searches across multiple areas
  69.         o Password protected files are requestable
  70.         o Context sensitive help
  71.         o Request up to 50 files in one REP packet (registered)
  72.         o Fully supports AutoRequest 'Automated Information
  73.           Service' and 'Magic Requests'
  74.         o Configurable colours (can use OLX/SLMR colours)
  75.         
  76.      .... and there are plenty more !        
  77.  
  78.         
  79.  
  80.      QwkRequest v1.0                             WHAT IS AUTOREQUEST ?
  81.      ─────────────────────────────────────────────────────────────────
  82.      What Is AutoRequest ?
  83.  
  84.      QwkRequest came about because of the excellent and innovative
  85.      program produced by Adam Stevens at AddTech Consultancy Ltd for
  86.      Wildcat! SysOps called AutoRequest (AutoReq). Adam describes
  87.      Autorequest as;
  88.   
  89.        "........  a  WildCat!  3.xx  SysOp utility  which enables
  90.         users to  download requested  files automatically  within
  91.         their TomCat  QWK packets.  All the user needs  to do  is 
  92.         send  a message  to a  user called  "FILE REQUEST",  with
  93.         the name of the file  he wants to receive  in the subject
  94.         line." 
  95.          
  96.      but it also allows;
  97.     
  98.        ".... the Sysop to  configure AutoRequest so that the user
  99.         just has to send a message to FILE REQUEST with a subject
  100.         line beginning  with  a  forward  slash to  automatically
  101.         receive, as a  message, any  text file  you want  to make
  102.         available."
  103.         
  104.      AutoRequest runs on your SysOp's BBS normally once a day.  Some 
  105.      BBS's will run Autorequest much more - it depends on how many 
  106.      requests are generated and is controlled by the BBS SysOp. If your
  107.      SysOp doesn't currently run AutoRequest, QwkRequest will be of no
  108.      value to you. But then again, if your SysOp _isn't_ running 
  109.      AutoRequest, do you really want him to stay as your SysOp ?
  110.      
  111.      Full details on where you or your SysOp can obtain AutoRequest are
  112.      available in the REGISTER.DOC file within this archive.
  113.  
  114.      
  115.         
  116.      QwkRequest v1.0                                    USER INTERFACE
  117.      ─────────────────────────────────────────────────────────────────
  118.      User Interface
  119.      
  120.      QwkReq has been designed to provide a clear and easy user interface.
  121.      Many of the keys used are "common standards". Windows (or as I've
  122.      now grown to call them - "picklists") provide the standard display 
  123.      method. Each window has a "title" in the top left hand corner 
  124.      which describes what is contained therein. All windows are scrollable.
  125.      This means that what you see on the screen is just a "window" on
  126.      the data - if the data in the window (a list of files for example)
  127.      doesn't fit, you can scroll though the data.
  128.      
  129.      The last line displayed on your screen will always display the
  130.      key you need to press to get context sesitive help. This "status"
  131.      line also displays some other useful information;
  132.      
  133.       BBS Id    -  Displays the BBS Id that the current File List is
  134.                    from, and the BBS Id that will be used when generating
  135.                    requests.
  136.                 
  137.       Request   -  Requests from this file list will be entered in the
  138.       Conference   conference displayed here. You should check with
  139.                    your SysOp what conference to use.
  140.      
  141.      Some keys are common to ALL windows which allow you to select 
  142.      data. These keys are;
  143.      
  144.       F1        -  Context sensitive help. Each window has different
  145.                    functions, and therefore different keys perform
  146.                    different actions. Pressing F1 will display a list
  147.                    of the keys and their uses in the current window.
  148.                  
  149.       F2       -   About. Displays the "About" screen which shows
  150.                    current version and support contact details.
  151.                    
  152.       Down     -   Move the selection bar down one item in the 
  153.       Arrow        current window.
  154.       
  155.       Up       -   Move the selection bar up one item in the 
  156.       Arrow        current window.
  157.  
  158.       Page     -   Move the selection bar down one page in the
  159.       Down         current window.
  160.       
  161.       Page     -   Move the selection bar up one page in the
  162.       Up           current window.
  163.  
  164.       Home     -   Move the selection bar to the first item in the
  165.                    current window
  166.                    
  167.       End      -   Move the selection bar to the last item in the
  168.                    current window
  169.                    
  170.      Most windows also include a rudimentary "search" option. For example
  171.      in the files window (which lists all files for a selected area), 
  172.      pressing "P" will move the selection bar (starting at the current 
  173.      position) to the next item starting with "P".
  174.  
  175.      
  176.      
  177.      QwkRequest v1.0                               SYSTEM REQUIREMENTS                    
  178.      ─────────────────────────────────────────────────────────────────
  179.      System Requirements
  180.  
  181.      QwkRequest has been tested on a number of different machines without
  182.      problems, and runs fine on anything from an 8088 to a 486. Memory
  183.      requirement is very much dependent on the number of files contained
  184.      in the filelist. QwkRequest currently has an in built maximum of
  185.      2000 files per area. This is quite simply to prevent QwkRequest from
  186.      blowing out if a huge area is selected without enough free RAM. I do
  187.      intend to look at using EMS to remove this limit. I would suggest 
  188.      that minimum RAM free to run QwkRequest is in the region of 400k. 
  189.      QwkRequest has configurable colours, so will run fine on a colour or
  190.      mono monitor.
  191.      
  192.      QwkRequest _requires_ that your compression / decompression programs
  193.      are accessible via your PATH environment variable, or they reside
  194.      in the _same_ directory as QwkRequest.
  195.  
  196.      Before you can run QwkRequest, you will need at least one of the
  197.      following from the BBS that you wish to request files from;
  198.      
  199.         o A BBS File List (Standard WCPRO format - speak to your
  200.           SysOp if you aren't too sure about this)
  201.         o A standard QWK mail packet from the Tomcat mail door. 
  202.           
  203.      You need the file list for obvious reasons. The QWK packet is
  204.      required because QwkRequest needs to know certain information about
  205.      the system that it is going to generate REP packets for.
  206.      
  207.      If you are going to use the "Magic Requests" feature, you will need to
  208.      obtain the '.MGC' (or "MAGIC FILE") file from the BBS also.
  209.  
  210.      Your SysOp can help provide you with all of these items if you have
  211.      a problem. Please don't contact me asking where you can obtain them !
  212.  
  213.      
  214.  
  215.      QwkRequest v1.0                                     CONFIGURATION
  216.      ─────────────────────────────────────────────────────────────────
  217.      Configuration
  218.      
  219.      QwkRequest should be unpacked / installed into its own working
  220.      directory. Whilst it is entirely possible for it to run in some other
  221.      directory, it is far tidier and less prone to problems to install it
  222.      in its own directory, perhaps C:\QWKREQ (as is used in the examples
  223.      here).
  224.  
  225.      Unpack the QwkRequest archive into the C:\QWKREQ directory. Make sure
  226.      that your compression / decompression programs are either in your
  227.      PATH environment variable, or in C:\QWKREQ.
  228.      
  229.      If you are a registered user, copy your QWKREQ.KEY registration key 
  230.      file into the same directory. 
  231.      
  232.      If you are an SLMR or OLX user read the following sections. If you 
  233.      use other mail readers or intend to use QwkRequest as a standalone
  234.      program, skip to 'Other OLR / No OLR'.
  235.      
  236.  
  237.      SLMR / OLX Users.
  238.  
  239.      QwkRequest has been written specifically with SLMR/OLX in mind. I have
  240.      tried to make QwkRequest integrate with these OLR's as seemlessly
  241.      and painlessly as possible. QwkRequest will read the configuration
  242.      file from either OLR and use the settings therein for the following;
  243.      
  244.         o QWK Packet Directory
  245.         o REP Packet Directory
  246.         o Colours
  247.         
  248.      For QwkRequest to read the CONFIG.MR or CONFIG.OLX configuration file
  249.      from these mail readers, it needs to know where your mail reader
  250.      configuration file is. QwkRequest uses the environment variable
  251.      "QWKREQ" for this purpose. For example, if your OLX mail reader is
  252.      installed in the directory C:\OLX you need to set the environment
  253.      variable as follows;
  254.      
  255.      SET QWKREQ=C:\OLX\
  256.      
  257.      This environment variable needs to be set _before_ running QwkRequest
  258.      and should normally be placed in your AUTOEXEC.BAT. If you fail to
  259.      set this variable, QwkRequest will look in its own directory for
  260.      the CONFIG.OLX / CONFIG.MR file. If the file is not found, QwkRequest
  261.      assumes default colours and the QWK & REP Packet directory to be
  262.      QwkRequest's own directory.
  263.      
  264.      Changing the colours or packet paths in QwkRequest is simply a 
  265.      matter of changing them within your mail reader !
  266.      
  267.      Skip now to 'Creating a File List Database'
  268.      
  269.      
  270.      Other OLR / No OLR
  271.      
  272.      QwkRequest doesn't _require_ a configuration file, but one will 
  273.      normally be used. If you do not use a configuration file, QwkRequest
  274.      will assume default colours and the QWK & REP Packet directory will be
  275.      set to QwkRequest's own directory. This is not normally the case.
  276.      
  277.      QwkRequest reads a config file in the current directory (or looks for
  278.      it in a directory pointed at by the QWKREQ environment variable) called
  279.      'CONFIG.MR'. This file is a text file which contains configuration
  280.      information. The following is an example of the CONFIG.MR file;
  281.      
  282.      ;
  283.      ; Example CONFIG.MR File
  284.      ;
  285.      QWK = C:\TELIX\DOWNLOAD
  286.      ;
  287.      REP = C:\TELIX\DOWNLOAD
  288.      ; 
  289.     
  290.      The above example simply set the QWK and REP Packet directory to
  291.      equal C:\TELIX\DOWNLOAD. This is where QwkRequest will look for
  292.      packets when you initially generate a file list database, and where
  293.      it will store request REP files. 
  294.      
  295.      Colour Definitions
  296.  
  297.      The configuration file may also contain colour definition variables
  298.      which define the colours of various item on screen. These are;
  299.      
  300.                       BORDER  =  Windows Border
  301.                       HEADER  =  Function Keys
  302.                       SCROLL  =  Scroll Bars
  303.                    HIGHLIGHT  =  Selection Bar
  304.                      MESSAGE  =  Alert or Message Box 
  305.                       WINDOW  =  Windows Text 
  306.                         HELP  =  Help Display
  307.                       STATUS  =  Status Bar
  308.                       BUTTON  =  Options Buttons
  309.                       
  310.      Any of these may be used in the configuration file. Here's an
  311.      example of a black and white colour set;
  312.      
  313.      ;
  314.      ; Black & White / Mono Colours
  315.      ;
  316.      WINDOW    = 0F
  317.      BORDER    = 07
  318.      HEADER    = 70
  319.      SCROLL    = 07
  320.      BUTTON    = 70
  321.      HIGHLIGHT = 70
  322.      MESSAGE   = 70
  323.      HELP      = 70  
  324.      STATUS    = 70
  325.      ;
  326.      
  327.      Colour values must be entered in HEX. The colour value is calculated
  328.      as follows;
  329.  
  330.          color attribute value =
  331.               foreground color value + (16 * background color value)
  332.  
  333.      Colour values;
  334.      
  335.                      Black = 00        Dark Grey = 08
  336.                       Blue = 01       Light Blue = 09
  337.                      Green = 02      Light Green = 10
  338.                       Cyan = 03       Light Cyan = 11
  339.                        Red = 04        Light Red = 12
  340.                    Magenta = 05    Light Magenta = 13 
  341.                      Brown = 06           Yellow = 14
  342.                 Light Grey = 07            White = 15
  343.      
  344.      Therefore, a Yellow character on a Blue background would have a colour
  345.      attribute value of (14 + (16 * 1)) = 30. Just remember to convert 
  346.      this number to HEX !
  347.  
  348.      This is all the configuration that QwkRequest needs.
  349.      
  350.  
  351.      
  352.      QwkRequest v1.0                     CREATING A FILE LIST DATABASE
  353.      ─────────────────────────────────────────────────────────────────
  354.      Creating A File List Database
  355.      
  356.      QwkRequest reads a standard BBS file list and produces its own
  357.      'indexed' version in its home directory. After this database has
  358.      be created, the file list is no longer needed. New file lists from
  359.      BBS's already setup in QwkRequest can be used to overwrite and
  360.      therefore update a file list database.
  361.      
  362.      If you have a '.MGC' file from your BBS, make sure this is now copied
  363.      into QWKREQ's directory.
  364.      
  365.      If you were to execute QWKREQ now, you will be presented with a 
  366.      message telling you that you can't run QwkRequest without applying
  367.      a file list first. This is what we need to do first.
  368.      
  369.      Make sure that you have unpacked the file list - QwkRequest reads the
  370.      text file list,  it cannot read the archived file.
  371.      
  372.      Start QwkRequest with the full path / filename of the file list. For
  373.      example;
  374.      
  375.                       QWKREQ C:\DOWNLOAD\HANGAR.TXT
  376.      
  377.      Please make sure that you specify the _full_ pathname to the file
  378.      list bbs - do not use directory defaults on other disks like
  379.      for example, C:HANGAR.TXT.
  380.      
  381.      QwkRequest will now start. You are presented with a "picklist" and
  382.      asked to select a QWK packet from the BBS that the file list you are
  383.      using came from. If you cannot see a QWK packet for the correct
  384.      BBS, press ESCape to end QwkRequest, and recheck your configuration.
  385.      
  386.      Note that the "BBS Id" has been updated to reflect the choice.
  387.      
  388.      The required information will be extracted from this mail packet, and
  389.      you will then be asked to select a conference from the displayed
  390.      "picklist". This picklist displays all the conferences from the
  391.      selected BBS's QWK packet, and you are required to select the 
  392.      conference that QwkRequest will use when generating REP requests.
  393.      It is important that you check with the SysOp which conference he
  394.      recommends using for requests - if you select the wrong conference
  395.      here it cannot be changed without recreating the file list database.
  396.      Some BBS's allow requests in any conference, others restrict you to 
  397.      one specific conference.
  398.      
  399.      Once you have selected the Request Conference QwkRequest will display
  400.      
  401.                 'HANGAR.TXT has not been applied before.'
  402.      
  403.      and after you have pressed a key to confirm this message;
  404.      
  405.           'The filelist HANGAR.TXT will be applied to BBS HANGAR'
  406.      
  407.      (obviously the file list name and BBS name will reflect your BBS).
  408.      QwkRequest maintains a list of files it has processed in the past
  409.      and their BBS Id's. This is so that in a future version you will
  410.      be able to 'update' your database list with other more recent file
  411.      lists (or 'new files lists') without specifying a QWK packet. This
  412.      feature has not yet been implemented.
  413.  
  414.      QwkRequest then displays that it is generating a file list database.
  415.      This can take sometime depending on the size of the file list. As
  416.      an estimate, it generates roughly 140 file entries per seconds on
  417.      a 25Mhz 386sx. Once this has finished you are taken straight into
  418.      QwkRequest's Main Screen. Press ESC to exit this for now.
  419.  
  420.      QwkRequest generates 4 files for each filelist. These are;
  421.      
  422.                BBS_ID.DAT  -  File List Database
  423.                BBS_ID.IDX  -  File List Database Index
  424.                BBS_ID.ARX  -  File List Area Index
  425.                BBS_ID.CNF  -  BBS Conference List
  426.      
  427.      If any one of the first three of these files are corrupted or deleted
  428.      the whole database becomes unusable. Delete any remaning files for
  429.      this BBS and recreate the database.
  430.      
  431.      
  432.  
  433.      QwkRequest v1.0                STARTING QWKREQUEST OUTSIDE AN OLR
  434.      ─────────────────────────────────────────────────────────────────
  435.      Starting QwkRequest Outside An OLR
  436.      
  437.      For now we will concentrate on getting used to QwkRequest in it's
  438.      'standalone' mode, that doesn't run within an OLR. See 'Integrating
  439.      with SLMR/OLX' for information on how to start QwkRequest within
  440.      your OLR.
  441.      
  442.      QwkRequest can now be started up by just entering QWKREQ in the
  443.      QwkRequest Directory (although QwkRequest can be started outside
  444.      its directory if the its directory is in the PATH variable), without
  445.      specifiying a file list filename or switches.
  446.      
  447.      QwkRequest Switches
  448.      
  449.      QwkRequest has a number of switches that can be used to control
  450.      various settings within the program. To see what switches are now
  451.      available enter QWKREQ /? for a full list. The two switches that
  452.      are relevant in this mode are;
  453.      
  454.        /o      -   Use original colours. Tell QwkRequest to ignore
  455.                    any colour changes in your CONFIG file.
  456.                 
  457.        /c:xyz  -   Override the default conference for Requests, for any 
  458.                    BBS you may select. The conference is set the the
  459.                    value 'xyz'
  460.      
  461.      
  462.      Starting QwkRequest
  463.      
  464.      Start QwkRequest by entering QWKREQ in QwkRequest's own directory.
  465.      
  466.      You will be presented with a "picklist" where you are asked to select
  467.      the database file list. Listed is _not_ the file list name, but the
  468.      BBS Id for that file list. If there is more that one database on
  469.      disk you may select which to use. Select by moving the selection bar
  470.      up and down, then pressing ENTER on the database to use.
  471.      
  472.      QwkRequest will read the database and then open up its main "work"
  473.      windows. These are;
  474.      
  475.        File Areas     - This window lists all the file areas in the
  476.                         database along with the number of files in each
  477.                         area.
  478.      
  479.        Tagged Files   - This windows will list all the files that are
  480.                         currently 'tagged' for download for this system
  481.                         in the current REP packet.
  482.                       
  483.        Magic Requests - This window displays the default set of Magic
  484.                         Requests, along with any from the BBS '.MGC'
  485.                         file (obtainable from your SysOp).
  486.                       
  487.  
  488.  
  489.      QwkRequest v1.0               MOVING AROUND AND MAKING SELECTIONS
  490.      ─────────────────────────────────────────────────────────────────
  491.      Moving Around And Making Selections
  492.      
  493.      Navigating the Windows
  494.      
  495.      Once you have entered QwkRequest's Main Work area with the three
  496.      standard windows displayed, you have a number of new keys available
  497.      to use. These are available in any of the three windows;
  498.      
  499.        TAB    -  Use the TAB key to jump between the different windows
  500.                  on the screen. The currently selected window will be the
  501.                  windows with the selection bar visible.
  502.                       
  503.        F6     -  Jump to the File Area's window
  504.        
  505.        F7     -  Jump to the Tagged Files window
  506.        
  507.        F8     -  Jump to the Magic Requests windows
  508.        
  509.        F10    -  Generate request for this BBS. This will generate the
  510.                  specially formatted messages for AutoRequest, and write
  511.                  or append them to your .REP file.
  512.                
  513.        ALT&E  -  Manually enter a filename to request for download.
  514.  
  515.        ESC    -  Quit QwkRequest to DOS.
  516.        
  517.      Using the ESC option to quit with requests that have not yet be
  518.      generated will result in QwkRequest asking you if you need to generate
  519.      the requests before quitting.
  520.      
  521.      Making Selections By Tagging
  522.  
  523.      To select a file, move to the file areas windows and select the
  524.      area you wish to browse. Do this by highlighting the area with the
  525.      selection bar and pressing ENTER.
  526.      
  527.      You will now see the File Selection window, displaying details about 
  528.      all the files in the selected area. Details show here are;
  529.      
  530.            File Name, File Size, File Date, Summary Description
  531.          
  532.      If you wish to see additional information about the file (such
  533.      as the full description, number of downloads so far, last download
  534.      date,) highlight the appropriate file and press the SPACE bar.
  535.      
  536.      To tag a file for download highlight the required file and press the
  537.      ENTER key. You will then be asked if you wish to enter a password for
  538.      this file. Some files in a file area may be password protected. If
  539.      you select a file for download that is password protected, and do
  540.      not give the correct password, AutoRequest will send you a message
  541.      telling you that the request has failed due to an invalid password.
  542.      
  543.      Select Yes or No by either moving the box to the apropriate option
  544.      by using the RIGHT and LEFT arrow keys or the SPACE bar, or by
  545.      pressing 'Y' or 'N' key. Pressing ESC assumes that no password is
  546.      required.
  547.  
  548.      Pressing ESC from the File Selection window will return you to
  549.      the File Areas window. You'll notice that any files you have tagged
  550.      will be displayed in the Tagged Files window.
  551.      
  552.      Manually Entering A Filename
  553.      
  554.      If you already know the filename of the file that you want to request,
  555.      you can use the Manual enter facility rather than browsing and tagging.
  556.      From any of the three main windows select manual entry by pressing
  557.      ALT & E.
  558.      
  559.      You are asked to enter a valid filename, with a maximum of 12 
  560.      characters. You will then be asked if you wish to enter a password for
  561.      this file. Some files in a file area may be password protected. If
  562.      you select a file for download that is password protected, and do
  563.      not give the correct password, AutoRequest will send you a message
  564.      telling you that the request has failed due to an invalid password.
  565.      
  566.      You'll notice that the file you have entered will be displayed in the
  567.      Tagged Files window.
  568.      
  569.      Deleting A Tagged File
  570.      
  571.      If you have tagged a file by mistake, or just have changed your mind
  572.      about requesting it, you can delete the request. Move to the Tagged
  573.      Files windows, highlight the appropriate file request and press
  574.      the DEL key. The request will be deleted from the list.
  575.  
  576.  
  577.  
  578.      QwkRequest v1.0                            SEARCHING THE DATABASE
  579.      ─────────────────────────────────────────────────────────────────
  580.      Searching The Database
  581.      
  582.      QwkRequest offers a search facility to locate a particular file for
  583.      you. This search function is only available from the File Areas
  584.      window by pressing ALT & S.
  585.                
  586.      QwkRequest will now ask the type of search you wish to perform by
  587.      asking 'Search just the filename (much faster) ?'. If you select
  588.      to search just the filename for the search text, QwkRequest performs
  589.      an index search which is far faster. Otherwise QwkRequest will have
  590.      to do a full database scan.
  591.      
  592.      You are now prompted to enter a search string of no more than 20
  593.      characters. Case is not important - the search transends case.
  594.      
  595.      A window similar to the Files Selection window is displayed. Whilst
  596.      QwkRequest searches the database/index, it will display "SEARCHING
  597.      FILES' in the window area. The window title will display the current
  598.      search string.
  599.      
  600.      When the search has completed the files matching will be displayed.
  601.      This window now functions in an identical manner to the File
  602.      Selections window with the following exceptions;
  603.      
  604.         F10 no longer functions as Generate Requests; ALT & E no
  605.         longer functions as Manually Request File.
  606.      
  607.      Pressing ENTER for selecting a file for download, or SPACE to view
  608.      more information still function identically. Pressing ESC will 
  609.      return you to the File Areas Window.
  610.  
  611.      
  612.      
  613.      QwkRequest v1.0                               GENERATING REQUESTS
  614.      ─────────────────────────────────────────────────────────────────
  615.      Generating Requests
  616.      
  617.      Simply having the files in your tagged list will not create the
  618.      requests. To generate the request messages, you must press the
  619.      F10 key from either of the three main windows. 
  620.      
  621.      When QwkRequest starts, it will read any current REP packet for
  622.      any current requests (either manual ones you have entered via 
  623.      your OLR, or ones previously created by QwkRequest), and make
  624.      sure these are displayed in the Tagged Files Window.
  625.      
  626.      When QwkRequest generates the request file, it will append to
  627.      any current replies packet you may have. This reply packet can
  628.      be a normal standard reply packet, with your replies contained
  629.      in it. Generating involves rewriting the .MSG file and then
  630.      repacking using a compression program.
  631.  
  632.      If you try to quit QwkRequest with 'unsaved' requests you will
  633.      be asked if you want to generate the requests before exiting. The
  634.      default YES will generate the request REP packet then exit.
  635.      
  636.      
  637.  
  638.      QwkRequest v1.0                         INTEGRATING WITH SLMR/OLX
  639.      ─────────────────────────────────────────────────────────────────
  640.      Integrating with SLMR/OLX
  641.  
  642.      QwkRequest works very well on its own, but its even better with
  643.      SLMR/OLX. You do need to make a few changes to your SLMR/OLX
  644.      configuration, but I don't think its too taxing !
  645.      
  646.      The way QwkRequest is integrated with SLMR/OLX is by asking if
  647.      you want to generate any file requests when you select a QWK 
  648.      packet for reading from the main QWK Packet menu. Unfortunately due
  649.      to the way SLMR/OLX maintains a 'memory image' or REP replies,
  650.      it is not possible to run QwkRequest from withing SLMR/OLX when the
  651.      packet has been opened. If you do, unpredictable results _WILL_
  652.      occur !
  653.  
  654.      Load up SLMR/OLX and select the configuration screen. Select the 
  655.      'Packers' configuration screen. SLMR/OLX will display a list of
  656.      packers and the commands that it uses to execute them.
  657.      
  658.      You need to select the UNPACKER for the unpacking program you
  659.      use. For example PKUNZIP. The unpacker option will normally say;
  660.      
  661.         PKUNZIP !
  662.         
  663.      and you will need to change this to;
  664.      
  665.         QRUNZIP.BAT !
  666.         
  667.      Save your config, then double check it !!
  668.      
  669.      You now need to create the QRUNZIP.BAT file IN THE SAME DIRECTORY
  670.      AS SLMR/OLX. The batch file will look like this;
  671.      
  672.      @echo off
  673.      REM
  674.      REM This batch file is used to intergrate QwkReq with OLX or SLMR
  675.      REM
  676.      REM Check if unpacking QWK or REP (REP unpacking passes 2 params!)
  677.      REM
  678.      if "%2"=="" goto RunQR
  679.      goto UZip
  680.      :RunQR
  681.      REM
  682.      REM Ensure that use specify the path to QWKREQ, and DO NOT change
  683.      REM directory to it !! Or stick QwkReq in the path ....
  684.      REM
  685.      C:\QWKREQ\QWKREQ /M:%1
  686.      :UZip
  687.      REM
  688.      REM Get on with decompression.
  689.      REM
  690.      PKUNZIP %1 %2
  691.      REM
  692.      REM End of QRUNZIP.BAT
  693.      
  694.      You will obviously need to change the 'PKUNZIP' to 'ARJ e' if you 
  695.      are using ARJ instead of PKUNZIP. Also make sure that the path to
  696.      QWKREQ.EXE is correct.
  697.  
  698.      How it works
  699.      
  700.      When you start SLMR/OLX and select a QWK packet for unpacking, you
  701.      load QwkRequest, passing the QWK packet name to it. QwkRequests will
  702.      check that a file list database exists for this packet. If it doesn't,
  703.      QwkRequest will simply exit.
  704.      
  705.      If QwkRequest finds a database, you will be asked
  706.      
  707.                'Do you want to generate any file requests?'
  708.      
  709.      Pressing 'Y' or selecting the YES button and pressing return will
  710.      automatically load QwkRequest. You WILL NOT be asked for the 
  711.      file database list to use, because QwkRequest is clever enough to
  712.      pick the correct one for you.
  713.      
  714.      QwkRequest now functions exactly the same as in 'standalone' mode.
  715.      When you exit QwkRequest, you'll continue to unpack the QWK packet
  716.      in SLMR/OLX and continue there as normal. You will notice the new
  717.      replies that QwkRequest has generated for you !
  718.  
  719.  
  720.  
  721.      QwkRequest v1.0                                    MAGIC REQUESTS
  722.      ─────────────────────────────────────────────────────────────────
  723.      Magic Requests
  724.      
  725.      Magic Requests are a niffty idea. They benefit both the user and
  726.      the SysOp. They benefit the user because of the ease of selecting 
  727.      them, and the use of "standard" requests. For example, how often
  728.      have you logged onto a BBS and wanted the filelist. Is is called
  729.      FILELIST.ZIP ? ALLFILES.ZIP ? HANGAR.ZIP ? or any one of a 100 
  730.      other different ideas that SysOps have. Wouldn't it be nice for a
  731.      user to just say "I want a File List!| and be done with it ? Well,
  732.      QwkRequest and AutoRequest make this dream come true!
  733.      
  734.      If you're a SysOp you know how demanding running a BBS can be. If
  735.      you're like me, you spend a fair amount time sending new users FAQ
  736.      files, or details of subs, or any number of other bits of
  737.      information. The problem is you have to do it over and over again!
  738.      Now you as a SysOp can setup a .MGC file to have QwkRequest and
  739.      Autorequest cut down on all that (some say unproductive) time you
  740.      spend on it.
  741.      
  742.      In QwkRequest's main work area you will see a window called Magic
  743.      Requests with at least five entries in it (these are hard coded
  744.      for the sake of trying to implement some common standard!). These
  745.      request generate the following request;
  746.      
  747.         AutoReq Help Message      -   Ask AutoRequest at the BBS end
  748.                                       to send you a help message detailing
  749.                                       how to use AutoRequest.
  750.                                       
  751.         BBS File List             -   Ask AutoRequest to send you a full
  752.                                       file list
  753.                                       
  754.         BBS Subscription Details  -   Ask AutoRequest to send you a message
  755.                                       detailing subscription schemes and
  756.                                       costs.
  757.                                       
  758.         Bulletins Available       -   Ask AutoRequest to send you a message
  759.                                       listing all the bulletins carried on
  760.                                       the BBS
  761.                                       
  762.         Mail Area Conference      -   Ask AutoRequest to send you a message
  763.         Listing                       listing all the message conferences
  764.                                       on the BBS
  765.                                       
  766.      There may well be other Magic requests there - it depends if the
  767.      SysOp has created a '.MGC' file and if you have it in the QWKREQ
  768.      directory. 
  769.      
  770.      Magic File Support For SysOps
  771.      
  772.      If you are a SysOp using AutoRequest I hope you will support these
  773.      Magic requests - they offer some excellent benefits to you and your
  774.      users.
  775.      
  776.      To start with you should support the 5 default magic requests as
  777.      detailed above. These generate the following 'Request' on the
  778.      Subject Line of the request message;
  779.      
  780.                   AutoReq Help Message  -  /HELP
  781.                          BBS File List  - //FILELIST
  782.               BBS Subscription Details  - /SUBS
  783.                    Bulletins Available  - /BULL
  784.               Mail Conferences Listing  - /CONFLIST
  785.      
  786.      The /HELP message is in built to AutoRequest. The others need to be
  787.      Configured, which means that your AUTOREQ.XRF file should look something
  788.      like this;
  789.      
  790.      ;
  791.      HANGAR.ZIP,FILELIST
  792.      ;
  793.      Messages:
  794.      ;
  795.      J:\WC30\MSGS\SUBSINFO.TXT,SUBS
  796.      J:\WC30\BULLS.LST,BULL
  797.      J:\WC30\CONFLIST.TXT,CONFLIST
  798.      ;
  799.      
  800.      Note that FILE REQUEST just need the filename as it appears in the 
  801.      WildCat Database. Messages require a pathname ! See your AUTOREQ.DOC
  802.      for full details.
  803.  
  804.      Additional AUTOREQ.XRF entries should be made for any .MGC entry you may
  805.      make.
  806.      
  807.      '.MGC' File Format for SysOps.
  808.      
  809.      If you want to let your users benefit from the extensive possibilities
  810.      that Magic Requests offer, you need to create a '.MGC' file for your
  811.      users to download. The format of the '.MGC' file is;
  812.      
  813.      ;
  814.      ; Example .MGC file for The Hangar BBS (44) (0) 934 511751 24hrs
  815.      ; 
  816.      /USER,User Account Details
  817.      /TIMETAB,Events Timetable & Mailruns
  818.      /TOPTEN,Hangar Top Tens
  819.      /RULES,The Hangar Rules !!
  820.      /SECLEV,Security Access Levels
  821.      //FAQ,Frequently Asked Questions File
  822.      /NETMAIL,How to Send Netmail
  823.      
  824.      The magic 'code' is entered before the ',' (comma), and the description
  825.      is entered after it. No spaces are allowed between the comma and the
  826.      code or description. The code is limited to 14 characters in total, and
  827.      the description is limited to 35 characters (it gets chopped if longer).
  828.  
  829.           
  830.      
  831.      QwkRequest v1.0                    SETTING UP YOUR TOMCAT ACCOUNT                    
  832.      ─────────────────────────────────────────────────────────────────
  833.      Setting Up Your Tomcat Account
  834.      
  835.      To use QwkRequest and AutoRequest you _must_ have file attachments
  836.      enabled in the Tomcat Offline Mail Door. Select Tomcat from your
  837.      BBS, then select [C]onfigure your settings (Press 'C'!)
  838.      
  839.      Select the [A]ttachment size limit, and you will be asked;
  840.      
  841.      Enter maximum attachment size limit in Kbytes: 
  842.      
  843.      Enter the maximum size of the file you are likely to request. After 
  844.      entering this, and by pressing ENTER you will be asked;
  845.      
  846.      Do you want to include attachments to [A]ll or just to [Y]ou ?
  847.      
  848.      Enter 'Y' for just your attachments. Quit the Configuration screen and
  849.      exit Tomcat. You are now setup for File Requests !
  850.  
  851.  
  852.      
  853.      QwkRequest v1.0                                      REGISTRATION
  854.      ─────────────────────────────────────────────────────────────────
  855.      Registration
  856.      
  857.      QwkRequest is Shareware. This means that your are licensed to try
  858.      it out for a reasonable length of time, after which if you continue
  859.      to use it, you should register it with me. Details of how to 
  860.      register and the costs of registration are in the REGISTER.DOC
  861.      which accompanies this archive.
  862.      
  863.      QwkRequest uses a 'Key' file for registered users. Registered users
  864.      benefit because;
  865.      
  866.         o You are not limited to 5 requests per packet.
  867.         o The message generated by QwkRequest is much shorter. This will
  868.           please your SysOp !
  869.         o The warm feeling you'll get for helping me to produce even
  870.           more helpful programs for peanuts !
  871.         o 24hrs Support via my Bristol based BBS
  872.         
  873.      As you can see, there is very little 'crippled' about the unregistered
  874.      version. I hope that you will feel that QwkRequest is worth the small
  875.      amount I ask for it. There's very little other inducement to
  876.      register !
  877.  
  878.  
  879.  
  880.      QwkRequest v1.0                   TECHNICAL SUPPORT & SUGGESTIONS
  881.      ─────────────────────────────────────────────────────────────────
  882.      Technical Support & Suggestions
  883.      
  884.      Technical Support is primarily available to registered users. Requests
  885.      from registered users will take priority and will be processed. Requests
  886.      from unregistered users will be processed, but no guarantees can be made
  887.      on "turn-around" time.
  888.      
  889.      I am _always_ keen to hear peoples views and suggestions on any of my
  890.      programs. If you have any comments to make, please _do_ contact me !
  891.  
  892.      I cannot offer voice support for QwkRequest. The registration cost is
  893.      too low to make it viable. All contact must be electronic. I can be
  894.      emailed at the following addresses;
  895.      
  896.                         Internet  :  j@hangar.royle.org 
  897.                          FidoNet  :  2:255/60
  898.                        Compuserve :  30317,2621
  899.                        
  900.      Or you can contact me on my BBS by leaving a message to Jason hyland,
  901.      or call to download the latest version of QwkRequest;
  902.      
  903.              The Hangar BBS   +44 (0) 934 511751   V32b/24hrs
  904.  
  905.      You can alse leave me a message in any one of the following mail
  906.      conferences (although email is _far_ better !)
  907.      
  908.                   ILink Network  :  SLMR Conference
  909.                         The Net  :  BBS Software Conference
  910.                        Wild Net  :  Shareware
  911.                         MSI Net  :  Wildcat Support
  912.                    RIME (#5411)  :  Common Room
  913.       
  914.      The latest version of AutoRequest and support may be obtained
  915.      from Adam Stevens BBS;
  916.      
  917.      Transworld BBS:      +44 (0) 272 444025    2400 baud       
  918.                           +44 (0) 272 444026   14400 baud       
  919.                           +44 (0) 272 444027   14400 baud  
  920.               
  921.      Or on The Internet as "astevens@cheshire.demon.co.uk"     
  922.      
  923.  
  924.  
  925.      QwkRequest v1.0                             AND THANKS GO TO ....
  926.      ─────────────────────────────────────────────────────────────────
  927.      And Thanks Go To ....
  928.      
  929.      To the ever suffering Yvette, my *better* half, for putting up with
  930.      a SysOp AND a programmer to boot. For supplying copious amounts of 
  931.      black coffee at just the right moments. And for dragging me off to
  932.      bed at the exact perfect moment :)
  933.      
  934.      To Adam Stevens for writing AutoRequest and for beta testing
  935.      QwkRequest. Watch out for some more excellent programs from Adam
  936.      in the future.
  937.  
  938.      To all beta testers, whoever and wherever they are!
  939.  
  940.      To ALL my subscribers at The Hangar, for neglecting them during the
  941.      fanatic coding binges !
  942.      
  943.      Zortech (sadly now Symantic) for an excellent development environment.
  944.  
  945.      
  946.  
  947.      QwkRequest v1.0                                  LIMITED WARRANTY                    
  948.      ─────────────────────────────────────────────────────────────────
  949.      Limited Warranty
  950.  
  951.      THIS PROGRAM IS GUARANTEED TO DO ABSOLUTELY NOTHING EXCEPT TAKE
  952.      UP DISK SPACE.  USE IT AT YOUR OWN RISK.  NEITHER HANGAR ONLINE  
  953.      SERVICES NOR ANY OTHER PERSON INVOLVED IN ITS DISTRIBUTION IS
  954.      RESPONSIBLE IN ANY WAY, FOR ANY DAMAGES RESULTING FROM ITS USE OR
  955.      MISUSE, DIRECTLY OR INDIRECTLY.
  956.  
  957.      THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF SETWMLOG! IS
  958.      ENTIRELY WITH YOU.  SHOULD QWKREQ PROVE DEFECTIVE, YOU ASSUME THE
  959.      COST OF ALL NECESSARY SERVICING, REPAIR OR OTHER DAMAGES TO YOUR
  960.      EQUIPMENT, SOFTWARE, OR OTHER PROPERTY.
  961.  
  962.      HANGAR ONLINE SERVICES IS NOT RESPONSIBLE TO YOU FOR DAMAGES,
  963.      INCLUDING BUT NOT LIMITED TO, ANY LOST PROFITS, LOST MONIES, OR
  964.      OTHER SPECIAL, GENERAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
  965.      ARISING OUT OF THE USE OR INABILITY TO USE (INCLUDING BUT NOT
  966.      LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
  967.      LOSSES SUSTAINED BY THIRD PARTIES OR A FAILURE OF THE PROGRAM TO
  968.      OPERATE WITH ANY OTHER PROGRAMS) OR ANY OTHER LOSS EVEN IF YOU
  969.      HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR FOR ANY
  970.      CLAIM BY ANY OTHER PARTY.
  971.  
  972.      
  973.  
  974.      QwkRequest v1.0              LICENSING AND DISTRIBUTION AGREEMENT
  975.      ─────────────────────────────────────────────────────────────────
  976.      Licensing and Distribution Agreement
  977.      
  978.      Copyright (C) 1993, 1994 by Hangar Online Services and Jason 
  979.      Hyland. ALL RIGHTS RESERVED.  COMMERCIAL DISTRIBUTION AND/OR USE 
  980.      PROHIBITED WITHOUT WRITTEN PERMISSION FROM Hangar Online Services.   
  981.      
  982.      Non-Commercial distribution and/or use is permitted under the
  983.      following terms:
  984.  
  985.           1)   You may copy and distribute copies of QwkReq
  986.                executable code as you receive it, in any medium,
  987.                provided that you do so in a lawful, friendly manner
  988.                and that you conspicuously and appropriately publish on
  989.                each copy of each file that is a part of the
  990.                distribution package a valid copyright notice:
  991.  
  992.                "Copyright (C) 1993, 1994 by Hangar Online Services. Any
  993.                copies that you distribute must be distributed free of
  994.                charge to the recipient of the copy.  QwkReq may not be 
  995.                sold and you may not rent or lease it to any other person."
  996.  
  997.           2)   You must keep this License Agreement intact and give
  998.                any other recipients of the QwkReq program a copy of
  999.                this License Agreement along with the program.
  1000.  
  1001.           3)   You must distribute QwkReq in unmodified form.  You
  1002.                may not add an advertisement for your Bulletin Board
  1003.                System, User Group, or anything else either as a file
  1004.                in the distribution packet, only as a header in any
  1005.                archive.  You may not add, modify or delete any of the
  1006.                files in the QwkReq distribution archive.
  1007.  
  1008.           4)   QwkReq must be distributed for free. You may not
  1009.                charge a distribution fee for the physical act of
  1010.                transferring a copy of this program.  You may not place
  1011.                this program in any file area of a Bulletin Board
  1012.                System where a fee is required for download.
  1013.  
  1014.           5)   You may not modify your copy or copies of QwkReq or
  1015.                any portion of it and you can not copy and distribute
  1016.                any modifications.  
  1017.                               
  1018.           6)   You may not copy, sublicense, distribute or transfer
  1019.                QwkReq except as expressly provided under this
  1020.                License Agreement.  Any attempt otherwise to copy,
  1021.                sublicense, distribute or transfer QwkReq is void and
  1022.                your rights to use the program under this License
  1023.                agreement shall be automatically terminated.
  1024.  
  1025.           7)   You may not incorporate parts of QwkReq into other
  1026.                programs without the written permission of Hangar
  1027.                Online Services. Permission may or may not be
  1028.                granted based upon a determination of what your
  1029.                intended use is.
  1030.  
  1031.           8)   For the purposes of this document, "COMMERCIAL USE" is
  1032.                defined as concurrent operation of the software on
  1033.                two or more computers or data lines owned by the same
  1034.                for-profit organization.  Any organization may operate
  1035.                this software under the terms of this Non-Commercial
  1036.                Agreement if operation is limited to one computer or 
  1037.                data line.
  1038.  
  1039.           9)   You may use the software only after understanding and
  1040.                agreeing upon the above terms.
  1041.  
  1042.  
  1043.      QwkRequest v1.0               COPYRIGHT AND TRADEMARK RECOGNITION
  1044.      ─────────────────────────────────────────────────────────────────
  1045.  
  1046.      Wildcat! is a trademark and copyright of Mustang Software Inc.
  1047.      Tomcat is a trademark and copyright of Mustang Software Inc.
  1048.      WCPRO is a trademark and copyright of Mustang Software Inc.
  1049.      PKZIP/PKUNZIP is trademark and copyright of PKWARE Inc.
  1050.      ARJ is trademark and copyright of Robert K Jung
  1051.      
  1052.      AutoRequest is copyright AddTech Consultancy Ltd.
  1053.   
  1054.      Extracts from AutoRequest documentation reproduced by permission
  1055.      of AddTech Consultancy.
  1056.  
  1057.      ─────────────────────────────────────────────────────────────────
  1058.