home *** CD-ROM | disk | FTP | other *** search
/ The Arcade BBS / arcadebbs.zip / arcadebbs / MISC / GRABB396.ZIP / GREDIT.DOC < prev    next >
Encoding:
Text File  |  1992-02-04  |  18.0 KB  |  485 lines

  1.  
  2.  
  3.  
  4.                                      GREDIT (tm)
  5.                                 Shareware Release 4.3A
  6.  
  7.                             -----------------------------
  8.  
  9.                          A display screen editor for use with
  10.                        the GRABBER (tm) screen capture program
  11.  
  12.  
  13.  
  14.                                     DOCUMENTATION
  15.                                    February 4, 1992
  16.  
  17.  
  18.  
  19.                                Copyright 1991, 1992 by
  20.                                    Gerald A. Monroe
  21.                               All rights reserved except
  22.                              as expressly provided here.
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.           YOUR LICENSE TO USE THIS SOFTWARE:
  32.           -----------------------------------
  33.  
  34.           This documentation file and the GREDIT.EXE program are Copyright
  35.           1991, 1992, by Gerald A. Monroe.  All rights are reserved except
  36.           as expressly provided here.
  37.  
  38.           These files have been distributed as part of the GRABBER(tm)
  39.           screen capture package, under the terms of a shareware license
  40.           that is fully set forth in the file GRABBER.DOC.  (GRABBER.DOC is
  41.           the reference manual for GRABBER.EXE, which is the main program
  42.           module in the package.)
  43.  
  44.           The shareware license terms in the GRABBER.DOC file are incorpo-
  45.           rated here by reference.  This license permits you to copy and
  46.           distribute the files listed in the first paragraph above, provid-
  47.           ed that:  these files are always distributed together with each
  48.           other and with the GRABBER.EXE and GRABBER.DOC files; none of the
  49.           files is modified in any way; and no fee, premium or donation of
  50.           any kind is charged or requested for their distribution except as
  51.           permitted on the terms described in the GRABBER.DOC file.
  52.  
  53.           Continued use of any of these programs for more than a 10-day
  54.           trial period requires you to register your use of the software
  55.           with the author.  For more information about the benefits of
  56.           registration and how to go about registering, please refer to the
  57.           full licensing and ordering information in the GRABBER.DOC file.
  58.  
  59.  
  60.           GREDIT                    Documentation               Page 2 of 9
  61.  
  62.  
  63.  
  64.                                   Table of Contents
  65.  
  66.                    Overview of GREDIT . . . . . . . . . . . . . . 3
  67.  
  68.                    Hardware & software requirements . . . . . . . 3
  69.  
  70.                    Starting GREDIT  . . . . . . . . . . . . . . . 3
  71.  
  72.                    Editing the GRABBER offspring file . . . . . . 4
  73.  
  74.                    Cursor movement keys . . . . . . . . . . . . . 4
  75.  
  76.                    Help screen, Alt-H . . . . . . . . . . . . . . 5
  77.  
  78.                    Quit GREDIT, Alt-Q . . . . . . . . . . . . . . 5
  79.  
  80.                    Save image to .EXE file, Alt-S . . . . . . . . 5
  81.  
  82.                    Save image to ANSI file, Alt-A . . . . . . . . 5
  83.  
  84.                    Set colors, Alt-F  . . . . . . . . . . . . . . 5
  85.  
  86.                    Toggle blink, Alt-L  . . . . . . . . . . . . . 5
  87.  
  88.                    Border color, Alt-B  . . . . . . . . . . . . . 6
  89.  
  90.                    Clear screen, Alt-K  . . . . . . . . . . . . . 6
  91.  
  92.                    Erase line, Alt-E  . . . . . . . . . . . . . . 6
  93.  
  94.                    Wipe screen, Alt-W . . . . . . . . . . . . . . 6
  95.  
  96.                    Toggle ruler, Alt-R  . . . . . . . . . . . . . 6
  97.  
  98.                    Set tabs, Alt-T  . . . . . . . . . . . . . . . 6
  99.  
  100.                    Import text file, Alt-I  . . . . . . . . . . . 7
  101.  
  102.                    Load new image, Alt-N  . . . . . . . . . . . . 7
  103.  
  104.                    Copy to clipboard, Alt-C . . . . . . . . . . . 7
  105.  
  106.                    Cut to clipboard, Alt-X  . . . . . . . . . . . 7
  107.  
  108.                    Paste from clipboard, Alt-P  . . . . . . . . . 8
  109.  
  110.                    Line-drawing help, Alt-D . . . . . . . . . . . 8
  111.  
  112.                    Graphics character help, Alt-G . . . . . . . . 8
  113.  
  114.                    Query colors at cursor, Alt-Y  . . . . . . . . 8
  115.  
  116.                    Turning off GREDIT's beep sounds . . . . . . . 9
  117.  
  118.  
  119.           GREDIT                    Documentation               Page 3 of 9
  120.  
  121.  
  122.  
  123.           OVERVIEW OF GREDIT
  124.           -------------------
  125.  
  126.           GREDIT(tm) is a utility you can use to modify the screen images
  127.           which are generated by the GRABBER screen capture program. 
  128.           Throughout this document, these screen image files are referred
  129.           to as GRABBER "offspring."  If you are not familiar with GRABBER
  130.           and how it works, please read the program manual GRABBER.DOC
  131.           before attempting to use GREDIT.
  132.  
  133.           Only text images captured with GRABBER may be edited.  GREDIT
  134.           does not support GRABBER's graphic images.
  135.  
  136.  
  137.  
  138.           REQUIREMENTS
  139.           -------------
  140.  
  141.           GREDIT has the same hardware and software requirements as GRAB-
  142.           BER.  These are:
  143.  
  144.                a)   an IBM-PC, XT, AT, PS/2 or 100% IBM-compatible personal
  145.                     computer;
  146.  
  147.                b)   PC-DOS or MS-DOS, Version 3.0 or later; c) at least one
  148.                     diskette drive; and c) at least 256Kb free memory.
  149.  
  150.           You can use GREDIT with either a color or monochrome display.
  151.  
  152.  
  153.  
  154.           STARTING GREDIT
  155.           ----------------
  156.  
  157.           To start the program, simply type GREDIT at the DOS prompt,
  158.           optionally followed by the name of the GRABBER offspring file you
  159.           wish to edit, then press <RETURN>.  The correct syntax is:
  160.  
  161.                                   GREDIT [filename]
  162.  
  163.           If you omit the filename, the program will ask you to supply one.
  164.  
  165.           GREDIT assumes that the file you wish to edit has the extension
  166.           ".EXE" in its name.  Therefore, you can omit the extension when
  167.           specifying the file to be edited.  For instance, entering "GREDIT
  168.           SCREEN00" is the same as entering "GREDIT SCREEN00.EXE".
  169.  
  170.  
  171.           GREDIT                    Documentation               Page 4 of 9
  172.  
  173.  
  174.  
  175.           EDITING THE OFFSPRING FILE
  176.           ---------------------------
  177.  
  178.           You are now inside GREDIT, with the cursor at the upper left-hand
  179.           corner of the screen.  You may use your keyboard to edit the
  180.           image inside the GRABBER offspring file, including its text
  181.           content, layout and color scheme.  At your disposal are all of
  182.           the alphanumeric and cursor-movement keys, the function keys <F1>
  183.           through <F10>, plus 17 special Alt-key functions which are
  184.           described below.
  185.  
  186.  
  187.  
  188.           CURSOR MOVEMENT
  189.           ----------------
  190.  
  191.           GREDIT supports the following keys on your PC keyboard to help
  192.           you move around inside your GRABBER offspring image.  Except for
  193.           the backspace key ( <X] ), none of these keys alters the image on
  194.           the screen; they merely move the editing cursor to the desired
  195.           location.
  196.  
  197.  
  198.           [UP ARROW]  . . . . . . cursor up one line
  199.           [DOWN ARROW]  . . . . . cursor down one line
  200.           [LEFT ARROW]  . . . . . cursor one space to the left
  201.           [RIGHT ARROW] . . . . . cursor one space to the right
  202.           [HOME]  . . . . . . . . cursor to upper left corner of display
  203.           [PAGE UP] . . . . . . . cursor to upper right corner of display
  204.           [END] . . . . . . . . . cursor to lower left corner of display
  205.           [PAGE DOWN] . . . . . . cursor to lower right corner of display
  206.           [RETURN]  . . . . . . . cursor to left edge, next line down
  207.           [TAB] . . . . . . . . . cursor right to next tab stop
  208.           [SHIFT-TAB] . . . . . . cursor left to previous tab stop
  209.           [BACKSPACE] . . . . . . cursor one space left, erase char. there
  210.  
  211.  
  212.           The [INSERT] key deserves a special mention.  This key does not
  213.           allow you to insert characters into a line as you would expect
  214.           using a word processor.  Rather, holding down the [INSERT] key
  215.           while pressing another alphanumeric or function key 1-10 causes
  216.           the editing cursor to advance backward from right to left.  This
  217.           can be helpful when drawing boxes with the <F1-F10> keys.
  218.  
  219.  
  220.           GREDIT                    Documentation               Page 5 of 9
  221.  
  222.  
  223.  
  224.           GREDIT ALT-KEY FUNCTIONS
  225.           -------------------------
  226.  
  227.  
  228.             KEY                          FUNCTION
  229.           -------   ------------------------------------------------------
  230.  
  231.           Alt-H     Help
  232.  
  233.                     This function pops up a list of all of GREDIT's special
  234.                     Alt-key functions and a brief description of each. 
  235.                     Press any key to resume editing.
  236.  
  237.  
  238.           Alt-Q     Quit
  239.  
  240.                     This function exits GREDIT, and gives you the option of
  241.                     saving your changes to disk before leaving.
  242.  
  243.  
  244.           Alt-S     Save
  245.  
  246.                     This function saves your changes to disk without exit-
  247.                     ing the program.
  248.  
  249.  
  250.           Alt-A     Save to ANSI file
  251.  
  252.                     This function saves the current image to an ANSI-en-
  253.                     coded file.  ANSI files are text files which contain
  254.                     special control codes that preserve all of the colors
  255.                     in the image.  The Alt-A function performs the same
  256.                     task as the separate GR2ANSI(tm) program, a command-
  257.                     line utility which is also included in the GRABBER
  258.                     package.
  259.  
  260.  
  261.           Alt-F     Colors
  262.  
  263.                     This function lets you change the global color attrib-
  264.                     ute.  To adjust the foreground color, press the up and
  265.                     down arrow keys.  To adjust the background color, press
  266.                     the left and right arrow keys.  To resume editing,
  267.                     press <Esc> or <Return>.  Users with monochrome systems
  268.                     should also read about the Alt-Y function below.
  269.  
  270.  
  271.           Alt-L     Blink
  272.  
  273.                     This function toggles the "blink" attribute on and off
  274.                     for characters typed at the keyboard.
  275.  
  276.  
  277.           GREDIT                    Documentation               Page 6 of 9
  278.  
  279.  
  280.  
  281.             KEY                          FUNCTION
  282.           -------   ------------------------------------------------------
  283.  
  284.           Alt-B     Border color
  285.  
  286.                     This function lets you adjust the color of the screen
  287.                     border on color systems.  Border color is not available
  288.                     on monochrome systems.
  289.  
  290.  
  291.           Alt-K     Clear screen
  292.  
  293.                     This function erases the entire display, and fills it
  294.                     with the last color you specified using the Alt-F
  295.                     function.
  296.  
  297.  
  298.           Alt-E     Erase line
  299.  
  300.                     This function erases the line on which the cursor is
  301.                     currently located.  To avoid accidental erasures, Alt-E
  302.                     must be pressed twice.  The erased line will be filled
  303.                     with the last color you specified using the Alt-F
  304.                     function.
  305.  
  306.  
  307.           Alt-W     Wipe
  308.  
  309.                     This function lets you change either the foreground or
  310.                     the background color of ALL characters on the screen at
  311.                     once.  After pressing Alt-W, press <F> to wipe the
  312.                     foreground, or <B> to wipe the background, or any other
  313.                     key to cancel.  The foreground or background will be
  314.                     wiped to the last color you specified using the Alt-F
  315.                     function.
  316.  
  317.  
  318.           Alt-R     Ruler
  319.  
  320.                     This function toggles on and off the ruler display at
  321.                     the top of the screen.  The ruler shows all of the
  322.                     currently defined tab stops.  While the ruler is being
  323.                     displayed, you cannot make changes to the top line of
  324.                     the image.
  325.  
  326.  
  327.           Alt-T     Tabs
  328.  
  329.                     This function lets you adjust the tab value.  The
  330.                     minimum tab value is always 2.  The maximum value
  331.                     equals the number of character spaces per line, minus
  332.                     one.
  333.  
  334.  
  335.           GREDIT                    Documentation               Page 7 of 9
  336.  
  337.  
  338.  
  339.             KEY                          FUNCTION
  340.           -------   ------------------------------------------------------
  341.  
  342.           Alt-I     Import
  343.  
  344.                     This function allows you to import plain ASCII text
  345.                     files into your image.  Imported files are overlaid
  346.                     onto whatever image already exists on the screen, using
  347.                     the foreground and background colors you specified with
  348.                     the most recent Alt-F function.  GREDIT reads in only
  349.                     as much of the text file as will fit on the screen,
  350.                     starting from the top of the file.
  351.  
  352.  
  353.           Alt-N     New offspring
  354.  
  355.                     This function lets you load and edit a new GRABBER
  356.                     offspring image.  Alt-N does not remind you to save the
  357.                     current image before loading another, so you may want
  358.                     to invoke Alt-S first.
  359.  
  360.  
  361.           Alt-C     Copy to clipboard
  362.  
  363.                     This function allows you to specify a rectangular area
  364.                     of the image to copy to GREDIT's off-screen "clipboard"
  365.                     storage area.  First, move the cursor to one of the
  366.                     four corners of the area to be copied, and press Alt-C. 
  367.                     Then, use the arrow keys to move the cursor to the
  368.                     *opposite* corner of the area to be saved, and press
  369.                     <Return>.  To confirm the area selected, press <Return>
  370.                     again, or press <Esc> to cancel.  Please note that
  371.                     GREDIT's clipboard can fit only one item at a time;
  372.                     when you copy something to the clipboard, you erase the
  373.                     clipboard's previous contents.
  374.  
  375.  
  376.           Alt-X     Cut to clipboard
  377.  
  378.                     This function works exactly like the Alt-C function de-
  379.                     scribed above, with one difference.  Whatever portion
  380.                     of the image you select will also be erased from the
  381.                     screen after it is moved to the clipboard.
  382.  
  383.  
  384.           GREDIT                    Documentation               Page 8 of 9
  385.  
  386.  
  387.  
  388.             KEY                          FUNCTION
  389.           -------   ------------------------------------------------------
  390.  
  391.           Alt-P     Paste from clipboard
  392.  
  393.                     This function can be used to paste the contents of the
  394.                     clipboard back to the screen.  First, move the cursor
  395.                     to the upper-left corner of the area you wish to fill
  396.                     from the clipboard, and press Alt-P.  GREDIT will show
  397.                     you the outlines of the area saved on the clipboard. 
  398.                     To confirm the Paste operation, press <Return>, or
  399.                     press <Esc> to cancel.
  400.  
  401.  
  402.           Alt-D     Line-drawing help
  403.  
  404.                     This function pops up a list of line- and box-drawing
  405.                     characters, and the function keys (F1 through F10)
  406.                     which are associated with them.  To access these char-
  407.                     acters in GREDIT, press the function  key indicated in
  408.                     the list, either alone or together with the <Shift>,
  409.                     <Ctrl> or <Alt> keys.  Press any key to exit the list
  410.                     and resume editing.
  411.  
  412.  
  413.           Alt-G     Graphics character help
  414.  
  415.                     This function pops up a table showing all the special
  416.                     graphics characters in the IBM-PC character set.  The
  417.                     numbers at the left and top of the grid are added
  418.                     together to determine the ASCII code of any character
  419.                     in the table. To access these characters in GREDIT,
  420.                     first hold down the <Alt> key, then type the charac-
  421.                     ter's ASCII code on your keyboard's numeric keypad, and
  422.                     then release the <Alt> key.
  423.  
  424.  
  425.           Alt-Y     Query attribute at cursor
  426.  
  427.                     This function is available on monochrome systems only. 
  428.                     It allows you to determine how a certain character will
  429.                     appear if the offspring screen is later shown on a
  430.                     color display.  Move the cursor to the character you
  431.                     want to check, and press Alt-Y.  The top line of the
  432.                     display will tell you the "foreground-on-background"
  433.                     color scheme for this character if it were shown on a
  434.                     color system.
  435.  
  436.  
  437.           GREDIT                    Documentation               Page 9 of 9
  438.  
  439.  
  440.  
  441.           ELIMINATING GREDIT's BEEP SOUNDS
  442.           ---------------------------------
  443.  
  444.           To eliminate the beep sounds which GREDIT normally makes when you
  445.           invoke any of its special Alt-key functions, include the /Q
  446.           command-line switch when you start the program at the DOS prompt. 
  447.           For example:
  448.  
  449.                                    GREDIT /Q
  450.                             or,
  451.                                    GREDIT screenxx /Q
  452.  
  453.           If you omit the /Q switch from the command line and later decide
  454.           to turn off the beep sounds, you must exit the program (don't
  455.           forget to save your work) and restart the program using the /Q
  456.           switch on the command line.
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.                            * * *  End of GREDIT.DOC  * * *
  493.