home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 4 / Amiga Tools 4.iso / tools / system-tools / pip / pip.doc < prev    next >
Encoding:
Text File  |  1996-02-26  |  8.5 KB  |  211 lines
  1.  
  2.  
  3.                           ___________________________
  4.                          |                           |
  5.                          |           P I P           |
  6.                          |                           |
  7.                          |        Version 2.2        |
  8.                          |                           |
  9.                          |   © 1995 by Paul Shandi   |
  10.                          |___________________________|
  11.  
  12.  
  13.  
  14.  --<  INTRODUCTION  >-------------------------------------------------------
  15.  
  16.  "PIP" stands for "Picture-In-Picture", and that's exactly what this
  17.  program does.  It opens a window on Workbench (or any Intuition/public
  18.  screen) and allows you to monitor any other Intuition/public screen from
  19.  within it.  It does so by shrinking the target screen by 50% and drawing it
  20.  in the window.  Alternatively, you can have the target remain at 100% and
  21.  simply scroll around it with the cursor keys.
  22.  
  23.  Why did I write the program?  Well, when I use NComm to download software,
  24.  I can keep an eye on NComm's screen while I'm doing other things, such as
  25.  playing games on Workbench.  Thus, screen-flipping to keep tabs on NComm is
  26.  just a thing of the past!  :)
  27.  
  28.  
  29.  
  30.  --<  STARTING THE PROGRAM  >-----------------------------------------------
  31.  
  32.  There are 4 files associated with the program, and they are:
  33.  
  34.  PIP           -  The main program
  35.  PIP.info      -  The main program's icon
  36.  PIP.doc       -  This documentation
  37.  PIP.doc.info  -  This documentation's icon
  38.  
  39.  Ideally, these should all stay in the same directory, although the more
  40.  experienced amongst you will do what you like with them!  But before you
  41.  do, you MUST obey one rule: the "PIP" main program CAN'T be renamed to
  42.  something else!  If you do, the program will not be able to read its icon,
  43.  unless you leave it named "PIP.info".  This is because the program
  44.  specifically looks for "PIP.info" to read its ToolTypes (more on these
  45.  later).
  46.  
  47.  Okay then, to start the program, all you have to do is double-click on its
  48.  icon.  If you wish to start the program from a CLI, use this format:
  49.  
  50.  run >nil: pip
  51.  
  52.  This will allow you to close the CLI window after running the program.  If
  53.  you start the program from a CLI however, you will NOT be able to use any
  54.  of the ToolType options (see below).
  55.  
  56.  The last thing to note is the program ONLY runs on Workbench 2.04 or higher
  57.  Amigas, so Workbench 1.3 users will miss out.  Sorry people, but you really
  58.  should upgrade as soon as you can afford it.
  59.  
  60.  
  61.  
  62.  --<  TOOLTYPES  >----------------------------------------------------------
  63.  
  64.  There are 5 ToolTypes for use with the program, which alter the way it
  65.  starts up.  These are:
  66.  
  67.  
  68.  DONOTWAIT          Only useful if the program is in the "WBStartup" drawer.
  69.                     Tells the Amiga to start the program and leave it alone.
  70.                     Well, something like that.  :)
  71.  
  72.  SIZE=<50|100>      Tells the program whether to startup with a 50% size
  73.                     reduction of the target screen, or leave it at the
  74.                     original 100% size.  If you enter anything other than
  75.                     50 or 100, then 50 is used.
  76.  
  77.  REDRAW=<c|f|m|s|n> Tells the program how often to redraw the target screen
  78.                     in the window.  Valid values are:
  79.  
  80.                     c = constant (redraw continuously)
  81.                     f = fast     (redraw approx every 1 second)
  82.                     m = medium   (redraw approx every 5 seconds)
  83.                     s = slow     (redraw approx every 10 seconds)
  84.                     n = none     (no redraw, ie. program paused)
  85.  
  86.                     If you enter any other value, then "f" is used.
  87.  
  88.  WINDOW_X=<value>   Tells the program the horizontal screen position to open
  89.                     its window.  If <value> is negative, the window will be
  90.                     centred horizontally.
  91.  
  92.  WINDOW_Y=<value>   Tells the program the vertical screen position to open
  93.                     its window.  If <value> is negative, the window will be
  94.                     centred vertically.
  95.  
  96.  
  97.  
  98.  --<  USING THE PROGRAM  >--------------------------------------------------
  99.  
  100.  Now that the program has started, a quick scan of all supported screens
  101.  will occur, causing a brief flicker on your monitor.  Next, the program
  102.  window will open.  At this point, the window will either display the
  103.  current screen (giving a feedback effect), or the first screen under the
  104.  "Screens" menu.
  105.  
  106.  All the functions of the program are accessed by menus.  The options are:
  107.  
  108.  (1) PROJECT MENU:
  109.  
  110.      (a) Scan Screens - This updates the internal list of all available
  111.          target screens, found under the "Screens" menu.  There is a limit
  112.          of 10 target screens that can be selected, although this can easily
  113.          be made to more in the next release.  But I doubt anyone would have
  114.          more than 10 screens open at once (prove me wrong!).
  115.  
  116.          You should use this menu item whenever you open or close screens,
  117.          because otherwise the program won't know that they've changed.
  118.  
  119.      (b) Jump Window - This jumps the program's window to the next available
  120.          Intuition/public screen, to allow you to continue monitoring the
  121.          target screen from another.
  122.  
  123.      (c) 50% Size? - This "tick" menu item determines whether the target
  124.          screen will be shown at 50% reduction or normal 100% size.  When at
  125.          50% size, the entire target screen will be shown in the window, and
  126.          no scrolling is possible.  At 100% size, only a portion of the
  127.          target screen is shown (at normal size) and scrolling around it can
  128.          be done with the cursor keys.
  129.  
  130.      (d) About... - This gives info on the program, such as version number.
  131.  
  132.      (e) Quit - Guess!  :)
  133.  
  134.  
  135.  (2) REDRAW MENU:
  136.      There are five menu items here, all of which determine how often the
  137.      target screen is redrawn to the window.  "Constant" means continuously,
  138.      "Fast" means every 1 second, "Medium" means every 5 seconds, "Slow"
  139.      means every 10 seconds, and "None" means the program is paused.
  140.  
  141.  (3) SCREENS MENU:
  142.      All available Intuition/public screens that can be monitored are listed
  143.      here.  Only screens of 640 x 200/256 dimensions will be shown, because
  144.      no other sizes are supported yet.  If you have a screen open which is
  145.      NOT shown, it is either because:
  146.  
  147.      (a) The screen you desire may not be supported, and thus is not shown
  148.          for menu selection.
  149.  
  150.      (b) The screen was opened AFTER you started the program, and thus the
  151.          program hasn't recognised this fact.  Just select "Scan Screens" in
  152.          the "Project" menu, and then check the "Screens" menu to see if
  153.          it's now available for selection.
  154.  
  155.  
  156.  
  157.  --<  A NOTE ABOUT THE REDRAW  >--------------------------------------------
  158.  
  159.  Even though using a "Constant" or "Fast" redraw is nice, it puts a slight
  160.  burden on the Amiga's CPU, meaning that multitasking might slow down a bit.
  161.  In such cases, using "Medium" or "Slow" may be a better option, especially
  162.  if your Amiga is involved in CPU-intensive work.
  163.  
  164.  
  165.  
  166.  --<  COPYRIGHT AND DISTRIBUTION  >-----------------------------------------
  167.  
  168.  "PIP" is Freely Distributable.  This means anyone can spread the program
  169.  where they see fit.  You may upload it to BBS's, submit it to PD libraries,
  170.  give it to your friends; whatever.  However, it is NOT a PD product; the
  171.  author retains all copyrights to it, as well as this documentation.
  172.  
  173.  COMMERCIAL NOTE: Although this program can be freely distributed, it may
  174.  NOT be distributed as part of a commercial package under ANY circumstances!
  175.  Doing so will get you issued with a lawsuit, so don't consider it.  If you
  176.  would like to have it as part of a commercial package, contact me first.
  177.  The single and ONLY exception to this commercial-related rule is when the
  178.  program is to be included in a (CD-ROM?) compilation of PD, ShareWare or
  179.  Freely Distributable software, such as the excellent Aminet CD collections.
  180.  
  181.  The program MUST be distributed with the following 4 files, of which NONE
  182.  may be altered or omitted:
  183.  
  184.  PIP           -  The main program
  185.  PIP.info      -  The main program's icon
  186.  PIP.doc       -  This documentation
  187.  PIP.doc.info  -  This documentation's icon
  188.  
  189.  
  190.  
  191.  --<  CONTACTING THE AUTHOR  >----------------------------------------------
  192.  
  193.  You can contact me (Paul Shandi) via two methods:
  194.  
  195.  
  196.  PO Box 1003, Dee Why, NSW, 2099, Australia
  197.  
  198.                     or
  199.  
  200.        paul_shandi@comlink.mpx.com.au
  201.  
  202.  
  203.  Please do so if you have any comments, corrections, additions, etc, about
  204.  the program.  If need be, I have a PGP v2.6ui public key, which can be
  205.  obtained on request.
  206.  
  207.  
  208.  ========================<  END OF DOCUMENTATION  >=========================
  209.  
  210.  
  211.