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