home *** CD-ROM | disk | FTP | other *** search
/ The Arcade BBS / arcadebbs.zip / arcadebbs / MISC / GRABB396.ZIP / GRTXT.DOC < prev    next >
Encoding:
Text File  |  1992-02-04  |  13.0 KB  |  282 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                       GRTXT(tm)
  9.  
  10.                          (the GRABBER(tm) ASCII Text Subset)
  11.  
  12.                                      Version 0.6
  13.  
  14.                            -------------------------------
  15.  
  16.                            The ASCII Screen Capture Program
  17.                              for the IBM PC, XT, AT, PS/2
  18.                                    and Compatibles
  19.  
  20.                                     DOCUMENTATION
  21.                                    February 4, 1992
  22.  
  23.                                Copyright 1991, 1992 by
  24.                                    Gerald A. Monroe
  25.                                  All rights reserved.
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.           YOUR LICENSE TO USE THIS SOFTWARE
  33.           ----------------------------------
  34.  
  35.           GRTXT.EXE and this documentation are copyright 1991, 1992 by
  36.           Gerald A. Monroe.  All rights are reserved except those expressly
  37.           granted here.
  38.  
  39.           The GRTXT program and this documentation file are distributed as
  40.           part of the GRABBER(tm) screen capture package under the terms of
  41.           a shareware license that is fully set forth in the file GRABBER
  42.           .DOC.  (GRABBER.DOC is the reference manual for GRABBER.EXE, the
  43.           main program module in the package.)
  44.  
  45.           The shareware license terms in the GRABBER.DOC file are incorpo-
  46.           rated here by reference.  This license permits you to copy and
  47.           distribute the files GRTXT.EXE and GRTXT.DOC (this file) freely,
  48.           provided that:  these files are always distributed together with
  49.           each other and with the GRABBER.EXE and GRABBER.DOC files; none
  50.           of the files is modified in any way; and no fee, premium or
  51.           donation of any kind whatsoever is charged or requested for their
  52.           distribution except as permitted on the terms described in the
  53.           GRABBER.DOC file.
  54.  
  55.           Continued use of the GRTXT program for more than a 10-day trial
  56.           period requires you to register your use of the software with the
  57.           author.  For more information about the benefits of registration
  58.           and how to go about registering, please refer to the full licens-
  59.           ing and ordering information in the GRABBER.DOC file.
  60.  
  61.  
  62.           GRTXT(tm)                 Documentation               Page 2 of 5
  63.  
  64.  
  65.  
  66.           ABOUT GRTXT.EXE -- GRABBER's "TEXT" VERSION
  67.           --------------------------------------------
  68.  
  69.           GRTXT is an alternative version of the GRABBER screen capture
  70.           program.  It is an especially valuable tool for users who need to
  71.           capture character-based text images from the video screen direct-
  72.           ly to plain ASCII text files on disk.
  73.  
  74.           While GRABBER can be used to capture both character-based text
  75.           screens as well as pixel-based graphic images to your disk in the
  76.           form of executable image files, GRTXT is designed to capture
  77.           character-based text screens exclusively.  GRTXT also differs
  78.           from GRABBER in that GRTXT captures your screens directly to
  79.           plain-ASCII text files, instead of to the .exe format.
  80.  
  81.           If your screen capture needs are mostly text-based, and you
  82.           require the ASCII format rather than the .exe format, then GRTXT
  83.           can be much more convenient to use than GRABBER.  GRTXT creates
  84.           ASCII text files that are ready to use immediately, without
  85.           having to be processed first by the GR2ASCII conversion utility
  86.           which accompanies GRABBER.
  87.  
  88.           GRTXT is installed and operated in much the same way as GRABBER,
  89.           and the two programs have a very similar look and feel.  For the
  90.           most part, this documentation for GRTXT covers only the aspects
  91.           of GRTXT which differ from GRABBER.  It is assumed here that you
  92.           have read the GRABBER documentation file (GRABBER.DOC) and become
  93.           familiar with that program's operation.
  94.  
  95.  
  96.           USING GRABBER and GRTXT SIMULTANEOUSLY
  97.           ---------------------------------------
  98.  
  99.           GRTXT is designed to be compatible with GRABBER.  Both programs
  100.           can be installed in memory at the same time.
  101.  
  102.           The default "hotkey" sequence for GRTXT is [Alt =].  That is, you
  103.           hold down the [Alt] key, press the equal sign key [=], then
  104.           release the [Alt] key.
  105.  
  106.           GRTXT is designed to capture character-based text images exclu-
  107.           sively.  If you press GRTXT's hotkey and hear a single low-
  108.           pitched tone on the computer speaker, this means that the video
  109.           screen is running in a pixel-based graphics mode, and GRTXT is
  110.           unable to capture the screen.
  111.  
  112.  
  113.           GRTXT(tm)                 Documentation               Page 3 of 5
  114.  
  115.  
  116.  
  117.           MODIFYING THE GRTXT HOTKEY
  118.           ---------------------------
  119.  
  120.           GRTXT allows you to modify your hotkey sequence from the default
  121.           [Alt =] to practically any other key sequence you choose.  In
  122.           this respect, GRTXT is exactly like GRABBER.  There is no sepa-
  123.           rate documentation here which covers the procedure for changing
  124.           your GRTXT hotkey.  GRTXT uses the exact same hotkey procedures
  125.           as GRABBER.  You can read about these in the GRABBER.DOC manual,
  126.           at page 30 and at Appendices A and B.  (To view a list of valid
  127.           KEY= codes for GRTXT, use the command GRTXT KEY=?.  To view a
  128.           list of valid SHIFT= codes, enter GRTXT SHIFT=?.)
  129.  
  130.  
  131.  
  132.           GRTXT INSTALLATION OPTIONS
  133.           ---------------------------
  134.  
  135.           GRTXT accepts the following command-line switches.  Each of these
  136.           optional switches (except for the APPEND option) is also avail-
  137.           able in the GRABBER program.  For more complete details concern-
  138.           ing the purpose of these optional switches and how they work,
  139.           consult the section beginning on page 15 of your GRABBER documen-
  140.           tation which is headed "Grabber Installation Options."
  141.  
  142.  
  143.  
  144.           Option:   DEFAULTDRIVE
  145.  
  146.           Purpose:  Tells GRTXT to capture text screens to whatever drive
  147.                     and directory path is the current DOS default.  As with
  148.                     GRABBER, this switch can substitute for the drive/path
  149.                     parameter which is otherwise required to make GRTXT
  150.                     stay resident in memory.
  151.  
  152.  
  153.  
  154.           Option:   MOUSE  and  NOMOUSE
  155.  
  156.           Purpose:  To enable and disable, respectively, GRTXT's recogni-
  157.                     tion of the "mouse hotkey," which allows you to capture
  158.                     your text screens by holding down both the left and
  159.                     right mouse buttons for about two seconds.
  160.  
  161.           Please note:  The mouse hotkey function is available in the
  162.           GRABBER program as well as in GRTXT.  If you have installed both
  163.           programs in memory simultaneously, do not use the MOUSE switch to
  164.           enable the mouse hotkey with both programs.  Strange results are
  165.           almost guaranteed to occur, and it may even lock up your computer
  166.           when you use the mouse hotkey.  It is acceptable to use the MOUSE
  167.           switch with either GRTXT or GRABBER, but not both.
  168.  
  169.  
  170.           GRTXT(tm)                 Documentation               Page 4 of 5
  171.  
  172.  
  173.  
  174.           Option:   UNLOAD
  175.  
  176.           Purpose:  Removes GRTXT from your computer's memory.  GRTXT
  177.                     cannot be removed from memory if, after you initially
  178.                     installed it, you loaded other memory-resident software
  179.                     which is activated by any of the same hardware or
  180.                     software interrupts which GRTXT uses.  If you are using
  181.                     GRTXT and GRABBER simultaneously, both programs can be
  182.                     removed from memory, but only in the reverse order in
  183.                     which they were initially installed.  In other words,
  184.                     "last in, first out."
  185.  
  186.  
  187.  
  188.           Option:   SOUND  and  NOSOUND
  189.  
  190.           Purpose:  To enable and disable, respectively, GRTXT's use of
  191.                     sounds through the computer's speaker.  When enabled,
  192.                     the sounds accompany the on-screen filename prompts,
  193.                     and are also issued to indicate the successful comple-
  194.                     tion of a screen capture operation.
  195.  
  196.  
  197.  
  198.           Option:   PROMPT  and  NOPROMPT
  199.  
  200.           Purpose:  To enable and disable, respectively, GRTXT's on-screen
  201.                     filename prompts.  When the prompts are disabled, GRTXT
  202.                     creates ASCII text files on your disk without asking
  203.                     you first what each file should be called.  Instead,
  204.                     the program assigns a sort of "serial number" name to
  205.                     each file that is created.  These files are named
  206.                     GRTXT000.TXT, GRTXT001.TXT, and so forth up to
  207.                     GRTXT999.TXT, at which point they return again to
  208.                     GRTXT000.  Please see also the section below dealing
  209.                     with the APPEND command switch, and consult the de-
  210.                     scription of the PROMPT and NOPROMPT options in your
  211.                     GRABBER documentation for more important information.
  212.  
  213.  
  214.           Option:   APPEND
  215.  
  216.           Purpose:  To enable the "Append Mode" when you have told GRTXT
  217.                     not to use on-screen filename prompts by using the
  218.                     NOPROMPT command switch.  This option has no effect
  219.                     when the filename prompts are enabled.  If you do not
  220.                     combine the NOPROMPT option with this APPEND option,
  221.                     then GRTXT will work in its "Overwrite Mode," which
  222.                     means that it will create a separate .TXT file for each
  223.                     screen capture you request.  However, when you do use
  224.                     the APPEND switch, GRTXT creates only one GRTXTXXX
  225.                     file, and appends each subsequent screen          
  226.                     capture to it.
  227.  
  228.  
  229.           GRTXT(tm)                 Documentation               Page 5 of 5
  230.  
  231.  
  232.  
  233.           Option:   SWAPMODE
  234.  
  235.           Purpose:  To enable "DOS Swap Mode" of operation, which can
  236.                     eliminate some of the delays you may experience in
  237.                     getting GRTXT to pop up after you press the hotkey. The
  238.                     SWAPMODE switch is valid only when you are initially
  239.                     installing GRTXT in memory, and has no effect after the
  240.                     program is already resident.  For more information
  241.                     about this option, see page 18 of the GRABBER.DOC file.
  242.  
  243.  
  244.  
  245.           Option:   BATCHCAPTURE  or  BATCHCAPTURE:filename
  246.  
  247.           Purpose:  Allows screens to be captured from within a batch file,
  248.                     without having to press GRTXT's hotkey combination at
  249.                     the keyboard.  These options function exactly the same
  250.                     way as they do in the GRABBER.EXE program.  For a
  251.                     complete description of how they work, consult page 19
  252.                     in the GRABBER documentation.
  253.  
  254.  
  255.  
  256.           GRTXT AND FILENAME PROMPTS
  257.           ---------------------------
  258.  
  259.           Probably the most significant difference you will notice between
  260.           GRTXT's interface and GRABBER's is in the area of the on-screen
  261.           filename prompts.
  262.  
  263.           Unlike GRABBER, GRTXT does not offer a default filename sequence
  264.           such as GRTXT000, GRTXT001, etc., when it displays the prompts on
  265.           your screen.  The first time you call up GRTXT after installing
  266.           it, there is no default filename present.  You must supply your
  267.           own.
  268.  
  269.           After your first .TXT screen capture, however, subsequent file-
  270.           name prompts will offer you a default filename which is identical
  271.           to the previous one you specified.  You may accept this default
  272.           filename by pressing <Return>, or you can enter another name. 
  273.           After you press <Return>, you will then see this additional
  274.           prompt, which is not present in GRABBER:
  275.  
  276.                  FILENAME exists -- (A)ppend, (O)verwrite, (C)ancel ?
  277.  
  278.           If you wish to retain the contents of FILENAME.TXT and simply
  279.           append the current screen to the bottom of it, just press <A> or
  280.           <Return>. If you wish to overwrite (i.e., erase and replace) the
  281.           contents of the original FILENAME.TXT file, then press <O>.  If
  282.           you decide not to work with this name and wish to enter a differ-
  283.           ent name instead, press <C>.
  284.  
  285.                           * * *    End of GRTXT.DOC   * * *
  286.