home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / v / vpp2.zip / VPKTPEEK.DOC < prev    next >
Text File  |  1993-03-10  |  19KB  |  450 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                VPKTPEEK version 2
  7.                              ("Virtual Packet Peek")
  8.                     Copyright (c) 1992, 1993 by Brian Dessent
  9.                                All Rights Reserved
  10.  
  11.  
  12.                                     Overview
  13.  
  14.           VPKTPEEK  is  a tool  for viewing  pending  (waiting to  be sent)
  15.      packets  for  any  system  (client  or  server)  you  connect  to  for
  16.      VirtualNET or compatible  nets running VBBS.   Individual messages can
  17.      be deleted without affecting the others.
  18.  
  19.  
  20.                                     Features
  21.  
  22.      *    Allows navigation of packet in various ways:
  23.  
  24.           o    Jump forward or backward 1 or 10 messages at a time.
  25.           o    Jump to the first or last message.
  26.           o    Jump to a specific message number.
  27.           o    Search  for a string in  the message header  either from the
  28.                current message or the first message, based on:
  29.  
  30.                - to name      - from name    - title
  31.                - to node      - from node    - date/time
  32.  
  33.      *    Simultaneous display of  message text and  message header.   Text
  34.           can be scrolled up or down in line or page increments.
  35.  
  36.      *    Shows  the  following  information  for  each   message:  to/from
  37.           name/number/node/network,    date,    time,    title,    subtype,
  38.           distribution systems,  length in  lines and  bytes, age  in days,
  39.           percentage of packet, message text (body).
  40.  
  41.      *    Has a menued user interface for easy packet selection.  This also
  42.           serves  to display information about  each system you connect to,
  43.           such as:  node, bytes  pending, number  of pending  packets, last
  44.           connect  in days and  mm/dd/yy, total  sent, and  total received.
  45.           (however,  you can still specify a filename if there's a specific
  46.           packet  you want to  view that may not  be accessible through the
  47.           menus.)
  48.  
  49.      *    Built-in  .ZIP file viewing, with an automatic shell to PKZIP for
  50.           extracting/updating.
  51.  
  52.      *    Swaps to  extended/EMS/XMS/disk, leaving only  250 bytes resident
  53.           when running PKZIP/PKUNZIP. (*)
  54.  
  55.      *    Easy-to-use menued configuration program included (VPPCFG).
  56.  
  57.      *    Message lister mode for seeing many messages at once.
  58.  
  59.  
  60.           (*)  The swapping routines used in VPKTPEEK are from Ralf Brown's
  61.      SPAWNO library.
  62.  
  63.  
  64.  
  65. page 1                            VPKTPEEK v2.0        Copyright (c) 1992, 1993 
  66.  
  67.  
  68.  
  69.  
  70.                                   Configuration
  71.  
  72.           Before  using VPKTPEEK, you  must configure  it by  executing the
  73.      included VPPCFG.EXE.  With it, you must set the following options:
  74.  
  75.           Where to swap       Sets swapping options.  The following choices
  76.                               are presented in a sub-menu:
  77.  
  78.                               Use EMS        Tells VPKTPEEK  whether or not
  79.                                              to use  expanded (EMS) memory,
  80.                                              if available.
  81.                               Use XMS        Tells VPKTPEEK  whether or not
  82.                                              to   use  managed   (eg,  from
  83.                                              EMM386) extended memory.
  84.                               Use Extended   This tells VPKTPEEK whether or
  85.                                              not   to   use  raw   extended
  86.                                              memory.      This  should   be
  87.                                              disabled for  all multitasking
  88.                                              systems.
  89.                               Disk swap path This  tells VPKTPEEK  where to
  90.                                              swap   if   nothing  else   is
  91.                                              available or allowed.  You can
  92.                                              enter      multiple     paths,
  93.                                              separated by semicolons.
  94.  
  95.           Read buffer size    Controls how much memory is set aside for the
  96.                               display of  the message text.   This controls
  97.                               how  many lines of space should be allocated.
  98.                               Any message longer  then this length will  be
  99.                               truncated  when viewed  by VPKTPEEK.   Please
  100.                               note  this does not change VPKTPEEK's ability
  101.                               to read, write, or  extract to a file a  long
  102.                               message, only to display  it.  The only place
  103.                               where this  normally comes into play  is with
  104.                               BBSLISTS,  which can  be lengthy.   Each line
  105.                               occupies the width of the screen (usually 80)
  106.                               times 2 bytes.  The maximum is 400 lines.
  107.  
  108.           Registration        If  you have registered  VPKTPEEK, you should
  109.                               enter    your    registration   code    here.
  110.                               Registration is discussed later.
  111.  
  112.           Quit                Exits VPPCFG, optionally saving changes.
  113.  
  114.  
  115.                                       Usage
  116.  
  117.           VPKTPEEK can be  kept anywhere you your hard drive.  If it is not
  118.      run  from the  main  VBBS  directory,  however, the  VBBS  environment
  119.      variable must be set  to tell VPKTPEEK what  your VBBS main  directory
  120.      is, eg SET VBBS=C:\VBBS
  121.  
  122.           VPKTPEEK  can  be run  in  two different  ways.   One  mode tells
  123.      VPKTPEEK to make a list of your server and all your clients, then look
  124.      for all their pending packets and let you chose one.  The  other tells
  125.      VPKTPEEK to skip this function and just display a specified filename.
  126.  
  127.           VPKTPEEK NETWORKID=n
  128.  
  129. page 2                            VPKTPEEK v2.0        Copyright (c) 1992, 1993 
  130.  
  131.  
  132.  
  133.  
  134.           This command line  form tells  VPKTPEEK to look  for all  pending
  135.      packets for network n.  For example, to run VPKTPEEK on all VirtualNET
  136.      pending files, run VPKTPEEK NETWORKID=1
  137.  
  138.           VPKTPEEK A000009.999
  139.  
  140.           This command line form  tells VPKTPEEK to skip all  the searching
  141.      and  just  display  the  packet  named  A0000009.999  in  the  current
  142.      directory.   This was meant to really only be  used in case you save a
  143.      packet  and it's  not  really destined  for  any system,  you're  just
  144.      holding it for whatever reason.
  145.  
  146.  
  147.                                 Choosing a Packet
  148.  
  149.           When  using  the  first mode  of  VPKTPEEK,  a  simple two  level
  150.      hierarchy  menu system is in effect.   That is, you have the main menu
  151.      where you chose a node, and for every node presented there is a second
  152.      sub-menu where individual  packets for the  corresponding node can  be
  153.      selected.  Pressing escape backs up one level.  That is, if you are at
  154.      the  Choose a Node menu and you hit  escape, VPKTPEEK quits to DOS and
  155.      if you are at the Choose a Packet menu you are sent back to the Choose
  156.      a Node menu.
  157.  
  158.           The Choose a Node menu has 6 columns.  They are explained below:
  159.  
  160.           Node                The system's node number
  161.           Pending             The  amount of  pending  data,  in  kilobytes
  162.                               (1024  bytes.)    This  is for  the  data  in
  163.                               *uncompressed* form
  164.           # Packets           The  number  of   packets,  including   those
  165.                               contained in a ZIP file, that are pending for
  166.                               this node
  167.           Last                The last  connect in  both mm/dd/yy  and days
  168.                               elapsed since today forms
  169.           Sent                The total number  of kilobytes you have  sent
  170.                               to this system
  171.           Received            The  total  number   of  kilobytes  you  have
  172.                               received from this system
  173.  
  174.           The Choose a Packet sub-menus have 5 columns.  They are explained
  175.      below:
  176.  
  177.           Zip?                If the packet is in a ZIP file (Z???????.???)
  178.                               then  an  asterisk  appears  in  this column,
  179.                               otherwise it is blank
  180.           Filename            The filename of the packet
  181.           Date                The date  stamp of the file,  obtained either
  182.                               from  the data  in the .ZIP  file or  the DOS
  183.                               time stamp
  184.           Time                Same as Date except this is the time stamp of
  185.                               the file
  186.  
  187.      Note: If you delete a message from  a packet, the time, date, and size
  188.      shown  in the above two menus are  not updated, even though the packet
  189.      itself has been updated.
  190.  
  191.  
  192.  
  193. page 3                            VPKTPEEK v2.0        Copyright (c) 1992, 1993 
  194.  
  195.  
  196.  
  197.  
  198.                                  Selecting Data
  199.  
  200.           Whenever you  are prompted with  a list of things  to choose from
  201.      with a highlighted bar, the following keys are active:
  202.  
  203.           Up Arrow key        Move to the next entry (moves the bar down)
  204.           Down Arrow Key      Move to the previous entry (moves the bar up)
  205.           Home                Move to the first entry
  206.           End                 Move to the last entry
  207.           Page up/down        Move up or down a screenfull of entries
  208.           Esc                 Abort this selection menu (go back)
  209.           Enter               Select the currently highlighted entry
  210.  
  211.           Additionally, when  in the  message lister,  the  left and  right
  212.      arrow keys scroll the list left and right.  The lister is explained in
  213.      detail later.
  214.  
  215.  
  216.                                Displaying a Packet
  217.  
  218.           After you  have chosen  a packet  (or  you specified  one on  the
  219.      command line)  you are  at the  main screen,  with  the first  message
  220.      displayed.   The following information is displayed in the header (the
  221.      area above the horizontal bar)
  222.  
  223.           Msg number          The current  and number of  messages, and the
  224.                               percentage of the way through the packet this
  225.                               message is
  226.           Subtype             The subtype of the current message
  227.           Length              The length (size) of the message in bytes and
  228.                               lines
  229.           Title               The title of the message.  For Pings, this is
  230.                               always 'PING'.   For Updates,  this is always
  231.                               the  name of  the file,  eg 'BBSLIST.7'   For
  232.                               Ping Responses, this holds  information about
  233.                               your  system.   For files,  this is  the file
  234.                               description.
  235.           Date/Time           The date and time of the message, and its age
  236.                               in days from today
  237.           From                The 'from' name, number, node, and network
  238.           To (*)              The 'to' name, number, node, and network
  239.           Distribute (*)      A   list  of  systems   this  message  should
  240.                               additionally go out to (for secured subs.)
  241.           Status (*)          One or more of the following:
  242.  
  243.                               FileAttached        A file is attached
  244.                               Deleted             This  message  is  marked
  245.                                                   for deletion
  246.                               Update              This is a BBSLIST update
  247.                               Ping                This is a  ping (a  query
  248.                                                   from      the     network
  249.                                                   coordinator  as  to   the
  250.                                                   status of your board)
  251.                               Ping Resp           A  response  to  a  ping,
  252.                                                   generated   by   the  net
  253.                                                   software
  254.  
  255.           File (*)            The name  and length  (size) of the  attached
  256.  
  257. page 4                            VPKTPEEK v2.0        Copyright (c) 1992, 1993 
  258.  
  259.  
  260.  
  261.  
  262.                               file
  263.  
  264.           A (*) means  this will only be present  if it is non-blank.   For
  265.           example, if  there is  no attached file,  there will  be no  File
  266.           field.
  267.  
  268.  
  269.           VPKTPEEK is  now waiting for a  command.  For a  quick summary of
  270.      commands, press ?.  Following is an explanation of all commands:
  271.  
  272.           Left Arrow key      Displays the previous message.
  273.           Right Arrow key     Displays the next message (the Enter key  may
  274.                               also be used to go to the next message.)
  275.           Up Arrow key        Scrolls the message text up one line.
  276.           Down Arrow key      Scrolls the message text down one line.
  277.           Control-Left Arrow  Jumps back 10 messages.
  278.           Control-Right Arrow Jumps forward 10 messages.
  279.           Page Up             Scrolls  the   message   text  up   a   whole
  280.                               screenfull.
  281.           Page Down           Scrolls  the   message  text  down   a  whole
  282.                               screenfull.
  283.           Home                Jumps to the first message in the packet.
  284.           End                 Jumps to the last message in the packet.
  285.           Esc                 Quits back  to the packet menu  (or exits the
  286.                               program if  you specified  a filename  on the
  287.                               command line.)  If any changes were made (you
  288.                               deleted a  message) you will be  asked if you
  289.                               want  to save the changes.   Press 'y' if you
  290.                               wish the changes to be made permanent.
  291.           Del                 Deletes the current message.  This works as a
  292.                               toggle   -  a  deleted  message  will  become
  293.                               undeleted, and  a normal message  will become
  294.                               deleted
  295.           G (or g)            Jumps to message by number.  You are prompted
  296.                               for a message number to jump to.
  297.           L (or l)            Invoke the message lister (explained below.)
  298.           S (upper case)      Searches for a string  starting at the  first
  299.                               message.    (See   below  for  details  about
  300.                               searching.)
  301.           s (lower case)      Searches for a string starting at the current
  302.                               message.    (See   below  for  details  about
  303.                               searching.)
  304.           X (or x)            Extracts the current message  to a file.  You
  305.                               are  then prompted  for a  filename.   If the
  306.                               file  already  exists,  you  are   given  the
  307.                               options of overwriting  it, appending to  it,
  308.                               or quitting.  If it does not exist it will be
  309.                               created.
  310.  
  311.  
  312.                                     Searching
  313.  
  314.           There  are two  things to select  when doing  a search:  where to
  315.      search, and  what to search  for.   You are  first given a  menu of  6
  316.      options of  where to  search: to-name, from-name,  to-node, from-node,
  317.      title, date/time.  You are then prompted for a case INsensitive string
  318.      to look  for.  If a  search is successful the  current message becomes
  319.      the message that fit the search, otherwise the message "Not Found!" is
  320.  
  321. page 5                            VPKTPEEK v2.0        Copyright (c) 1992, 1993 
  322.  
  323.  
  324.  
  325.  
  326.      displayed on the last line of the screen.
  327.  
  328.  
  329.                                The Mesasge Lister
  330.  
  331.           The  lister was designed to let you  view the number, subtype, to
  332.      and  from addresses,  title, and date  of more  then one  message at a
  333.      time.   It is  invoked  with the  L command.   After  reading all  the
  334.      messages,  you are  presented  with a  window  occupying most  of  the
  335.      screen.  Moving the highlited bar is the same as with all other lists.
  336.      However, you can also use the left and right arrow keys to scroll left
  337.      in right.  This allows you to change what information is displayed for
  338.      each message, as it all won't fit on the screen at once.
  339.           Pressing  the Del key deletes  the current message.   An asterisk
  340.      ('*')  appears  in the  deleted column  to let  you  know it  has been
  341.      deleted.   Pressing return  exits the  lister to the  reader with  the
  342.      message  under the  highlited bar  as the  current message.   Pressing
  343.      escape exits the  lister, but the current message does  not change, no
  344.      matter where the highlited bar was.
  345.  
  346.  
  347.                           Registration/Terms of License
  348.  
  349.           If you use and like VPKTPEEK, you are encouraged to send whatever
  350.      monetary  amount you feel the program  is worth.  (expected donation -
  351.      $5 to  $10, but I  won't refuse  more!)   For any  size donation,  you
  352.      receive  a unique  key which  will disable  the reminder  displayed at
  353.      program termination.   More importantly, you  get a clear  conscience.
  354.      Registration keys are  valid for  the current release  and all  future
  355.      releases.   There  are no  cripples or  registered-only features.   To
  356.      register, print and complete  REGISTER.FRM and send it to  the address
  357.      indicated.
  358.  
  359.           Use VPKTPEEK  at your own risk.   It comes with  no guarantees of
  360.      any kind.   If your hard  drive blows up,  it isn't  my fault (but  it
  361.      won't.)  By using this product you agree to these terms.
  362.  
  363.  
  364.                                    The Author
  365.  
  366.           The author can be reached at the following places:
  367.  
  368.           Brian Dessent
  369.           FidoNet:       1:3641/202.0
  370.           VirtualNET:    1@9990
  371.           WWIVnet:       1@19950
  372.           US Mail:       10 MacGregor Court, Durham, NC, 27705
  373.           Data line:     (919)489-6110 (2400/ARQ) also -
  374.                          Shark's  Bar  and Grill  -  (919)683-1661 -  14.4k
  375.                          v32bis - Durham, NC
  376.  
  377.  
  378.                                      Thanks
  379.  
  380.           Thanks to Roland De Graaf for writing VBBS.  Thanks to Pat and Ed
  381.      for  putting up  with  all  those  horrible  beta  versions.    Thanks
  382.      especially to Pat for devoting a place on Shark's for my stuff.
  383.  
  384.  
  385. page 6                            VPKTPEEK v2.0        Copyright (c) 1992, 1993 
  386.  
  387.  
  388.  
  389.  
  390.            All bug reports/criticisms/gripes/suggestions are welcome.
  391.           Thanks for trying VPKTPEEK, and please consider registering.
  392.  
  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.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449. page 7                            VPKTPEEK v2.0        Copyright (c) 1992, 1993 
  450.