home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 10 / Fresh_Fish_10_2352.bin / useful / util / edit / mg / docs / amiga next >
Text File  |  1990-06-02  |  29KB  |  712 lines
  1.  
  2.             Amiga MG 3Beta4 Release Notes
  3.             -------------------------
  4.  
  5.    This file attempts to document the Amiga-specific features of MG 2a.
  6. Except where otherwise noted.  It is assumed that you already know
  7. about the point and the mark, buffers, windows, extended commands, and
  8. the various areas on the screen that all versions of MG maintain.  If
  9. you don't, see the MG documentation (what there is of it) for more
  10. information. 
  11.  
  12.                   Amiga Credits
  13.                   -------------
  14.  
  15.   The Amiga Intuition terminal driver is the combined effort of Mike
  16. Meyer and Mic Kaczmarczik.  Others who helped and/or inspired good
  17. ideas for the MG terminal driver include Steve Walton, Leon Frenkel,
  18. Marcus Brooks, and Tom Rokicki.  Steve Walton is also responsible for
  19. the dired mode. Bob Larson redesigned the MG keymap system, making it
  20. possible for function keys and mouse clicks to be ``first-class
  21. citizens''. Lastly, Mike Meyer added the Rexx support and redesigned
  22. the MG keymap & macro facilities, adding named keyboard macros and
  23. making them first-class objects.
  24.  
  25.                               OPTIONS
  26.                               -------
  27.  
  28.    This section is for people who have their own C compiler. If you
  29. don't have a C compiler, you will hopefully have a version that has
  30. everything compiled into it. 
  31.  
  32.    There are a bewildering variety of extra goodies available as
  33. compile-time options when you construct an Amiga MG. If you select none
  34. of them, you save on disk and memory space, but lose out on some
  35. features and versatility. 
  36.  
  37.    The config files provides documentation on these options and what
  38. to do to make them work. Read those and the documentation on config
  39. for descriptions on them.
  40.  
  41.     For those without ARexx (required to use the config program), the
  42. directory for the fully-featured configuration (Burrito) has been
  43. provided. The documentation for config should provide enough
  44. information to allow you to edit the include files by hand to create
  45. any version you wish to build.
  46.  
  47.                               THE MOUSE
  48.                               ---------
  49.  
  50.    The Amiga Mouse can invoke no less than 24 different functions.
  51. Mouse clicks are essentially treated as keys by the MG, even though you
  52. click the mouse and hold down qualifier keys to get them. 
  53.  
  54.    Mouse keys come in three groups of eight, the groups being:
  55.     Mouse keys        -- when clicked in the text of a window
  56.     Mode-Mouse keys        -- when clicked on a window's mode line
  57.     Echo-Mouse keys        -- when clicked in the echo area
  58.  
  59.    Inside each group, which of the eight keys you get is determined by
  60. the combination of Shift, CTRL and ALT keys you are holding down when
  61. the mouse button is pressed. So yes, there really is a
  62. Ctrl-Meta-Shift-Mode-Mouse button.  Note that the Meta (M-) prefix
  63. *MUST* be the ALT key. Prefixing a mouse click with ESC will not work. 
  64.  
  65.    Mouse keys are generally bound to functions that affect the text in
  66. the selected buffer. If the Intuition mouse pointer is located inside an
  67. MG text window (i.e. an area where text is being edited), then a Mouse
  68. key is sent to the editor when you click the mouse. The buffer
  69. associated wth the window the pointer is in is made current, point is
  70. set as close as possible to the pointer (the character under the
  71. pointer, if possible), then the command bound to that mouse button is
  72. executed. 
  73.  
  74.    If the mouse pointer is in the mode line - the line that is in a
  75. different typeface (usually backlit, maybe black instead of white) --
  76. when the mouse button is clicked, a Mode-Mouse key is sent to the
  77. editor. The buffer that the selected status line is associated with is
  78. made the current buffer, the point is set to the value of point for
  79. that window, then whatever command is bound to that button is
  80. executed. Most of the Mode-Mouse keys invoke functions that act on the
  81. entire window or buffer.
  82.  
  83.    Clicking in the echo line - the line at the bottom of the screen
  84. where prompts and message appear - results in an Echo-Mouse key.
  85. Whatever command is bound to that button will be executed.  Since the
  86. echo line is not part of a buffer or a window, all the functions bound
  87. to Echo-Mouse keys affect the state of the editor as a whole.
  88.    
  89.    The default bindings for the hot mouse (as distributed) are:
  90.  
  91.  Qualifiers  |            Area clicked
  92.              |
  93. C  A  Shift  |    Text window        Mode line    Echo line
  94. -------------+---------------------------------------------------------
  95.          |    dot to mouse        forward page    switch to other buffer 
  96.       X         |    recenter        backward page    kill buffer
  97.    X         |    delete word        split window    describe key
  98.    X  X         |    kill line        delete window    describe bindings
  99. X         |    delete char        goto bob    suspend MG
  100. X     X         |    delete whitespace    goto eob    quit
  101. X  X         |    kill region        enlarge window    list buffers
  102. X  X  X         |    yank            shrink window    toggle Intuition window
  103.  
  104.    To help keep straight what the various keys do, notice that the
  105. Status and Echo groups come in pairs; the shifted version of a key is in
  106. some sense the opposite of the unshifted version. There is no opposite
  107. for display-buffers, so that key is bound to "amiga-toggle-border",
  108. which toggles MG' Intuition window between bordered and borderless. 
  109.  
  110.    Like any MG key, you are free to rebind the 24 mouse buttons to do
  111. whatever you wish.  You may even rebind them in your startup sequence.
  112. NOTE: only functions that start with the prefix "mouse-" are able to
  113. handle clicks in windows and mode lines, because they know how to figure
  114. out where the mouse was clicked. Conversely, any non-mouse function may
  115. be bound to an Echo-Mouse key, because clicking in the echo area does
  116. not send the x,y click information to the function.
  117.  
  118.    If the iconification code is compiled in, then Echo-Mouse is bound
  119. to ``amiga-iconify'' by default.
  120.  
  121.                THE KEYBOARD
  122.                ------------
  123.  
  124.    There is a shortcut for many of the Meta commands (usually indicated
  125. by the ESC character): hold down the ALT key at the same time you type
  126. what usually comes after the ESC. 
  127.  
  128.    Historically, this is why keys that are typed with ESC in front of
  129. them are called META keys; on the terminals at MIT where the Emacs
  130. editor (MG's spiritual parent) was originally written, there was a META
  131. key on the keyboard that did what the ALT key does. However, not many
  132. terminals outside of MIT have the META key at all, so the ESC key was
  133. nominated as a way to tell the system that the next character should be
  134. converted into a META key before it is interpreted. 
  135.  
  136.    MG also recognizes Amiga function keys.  For quick help on a key,
  137. type the HELP key and then the key you want help on. The following
  138. commands are bound to the Amiga function keys:
  139.  
  140.     Key            Function
  141.     --------------------------------------------
  142.     Help            describe-key-briefly
  143.  
  144.     Left            backward-char
  145.     Shift-Left        backward-word
  146.     Right            forward-char
  147.     Shift-Right        forward-word
  148.  
  149.     Up            previous-line
  150.     Shift-Up        backward-paragraph
  151.  
  152.     Down            next-line
  153.     Shift-Down        forward-paragraph
  154.  
  155.     F1            find-file
  156.     Shift-F1        find-file-other-window
  157.     F2            save-buffer
  158.     Shift-F2        write-file
  159.     F3            scroll-up (page down)
  160.     Shift-F3        scroll-down (page up)
  161.     F4            enlarge-window
  162.     Shift-F4        shrink-window
  163.     F5            fill-paragraph
  164.     Shift-F5        query-replace
  165.     F6            split-window-vertically
  166.     Shift-F6        delete-other-windows
  167.     F7            transpose-chars
  168.     Shift-F7        just-one-space
  169.     F8            start-kbd-macro
  170.     Shift-F8        end-kbd-macro
  171.     F9            call-last-kbd-macro
  172.     Shift-F9        describe-bindings
  173.     F10            list-buffers
  174.     Shift-F10        save-buffers-kill-emacs
  175.  
  176.               FUNCTION KEY NAMES
  177.               ------------------
  178.  
  179. On the Amiga, all the function keys are readily visible on the
  180. keyboard, so this table of key names for use in strings is fairly
  181. self-explanitory.  If you want to rebind Shift-Down-Arrow to scroll-up
  182. (move down a whole page), for example, insert the line
  183.  
  184.     global-set-key "\F5" scroll-up
  185.  
  186. in your s:mg-startup file.
  187.  
  188.     Amiga key            Startup name
  189. -------------------------------------------------------------------------
  190.     Up-Arrow            \F0
  191.     Down-Arrow            \F1
  192.     Left-Arrow            \F2
  193.     Right-Arrow            \F3
  194.  
  195.     Shift-Up-Arrow            \F4
  196.     Shift-Down-Arrow        \F5
  197.     Shift-Left-Arrow        \F6
  198.     Shift-Right-Arrow        \F7
  199.  
  200.     Help                \F9
  201.  
  202.     F1                \F12
  203.     F2                \F13
  204.     F3                \F14
  205.     F4                \F15
  206.     F5                \F16
  207.     F6                \F17
  208.     F7                \F18
  209.     F8                \F19
  210.     F9                \F20
  211.     F10