home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / dirs / powersnap_467.lzh / PowerSnap / PowerSnap.doc < prev    next >
Text File  |  1991-03-10  |  13KB  |  296 lines
  1.  
  2.  
  3.                           PowerSnap 1.0 User Manual
  4.  
  5.                                  Oct 22, 1990
  6.  
  7.  
  8.  
  9. ›1mPreface›0m
  10. ›1m=======›0m
  11.  
  12.      This program is freeware, this means that you can copy it freely as long
  13. as you don't ask any more money for it than a nominal fee for copying. If you
  14. want to distribute this program you should keep this document with it. Both
  15. program and document must be distributed in their original unmodified form.
  16. This program cannot be used for commercial purposes without written permission
  17. from the author.
  18.      If you have suggestions or remarks about this program, or if you find
  19. any bugs, please let me know.
  20.  
  21.      Write to the following address:
  22.  
  23.                                 Nico François
  24.                                 Corbielaan 13
  25.                                 B-3060 Bertem
  26.                                 BELGIUM
  27.  
  28.  
  29. ›1mContents›0m
  30. ›1m========›0m
  31.  
  32. 1. An introduction
  33.  
  34. 2. Installation
  35.  
  36. 3. CLI usage
  37.  
  38. 4. Workbench usage
  39.  
  40. 5. Features
  41.  
  42.  
  43. ›1m1. An introduction›0m
  44. ›1m==================›0m
  45.  
  46.      Snap, snap, snap, snap, snap, eggs and snap :-)  Ahem...
  47.  
  48.      PowerSnap is a utility that allows you to use the mouse to mark
  49. characters anywhere on the screen and paste them somewhere else, like in the
  50. CLI or in a string gadget.  PowerSnap will check what font is used in the
  51. window you snap from and will look for the position of the characters
  52. automatically.  It recognizes all non proportional fonts of up to 24 pixels
  53. wide and of any height so this should cover most fonts used.  Snapping and
  54. pasting text is done using the mouse, making PowerSnap fast and easy to use.
  55.      To try PowerSnap out, double-click its icon to install the handler, move
  56. the mouse over a character on the screen, press the left ALT key and while
  57. keeping this pressed press the left mouse button.  After a short delay
  58. (depends on how big the font is) PowerSnap will either flash the screen,
  59. indicating it hasn't found a character at this position (it is possible
  60. PowerSnap didn't look for the correct font), or the character you are pointing
  61. at will be selected.  Move the mouse while keeping the left ALT key and the
  62. mouse button down to select more characters.  Once you are satisfied with what
  63. you have selected release the left ALT key.  You can now insert the text you
  64. have just snapped by pressing either left ALT + V or left ALT + right mouse
  65. button.
  66.      Both the left ALT and the 'V' keys mentioned in this short explanation
  67. are user-definable (see below).  Also, don't start snapping on a space because
  68. PowerSnap will almost certainly get the character positions wrong.  You CAN
  69. start snapping on a space if you have already snapped in the window.
  70.  
  71.  
  72. ›1m2. Installation›0m
  73. ›1m===============›0m
  74.  
  75.      To install PowerSnap automatically run the installation script.  Install
  76. manually by copying 'PowerSnap' and 'PowerSnap.info' to your C: directory and
  77. 'powersnap-handler' to your L: directory.  'powersnap-handler' does not have
  78. to be in L: but it is best if you put it there, PowerSnap will also find it
  79. if it is in the current directory.
  80.      If you want PowerSnap to be part of your initial startup (so you always
  81. have the comfort of snapping anything anywhere :-) you should put a simple
  82. line saying 'PowerSnap' before the 'EndCLI >NIL:' in your startup-sequence.
  83. If you wish to specify options include these on the same line, like e.g.
  84. 'PowerSnap COLOR 1'.  To disable the copyright message redirect output to NIL:
  85. like in 'PowerSnap >NIL:'.
  86.      Workbench 2.0 users have the following extra possibility:  drag the
  87. PowerSnap icon into the WbStartup drawer of your boot disk/partition.  And
  88. that's all there is to it.  Specify options in the icon's tooltypes.  If you
  89. do it this way you don't have to change your startup-sequence.
  90.  
  91.  
  92. ›1m3. CLI usage›0m
  93. ›1m============›0m
  94.  
  95.      Enter 'PowerSnap ?' for a CLI usage template:
  96.  
  97.      ›1mPowerSnap 1.0›0;33m by Nico François (PowerPeak)›0m
  98.      Usage: PowerSnap [QUAL qual] [SLQUAL qual] [PASTEKEY char] [PRIORITY n]
  99.                       [COLOR 1-3] [PAQUAL qual] [PREPEND str] [APPEND str]
  100.                       [SNAPCHARS] [SNAPFRAME] [[NO]JOIN] [[NO]XEROX]
  101.          or PowerSnap LIST
  102.          or PowerSnap QUIT
  103.  
  104.      Explanation of the options:
  105.  
  106.      QUAL qual   : Set snap qualifier (qual, default: LALT).
  107.                    This is the qualifier that must be down when you press
  108.                    the left mouse button to start snapping.  This is also the
  109.                    qualifier for inserting the snapped text.  There are two
  110.                    ways to insert snapped text: using the pastekey or using
  111.                    the right mouse button.
  112.      SLQUAL qual : Set single line qualifier (qual, default: LALT+LSHIFT).
  113.                    When this qualifier is down and you insert snapped text
  114.                    everything will be put on one single line.  All whitespace
  115.                    (spaces and newlines) between words will be changed to a
  116.                    single space.  Very useful for inserting a lot of filenames
  117.                    from a directory for example.
  118.      PASTEKEY c  : Set pastekey (character, default: V).
  119.                    This key is used to insert the snapped text.  Insertion
  120.                    will follow when it is pressed with on of the three
  121.                    possible qualifiers down (QUAL, SLQUAL, PAQUAL).
  122.      PRIORITY n  : Set priority of inputhandler (dec, default: 55).
  123.                    Priority of input handler (should always be > 50).
  124.      SNAPCHARS   : Start with character snap (default).
  125.      SNAPFRAME   : Start with frame snap.
  126.                    PowerSnap has two snap modes: character and frame.  The
  127.                    easiest to explain is frame snap, you just draw a rectangle
  128.                    and everything inside it will be snapped.  Character snap
  129.                    will interpret the screen as lines of text (like an editor)
  130.                    and will snap accordingly.
  131.      [NO]JOIN    : Join mode on/off (default: on).
  132.                    Tells PowerSnap if it's ok to join two lines to a single
  133.                    long line when the first line has a non blank character
  134.                    as its last character.  This only works when you are using
  135.                    character or word snap.  Default is JOIN.
  136.      [NO]XEROX   : Xerox insert mode on/off (default: off).
  137.                    When xerox mode is on snapped text will be inserted
  138.                    immediately when you stop snapping.  Default is NOXEROX.
  139.      COLOR 1-3   : Set color of select box (1-3, default: 2).
  140.                    This sets the color of the complemented characters.
  141.                    Try all three and see what you like best.
  142.      PAQUAL qual : Set pre-/append qualifier (qual, default: LALT+CONTROL).
  143.                    When using this qualifier to insert snapped text a string
  144.                    will be prepended to each line and one will be appended.
  145.      PREPEND str : Set prepend string (default: "> ").
  146.                    Use this to set the string that will be prepended when you
  147.                    paste with the PAQUAL down.  This string can be up to 15
  148.                    characters long.  To enter a '"' in the string escape it
  149.                    with a '*'.  E.g. 'PowerSnap PREPEND " *" "'.
  150.      APPEND str  : Set append string (default: empty).
  151.                    Use this to set the string that will be appended when you
  152.                    paste with the PAQUAL down.  Can be up to 15 characters.
  153.  
  154.      Following qualifiers are recognized:
  155.  
  156.          LSHIFT          Left shift key
  157.          RSHIFT          Right shift key
  158.          CONTROL         Control key
  159.          LALT            Left alt key
  160.          RALT            Right alt key
  161.          LCOMMAND        Left Amiga key
  162.          RCOMMAND        Right Amiga key
  163.          MIDBUTTON       Middle mouse button (if you have one :-)
  164.  
  165.      Or any combination of these (separate the qualifiers by a non-alpha
  166. character like a '+', '-' or '|'), e.g. 'LALT+LSHIFT' or 'LALT-LSHIFT'.
  167.  
  168.      You may run PowerSnap again once it has been installed to change the
  169. settings.  Enter 'PowerSnap LIST' for a list of current settings.
  170.      'PowerSnap QUIT' will remove the handler from memory.
  171.  
  172.      Examples:
  173.  
  174.         o PowerSnap PREPEND "Type " APPEND " OPT N"
  175.  
  176.          When you paste some text 'Type ' will be inserted before each line
  177.          and ' OPT N' after.  If you e.g. snap 'PowerSnap.c' and press
  178.          LALT-CTRL-V the following will be inserted: 'Type PowerSnap.c OPT N'
  179.  
  180.         o PowerSnap QUAL LSHIFT+RSHIFT+CONTROL
  181.  
  182.          This sets the snap qualifier to both shift keys plus the control
  183.          key.  This is a rather silly example because unless your name is
  184.          Zaphod Beeblebrox or you are very good at doing things with your
  185.          feet it is quite impossible to snap anything with this qualifier :^)
  186.  
  187.         o PowerSnap PASTEKEY i
  188.  
  189.          Sets the insert key to 'I' instead of 'V'.  So pressing LALT-I
  190.          will feed the text in the clipboard to the keyboard.
  191.  
  192. NOTE: - You can toggle between character/frame snap once you have started
  193.         snapping.  Just keep the left mouse pressed down while you click the
  194.         right one.  Be careful, if you don't keep the left button pressed
  195.         you will insert the text you have marked.
  196.       - PowerSnap has the ability to do word oriented snapping.  To activate
  197.         this double-click the left mouse button when you start snapping.  Note
  198.         that word snapping forces character snapping and frame snapping is no
  199.         longer possible.
  200.       - Press the left mouse button while PowerSnap is inserting to abort.
  201.  
  202.  
  203. ›1m4. Workbench usage›0m
  204. ›1m==================›0m
  205.  
  206.      PowerSnap recognizes the following tooltypes (see CLI options for a more
  207. complete explanation):
  208.  
  209.      QUAL=qual   : Set snap qualifier (qual, default: LALT).
  210.      SLQUAL=qual : Set single line qualifier (qual, default: LALT+LSHIFT).
  211.      PASTEKEY=c  : Set pastekey (character, default: V).
  212.      PRIORITY=n  : Set priority of inputhandler (dec, default: 55).
  213.      SNAPCHARS   : Start with character snap (default).
  214.      SNAPFRAME   : Start with frame snap.
  215.      COLOR=1-3   : Set color of select box (1-3, default: 2).
  216.      JOIN        : Join mode on (default).
  217.      NOJOIN      : Join mode off.
  218.      XEROX       : Xerox insert mode on.
  219.      NOXEROX     : Xerox insert mode off (default).
  220.      PAQUAL=qual : Set pre-/append qualifier (qual, default: LALT+CONTROL).
  221.      PREPEND=str : Set prepend string (default: "> ").
  222.      APPEND=str  : Set append string (default: empty).
  223.                    Do NOT put quotes around the pre-/append string.
  224.  
  225.      Select PowerSnap's icon and choose 'Information' from the 'Icons' menu
  226. (Workbench 2.0) or 'Info' from the 'Workbench' menu (Workbench 1.3).  You can
  227. now edit PowerSnap's tooltypes, check your manual for more information.
  228.      Run PowerSnap twice to remove it from memory.
  229.  
  230. NOTE: - Workbench 1.2/1.3 users MUST always include an '=' in a tooltype.
  231.         So instead of entering "XEROX" to switch on xerox insert mode, you
  232.         must insert "XEROX=".  Workbench 2.0 no longer has this limitation.
  233.  
  234.  
  235. ›1m5. Features›0m
  236. ›1m===========›0m
  237.  
  238.      o Fully supports the clipboard.device.  You can use snapped text in all
  239.        other programs that supports the clipboard.device.
  240.  
  241.      o Snaps all printable characters, from ' ' (32) to 'ÿ' (255).
  242.  
  243.      o Supports all keymaps.
  244.  
  245.      o Uses a relatively small handler that is about 7.2K long.  PowerSnap
  246.        uses less than 12K of memory once it is installed (excluding memory
  247.        used by the clipboard.device).
  248.  
  249.      o Recognizes all non-proportional fonts to up to 24 pixels wide and of
  250.        any height.  Also recognizes scaled fonts (Workbench 2.0).
  251.  
  252.      o Recognizes plain, underlined, bold, inverse, bold underlined, inverse
  253.        underlined, inverse bold and inverse bold underlined characters :-)
  254.  
  255.      o Works with fonts with kerning data (like the courier.font supplied
  256.        with Workbench 2.0).
  257.  
  258.      o Will remember character positions in up to 8 windows.  Once you have
  259.        snapped in a window the initial character position will be found
  260.        immediately and you may also start snapping on spaces.
  261.  
  262.      o Joins long lines.
  263.  
  264.      o Pre-/appends strings and has a neat single-line insert mode :-)
  265.  
  266.      o Supports a middle mouse button if one exists.  Using the middle button
  267.        as qualifier gives the possibility to snap/paste without touching the
  268.        keyboard!
  269.  
  270.      o Inputhandler is written in assembly for lowest possible overhead.
  271.  
  272.      o AmigaDOS Release 2 compatible (Kickstart & Workbench 2.0).
  273.  
  274.  
  275.                                                  As always, enjoy !
  276.  
  277.  
  278.                               PROGRAM HISTORY:
  279.  
  280. ******************************************************************************
  281. VERSION 1.0
  282.  
  283.      First release.
  284.  
  285. ******************************************************************************
  286.  
  287. PowerSnap 1.0 written by Nico François (Yes, Nico is my first name :-)
  288.               thanks to Jorrit Tyberghein, Ives Aerts & Philip Marivoet for
  289.                         beta testing.
  290.  
  291. (c) 1990 Nico François / PowerPeak
  292.  
  293.                                    //
  294.                        Thanks to \X/ Amiga for being the best computer ever !
  295.  
  296.