home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / email / qprn103.zip / ADDON.DOC < prev    next >
Text File  |  1993-08-29  |  10KB  |  192 lines
  1.   This file describes some add-on programs and files for QWKPRUNE.
  2.  
  3.  
  4.                          $$1300.CMD and UNKILL.CMD
  5.                                    -----
  6.   $$1300.CMD and UNKILL.CMD are sample 1stReader .CMD files for use with
  7.   QWKPRUNE.  To install them, simply copy both files to the directory
  8.   1stReader is in.  If you already have a $$1300.CMD or $$13.CMD file,
  9.   rename $$1300.CMD to KILL.CMD before copying it to the 1stReader
  10.   directory, and add "Kill messages,FILE=KILL.CMD" to your $$1300.CMD or
  11.   $$13,CMD file.
  12.  
  13.   Once the files are installed, you can call up $$1300.CMD by pressing F7
  14.   while a message is on the screen.  If a message is not on the screen,
  15.   $$1300.CMD will not come up when F7 is pressed.
  16.  
  17.   $$1300.CMD and UNKILL.CMD contain entries for KILLMSG and ZIPPYZAP.
  18.  
  19.  
  20.                                 KILLMSG 1.03
  21.                                    -----
  22.   KILLMSG is a program to allow users of 1stReader to tag messages to be
  23.   deleted by QWKPRUNE.  Users may also untag messages and check if the
  24.   messages on the screen is tagged.
  25.  
  26.   To install it, copy KILLMSG.EXE to the directory where 1stReader is
  27.   located.  You'll also need to install $$1300.CMD and UNKILL.CMD.
  28.  
  29.   The entry in $$1300.CMD labeled "Current Message" calls KILLMSG to tag
  30.   the current message to be deleted.  UNKILL.CMD also has an entry labeled
  31.   "Current Message", which calls KILLMSG to untag the current message.
  32.  
  33.   If the current message has been stitched together by 1stReader, KILLMSG
  34.   can tag or untag the whole message, starting with the first part loaded.
  35.   For example, if you use the message index screen to find the second part
  36.   of a four-part message, and choose to delete it, parts 2, 3, and 4 will
  37.   be tagged, but part 1 will not be.  If you don't want KILLMSG to behave
  38.   this way, remove @API(212) from the commands used to call it.
  39.  
  40.   KILL.BAT, UNKILL.BAT, and CHECK.BAT are batch files that contain
  41.   1stReader commands to have KILLMSG tag, untag, and check messages,
  42.   respectively.  They can be used to assign these functions to function
  43.   keys.  For example, if you want pressing Shift-F1 to kill the message on
  44.   the screen, copy KILL.BAT to the directory 1stReader is in and rename it
  45.   $$F1.BAT.
  46.  
  47.   If no message is on the screen, or if you are in the Folders or Replies
  48.   conference, KILLMSG will exit.
  49.  
  50.   Note: KILLMSG checks for the existence of a file in the work directory
  51.   named MESSAGES.BAK.  If it doesn't exist, MESSAGES.DAT will be copied to
  52.   MESSAGES.BAK.  All work will be done on MESSAGES.BAK.  This is necessary
  53.   because 1stReader has a habit of resetting the message-deleted flag
  54.   in each message header to its original value.  If you're using
  55.   1stReader's bookmark switch to repack the QWK, rename MESSAGES.BAK to
  56.   MESSAGES.DAT just before quitting the packet.  1stReader inserts the
  57.   bookmark before running $$EXIT.BAT.
  58.  
  59.  
  60.                                ZIPPYZAP 1.01
  61.                                    -----
  62.   ZIPPYZAP allows users of Deluxe², 1stReader, and Session Manager to tag
  63.   all messages found by those readers' Zippy text search for deletion by
  64.   QWKPRUNE.  It can also untag these messages.  Install it by copying
  65.   ZIPPYZAP.EXE to the directory where your reader is located, or to a
  66.   directory in your DOS path.
  67.   
  68.   The command line format is:
  69.     ZIPPYZAP switch work_dir [reader]
  70.  
  71.   Switch is either a K or a U, and specifies whether messages are to be
  72.   killed (K) or unkilled (U).  Work_dir is the work directory defined in
  73.   the reader's configuration.  Reader is either /1 for 1stReader or
  74.   /S for Session Manager.  If /1 is used, ZIPPYZAP will create and use
  75.   MESSAGES.BAK, as described for KILLMSG.  The sample menus for Deluxe²
  76.   and 1stReader have entries for ZIPPYZAP.   A macro such as
  77.   <CtrlJ><CtrlO> zippyzap K [work_dir] /S<Enter> should work in Session
  78.   Manager.  Replace [work_dir] with the work directory defined in Session
  79.   Manager's configuration.  Session Manager won't show if a message is
  80.   tagged for deletion, and I know of no way to get that information from
  81.   within it.  If anyone does know of a way, please let me know.
  82.  
  83.   ZIPPYZAP has only been tested with Deluxe², 1stReader, and Session
  84.   Manager.  If other readers have a Zippy text search, it may (or may not)
  85.   work with them.
  86.  
  87.   ZIPPYZAP can be also used with 1stScan.  This will allow you to prune out
  88.   messages based on their text.  If you want to leave the messages tagged,
  89.   and aren't using 1stReader, delete the ZIPPY.NDX file created by 1stScan
  90.   after ZIPPYZAP is finished.  When it runs, QWKPRUNE will delete this
  91.   file.
  92.  
  93.   Messages tagged by KILLMSG and ZIPPYZAP can be unkilled by entries in a
  94.   prune file.  To be sure that all tagged messages are deleted, use
  95.   QWKPRUNE's /N switch.
  96.  
  97.  
  98.                                 SAVEQWK 1.02
  99.                                    -----
  100.   SAVEQWK allows users of 1stReader to repack the current QWK packet,
  101.   saving any changes that have been made.  Install it by copying
  102.   SAVEQWK.EXE and SAVEQWK.FIL to the directory where 1stReader is located.
  103.   SAVEQWK requires no command line arguments.  However, it accepts /u and
  104.   /r as arguments.  If /u is used, only MESSAGES.DAT will be repacked.
  105.  
  106.   SAVEQWK will detect the MESSAGES.BAK file used by KILLMSG and ZIPPYZAP,
  107.   and rename it MESSAGES.DAT before calling the packer.  Unless the /u
  108.   switch is used, MESSAGES.BAK will no longer exist, so you should only do
  109.   this just before quitting the packet.  If the /u switch was used,
  110.   MESSAGES.DAT will also be renamed MESSAGES.BAK before the packer is
  111.   called, and the filenames will be swapped back after it's finished. If
  112.   the /r switch was used, the packer will not be called.
  113.  
  114.   N.B.  If you're using a version of 1stReader dated before March 14, 1993
  115.   change the third line of SAVEQWK.FIL to @API$(0).
  116.  
  117.                                  MKPRN 1.01
  118.                                    -----
  119.   MKPRN is a utility to add a line to a prune file from within a mail
  120.   reader.  Install it by copying it to the directory where your reader is
  121.   located, or to a directory in your DOS path.
  122.  
  123.   Your reader should have configurable function keys or user-definable
  124.   menus.  It should also have substitution variables which can be used in
  125.   function key definitions or menu entries.  It needs to have variables
  126.   for the BBSID of the board the packet is from, the contents of the From:
  127.   and To: fields, and the subject line.  It helps if there's a variable for
  128.   the conference number the message is in, but this can be omitted.  Check
  129.   the manual for your reader to see if it has substitution variables and
  130.   what they are.  Of course, it may also be run from the DOS command line.
  131.  
  132.   The command line format is:
  133.     MKPRN filename  "switch:text"  conference number
  134.  
  135.   Switch must be a valid prune file switch, such as T, F, B, S, or N.  See
  136.   QWKPRUNE.DOC for details.  Text is the text to search for, and should be
  137.   represented by one of your reader's substitution variables. The whole
  138.   combination must be enclosed in double quotes so that it will be treated
  139.   as a single argument, regardless of how may spaces may be in the text.
  140.  
  141.   Filename is the name of the file to write to.  If your reader has a
  142.   substitution variable for the BBSID of the board the packet is from, use
  143.   it.  It's best if you specify the directory where the file should go.
  144.  
  145.   Conference number is the number of the conference the message is in.
  146.   If your reader doesn't have a substitution variable for this, you can
  147.   omit it, and use your editor to enter the conference number.  You can
  148.   also use A (for all conferences).   Place an exclamation point in front
  149.   of this to generate an "unkill" line.
  150.  
  151.   If the text to search for contains double quote marks, it'll be parsed
  152.   into multiple arguments.  In such cases, MKPRN will exit without writing
  153.   to file.  Text like this can be added to the file with the DOS echo
  154.   command and output redirection.
  155.  
  156.                                 GRABNUM 1.00
  157.                                    -----
  158.   GRABNUM gets the message number and conference number from DeLuxe²'s
  159.   message export file, and writes them to a prune file.  Install it by
  160.   copying it to the directory where DeLuxe² is located.
  161.  
  162.   The command line format is:
  163.     GRABNUM switch export_filename prune_filename
  164.  
  165.   Switch is either a K or a U, and specifies whether messages are to be
  166.   killed (K) or unkilled (U).  Export_filename is the "Message export
  167.   filespec" defined in DeLuxe²'s configuration.  Prune_filename is the file
  168.   to write to.
  169.  
  170.   Grabnum will also read the message export files created by 1stReader's
  171.   /EXPORT: <filespec> DOS shell modifier.
  172.  
  173.                                 KMSG-D2 1.00
  174.                                    -----
  175.   KMSG-D2 is a program to allow users of DeLuxe² to tag messages for
  176.   deletion by QWKPRUNE.  Messages may also be untagged.
  177.  
  178.   To install it, copy KMSG-D2.EXE to the directory where DeLuxe² is
  179.   located.
  180.  
  181.   The command line format is:
  182.     KMSG-D2 switch %H %W\Q-WORK\MESSAGES.DAT
  183.  
  184.   Switch is either a K or a U, and specifies whether messages are to be
  185.   killed (K) or unkilled (U).  %H represents the current help record, and
  186.   %W\MESSAGES.DAT is the path to MESSAGES.DAT.
  187.  
  188.   KMSG-D2.EXE utilizes the Qmail DeLuxe² API definition.  The Qmail DeLuxe²
  189.   API definition is copyrighted by Mark Herring.  The C code used to access
  190.   the Qmail DeLuxe² API is copyrighted by myself.
  191.  
  192.