home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / graphic / foto / foto.doc next >
Text File  |  1991-09-13  |  10KB  |  271 lines
  1.                                  FOTO 1.02
  2.                                  ---------
  3.  
  4.     FOTO is a utility to take a screen snapshot of an OS/2 character
  5.     mode screen.  The snapshot can be recalled via a hotkey, and it can
  6.     be stored in a disk file.  FOTO is not for PM or other graphical
  7.     applications, or for sessions running in windows--it is only for
  8.     fullscreen character mode sessions.
  9.  
  10.     This is a bit of a "quick & dirty" utility; some amenities are
  11.     missing from the current version.  Most important of these is that
  12.     the hotkeys are fixed and can't be changed by the user.  When time
  13.     permits, we will release a version with user-definable hotkeys.
  14.  
  15.  
  16.     Loading
  17.     -------
  18.     The basic syntax used to load FOTO is:
  19.  
  20.         [d:][path]FOTO [/Q] [FILE=[d:][path]name[.ext]]
  21.  
  22.     When loaded without any parameters, FOTO loads and remains resident
  23.     (in background) awaiting a hotkey wakeup call; you are returned to
  24.     the OS/2 command prompt.
  25.  
  26.     The /Q option specifies "quiet" operation; with this option, FOTO
  27.     will not make any noise unless an error is encountered and FOTO is
  28.     unable to display a message.
  29.  
  30.     The FILE option allows you to specify a filename for the snapshot
  31.     file; if no name is specified, FOTO will use the name FOTOxx.TXT,
  32.     where xx is the two-digit number that identifies the current
  33.     session.  It will be located in the root directory of the drive that
  34.     contains FOTO.EXE.
  35.  
  36.         NOTE: all FOTO keywords except ALL (i.e., FILE, SESSION,
  37.         LIST, and KILL) can be truncated to as little as one
  38.         character.  For example, any of "L", "LI", "LIS", and
  39.         "LIST" will be accepted.
  40.  
  41.     An example of a complete load command:
  42.  
  43.         d:\os2util\foto /q f=c:\snap.txt
  44.  
  45.     This example loads FOTO, specifies quiet operation, and causes FOTO
  46.     to use a file named C:\SNAP.TXT for snapshots written to disk.
  47.  
  48.     When FOTO loads, it will display a brief report indicating the
  49.     current session number (in hex), the snapshot filename, and a
  50.     reminder of the hotkey assignments.
  51.  
  52.     NOTE: while FOTO is loaded, its executable file (FOTO.EXE) is
  53.     protected by the system and cannot be deleted or moved.
  54.  
  55.  
  56.     Taking snapshots
  57.     ----------------
  58.     Once loaded, FOTO can be called up at any time by pressing Alt-P
  59.     (think of Photo).  The screen must be in text mode, else FOTO will
  60.     beep at you and refuse to pop up.
  61.  
  62.     FOTO pops up a window and displays a brief menu:
  63.  
  64.         FOTO option menu
  65.         F - snapshot to file and memory
  66.         M - snapshot to memory only
  67.         U - unload FOTO
  68.         Enter option (or ESC):
  69.  
  70.     Press 'F' to take a snapshot of the current screen, save it in
  71.     memory, and copy it to the snapshot file; a brief tone sounds to let
  72.     you know that the operation was successful.  A double-pitch tone
  73.     sounds if there is a problem (disk full, bad filename, write
  74.     protected, etc.)  If the snapshot file already exists, the new
  75.     screen will be appended to it; a divider row of hyphens is placed
  76.     below each screen photo.
  77.  
  78.     Press 'M' to take a snapshot of the current screen and save it in
  79.     memory only; the snapshot is not appended to the snapshot file.  A
  80.     brief tone sounds to let you know that the snapshot was successful.
  81.  
  82.     Press 'U' to unload FOTO from memory.
  83.  
  84.     Press ESC to return to the active session without taking any action.
  85.  
  86.  
  87.     Quick memory snapshots
  88.     ----------------------
  89.     To take a memory snapshot at any time, press Shift-Alt-P.  This is
  90.     equivalent to pressing Alt-P and selecting M from the menu.  A brief
  91.     tone sounds to let you know that the snapshot has been taken.
  92.  
  93.  
  94.     Viewing snapshots
  95.     -----------------
  96.     To view a previous snapshot (taken with Shift-Alt-P or 'M' from the
  97.     menu), press Alt-V.  You must be in the same screen mode (text, same
  98.     number of rows and columns) as when the snapshot was taken.
  99.  
  100.     Press any key to return to the live screen.
  101.  
  102.  
  103.     Unloading FOTO
  104.     --------------
  105.     You can unload FOTO by selecting 'U' from the menu (as described
  106.     above) or from the command line.  To unload from the command line:
  107.  
  108.         [d:][path]FOTO KILL
  109.  
  110.  
  111.     Selecting a session
  112.     -------------------
  113.     FOTO is active only within a single session (sometimes called a
  114.     "screen group").  Normally, this will be the session that was active
  115.     when you loaded FOTO.  However, you can select a different session
  116.     for both loading and unloading FOTO.
  117.  
  118.     To select a session into which FOTO will be loaded, add the SESSION
  119.     option to your FOTO command:
  120.  
  121.         FOTO SESSION=n
  122.  
  123.     'n' is the 1- or 2-digit session number, in hex.  For example, to
  124.     load FOTO in session 0B:
  125.  
  126.         FOTO SES=0B
  127.  
  128.     With this command line, FOTO is active only in session 0B, not in
  129.     the current session (unless the current is session 0B!).  If there
  130.     is no such active session, FOTO will load anyway; it will become
  131.     active if and when a session with that number is created.
  132.  
  133.     To unload a copy of FOTO from another session, simply add the
  134.     SESSION parameter to the KILL command:
  135.  
  136.         FOTO K S=0B
  137.  
  138.     You can load a copy of FOTO in each session; each copy is
  139.     independent, i.e., it has its own snapshot file (unless you specify
  140.     a common name) and its own memory snapshot buffer.
  141.  
  142.  
  143.     "Orphan" FOTOs
  144.     --------------
  145.     If you load a copy of FOTO in a session and then close the session
  146.     without unloading FOTO, you may leave "orphan" copies of FOTO in
  147.     memory.  These have no ill effects, but they do use some memory.
  148.  
  149.     You can use the PLIST program (included) to locate active copies of
  150.     FOTO if you think this has happened.  A report might look like this:
  151.  
  152.         PID   PPID   Session  Name
  153.         -----  -----  -------  ----
  154.         x0005  x0003    x20    PMEXEC
  155.         x000f  x0003    x04    CMD
  156.         x0003  x0000    x01    PMSHELL
  157.         x0002  x0000    x00    (kernel)
  158.         x0004  x0003    x00    HARDERR
  159.         x0028  x0011    x04    CMD
  160.         x0025  x0000    x05    FOTO
  161.         x0029  x0028    x04    PLIST
  162.  
  163.     A copy of FOTO is present for session 05, which is now defunct.
  164.     This can be easily removed:
  165.  
  166.         FOTO KILL S=5
  167.  
  168.     You should note that PLIST shows the number of the session that
  169.     activated FOTO, not the session number in which FOTO is actually
  170.     active.  These will be the same unless you explicitly specify a
  171.     session number when loading:
  172.  
  173.         FOTO S=0C
  174.  
  175.     In this case, PLIST would show the number of the session from which
  176.     the FOTO command was executed, not session 0C.
  177.  
  178.     When starting a progam in a separate session for which FOTO would be
  179.     useful, we like to use a batch file:
  180.  
  181.         d:\os2util\foto
  182.         ...run program
  183.         d:\os2util\foto kill
  184.  
  185.     When this is run via START (e.g., START "name" /c /fs batname.cmd),
  186.     the program runs nicely in its own session, and FOTO is loaded and
  187.     unloaded automatically.
  188.  
  189.  
  190.     Listing and unloading all copies of FOTO
  191.     ----------------------------------------
  192.     You can list the session numbers for all active copies of FOTO with
  193.     the LIST option:
  194.  
  195.         FOTO LIST
  196.  
  197.     You can also kill all active copies by adding the ALL option with
  198.     KILL:
  199.  
  200.         FOTO KILL ALL
  201.  
  202.     Remember that, unlike other FOTO keywords, "ALL" cannot be
  203.     abbreviated.
  204.  
  205.  
  206.     Version history
  207.     ---------------
  208.     1.02 9/3/91
  209.         Corrected a problem when a screen contains data in the
  210.         roghtmost column
  211.  
  212.     1.01
  213.         Improved error messages (some displayed unwindowed)
  214.         Miscellaneous internal cleanup
  215.  
  216.     1.00 03/22/91
  217.         Initial release
  218.  
  219.  
  220.     Copyright/License/Warranty
  221.     --------------------------
  222.     This document and the program file FOTO.EXE ("the software") are
  223.     copyrighted by the author.  If you are an individual, you are
  224.     licensed to:  use the software; make as many copies of the program
  225.     and documentation as you wish; give such copies to anyone; and
  226.     distribute the software and documentation via electronic means.
  227.     There is no charge for any of the above.
  228.  
  229.     However, you are specifically prohibited from charging, or
  230.     requesting donations, for any such copies, however made; and from
  231.     distributing the software and/or documentation with commercial
  232.     products without prior permission.  An exception is granted to
  233.     not-for-profit user's groups, which are authorized to charge a small
  234.     fee (not to exceed $7) for materials, handling, postage, and general
  235.     overhead.  NO FOR-PROFIT ORGANIZATION IS AUTHORIZED TO CHARGE ANY
  236.     AMOUNT FOR DISTRIBUTION OF COPIES OF THE SOFTWARE OR DOCUMENTATION,
  237.     OR TO INCLUDE COPIES OF THE SOFTWARE OR DOCUMENTATION WITH SALES OF
  238.     THEIR OWN PRODUCTS.
  239.  
  240.     THIS INCLUDES A SPECIFIC PROHIBITION AGAINST FOR-PROFIT
  241.     ORGANIZATIONS DISTRIBUTING THE SOFTWARE, EITHER ALONE OR WITH OTHER
  242.     SOFTWARE, AND CHARGING A "HANDLING" OR "MATERIALS" FEE OR ANY OTHER
  243.     SUCH FEE FOR THE DISTRIBUTION.  NO FOR-PROFIT ORGANIZATION IS
  244.     AUTHORIZED TO INCLUDE THE SOFTWARE ON ANY MEDIA FOR WHICH MONEY IS
  245.     CHARGED.  PERIOD.
  246.  
  247.     Businesses, institutions, and governmental entities are prohibited
  248.     from installing or using the software on their systems without
  249.     specific permission from The Cove Software Group.
  250.  
  251.     No copy of the software may be distributed or given away without
  252.     this document; and this notice must not be removed.
  253.  
  254.     There is no warranty of any kind, and the copyright owner is not
  255.     liable for damages of any kind.  By using this free software, you
  256.     agree to this.
  257.  
  258.     The software and documentation are:
  259.  
  260.                            Copyright (C) 1991 by
  261.                           The Cove Software Group
  262.                            Christopher J. Dunford
  263.                                P.O. Box 1072
  264.                           Columbia, Maryland 21044
  265.  
  266.                                (301) 992-9371
  267.                        CompuServe 76703,2002 [IBMNET]
  268.              Internet, Bitnet, etc.: 76703.2002@compuserve.com
  269.  
  270.               Software and documentation author: Chris Dunford
  271.