home *** CD-ROM | disk | FTP | other *** search
/ CICA 1992 November / CICA_MS_Windows_CD-ROM_Walnut_Creek_November_1992.iso / win3 / util / mew11 / readme < prev   
Text File  |  1992-10-13  |  14KB  |  355 lines

  1. MicroEMACS 3.11c for MS-Windows, update 1.1         by Pierre Perret
  2. ===========================================         October 12, 1992
  3.  
  4. INSTALLATION
  5. ------------
  6.  
  7. Copy the files from the executable distribution package (MEW11.ZIP for
  8. Windows 3.1 or/and MEWN11.ZIP for Windows NT on i386) into the
  9. directory where you want the program to reside. If you want to use the
  10. MicroEMACS help file, copy it (MEWIN.HLP, from MEWH11.ZIP) in that same
  11. directory. 
  12.  
  13. Unlike previous version of MicroEMACS for Windows, update 1.1 can
  14. operate entirely without any specific profile entry in the WIN.INI file.
  15. On the other hand, if you want to deviate from the installation
  16. recommended above, you may have to edit the WIN.INI file. For more
  17. information on this, consult the "Profiles" topic (within the "Start-up"
  18. chapter) in the MEWIN.HLP help file and copy/paste the relevant parts
  19. from the EMACS.INI file.
  20.  
  21. After installation is complete, the EMACS.INI, PACKAGES.LST and README
  22. files are no longer needed and can be deleted.
  23.  
  24. If you install both the Windows 3.x and Windows NT packages in the same
  25. directory, note that the files that bear the same name in both packages
  26. are exact duplicates.
  27.  
  28. Special Cases
  29. -------------
  30.  
  31. This program can run under Windows 3.0 (retail version), 3.1 (retail or
  32. debugging versions) or Windows NT. Because it contains references to
  33. system DLL entries that are not present under Windows 3.0, it cannot run
  34. under the debugging version of Windows 3.0. Further more, under Windows
  35. 3.0, there needs to be a Dynamic Link Library named SHELL.DLL lying
  36. around for the loading of the program to complete.
  37.  
  38. The macro files EMACS.RC and MDI.CMD are setup for Super VGA displays
  39. that can accomodate a text width of at least 100 character. If your
  40. display is VGA-size (or a laptop screen), you can replace 80 by 75 in
  41. the line (in MDI.CMD):
  42.     set %scrwidth 80
  43. Also, delete or comment-out the line (in EMACS.RC):
  44.     100  change-screen-width
  45. and add the lines:
  46.     [MicroEMACS]
  47.     InitialSize=optimized
  48. in your WIN.INI file.
  49.  
  50. The EMACS.RC, CUA.CMD, MDI.CMD and DEV.CMD macro files are made a part
  51. of this package as example of how macros can be used to customize
  52. MicroEMACS. A simple way to add your own macros is to put them in a file
  53. called CUSTOM.CMD (this file, if it exists, is invoked by EMACS.RC).
  54.  
  55. OTHER FILES:
  56. -----------
  57.  
  58. As mentionned above, a help file (packaged in MEWH11.ZIP) is available
  59. for this version of MicroEMACS for Windows.
  60.  
  61. The sources for this port are publicly available. They are packaged in a
  62. file named MEWS11.ZIP. Also available but possibly less widely
  63. distributed are the help file's RTF-format sources (in MEWR11.ZIP).
  64.  
  65. Other (non MS-Windows) versions of MicroEMACS normally comes with
  66. documentation and a bunch of scripts (aka macros or "command files").
  67. They are not supplied in this distribution package, but are available
  68. separately. The files for release 3.11 are the ones you may want and
  69. they are available from a number of sources, including:
  70.  
  71. - COMPUSERVE, forum IBMAPP, library 1 for the executables (UE311I.EXE),
  72.   official 3.11 release readme file (UE311.TXT), reference manual
  73.   (UE311D.ZIP) and  macros (UE311M.ZIP). forum IBMPRO, library 3 for the
  74.   official 3.11 sources (UE311C.ZIP, UE311H.ZIP and UE311K.ZIP).
  75.  
  76. - BIX, in the editors conference's listing area.
  77.  
  78. - various Internet hosts among which wuarchive and simtel20.
  79.  
  80. - The Programmer's Room BBS (see below)
  81.  
  82. PREVIOUS VERSIONS
  83. -----------------
  84.  
  85. This program was originally born as a port of MicroEMACS to Windows 3.0
  86. which was released as MEWIN 1.0 in April 1992, also with the full C
  87. source, but without a help file.
  88.  
  89. Since then, a few intermediate updates (mainly 1.0b and 1.0e) have
  90. been made public (without sources).
  91.  
  92. HOW TO REPORT PROBLEMS OR SUBMIT SUGGESTIONS
  93. --------------------------------------------
  94.  
  95. The prefered way to reach me to discuss about this program is through
  96. CompuServe, in the WINADV forum or on BIX in the editors conference, in
  97. the emacs topic. My CompuServe ID is 73757,2337 and my BIX Id is
  98. pierre_perret. You can also send Email directly to those accounts, but
  99. forum/conference transactions have the advantage of being viewable by
  100. others.
  101.  
  102. If you do not use CompuServe or BIX, but have Internet access, you can
  103. exchange Internet mail with me by sending it to P.Perret@az05.bull.com
  104.  
  105. Other channels include:
  106.  
  107. - Phone:
  108.     (602) 862-5448 at my office (9am - 5pm)
  109.     (Note: hours given for Mountain Standard Time, no daylight savings)
  110.  
  111. - US mail:  Pierre Perret
  112.         4326 W Michigan Avenue
  113.         Glendale Az 85308
  114.  
  115. - The Programmer's Room BBS at (317) 742-5533 (300/1200/2400 and 9600
  116.   [Hayes V series only], no parity, 8 databits, no stop bits). However,
  117.   since this is a long distance call for me, I do not check-in very often.
  118.   I am registered under my real name (Pierre Perret).
  119.  
  120. Please note that I am the author of this Windows port, not the author of
  121. MicroEMACS itself. Problems that also occur with the standard 3.11c
  122. editor should be reported to Dan Lawrence on the Programmer's Room BBS.
  123.  
  124. USAGE NOTES
  125. -----------
  126.  
  127. In doing this port, I have tried to preserve as much as possible the
  128. MicroEMACS way of doing things, for the sake of minimizing changes in
  129. the editor core...
  130.  
  131. VOCABULARY:
  132.  
  133. MicroEMACS calls "screens" what really should be called "MDI windows"
  134. and calls "windows" what should be called "panes". Changing those
  135. definitions in the Windows implementation would impact all the commands
  136. that deal with "screens" and "windows" and would therefore break most
  137. macros.
  138.  
  139. INPUT TO THE MESSAGE LINE:
  140.  
  141. Depending on the particular command that requested such input,
  142. MicroEMACS implements varying character handling methods that are
  143. definitely not CUA-compliant.
  144.  
  145. TEXT SELECTION:
  146.  
  147. Contrary to CUA standards, selections are not highlited (this will
  148. be implemented in a future version of the base MicroEMACS editor).
  149.  
  150. MOUSE HANDLING:
  151.  
  152. Due to its mainframe heritage, and also it's capability to redefine
  153. mouse behavior by macros, Emacs' mouse handling differs significantly
  154. from that of other Windows applications (called CUA-compliant).
  155.  
  156. The CUA.CMD file included with this package, loaded by the included
  157. EMACS.RC, contains macros that modify the standard MicroEMACS mouse
  158. bindings to provide a CUA-like interface.
  159.  
  160. CURRENT WORKING DIRECTORY:
  161.  
  162. The current working directory and selected drive is always set to the
  163. file path associated with the current "window". If that path is not an
  164. absolute one, it is dependant upon the previously visited directory
  165. paths (including the directory field that appeared in a file dialog box,
  166. even if the operation was cancelled).
  167.  
  168. FEATURES OF THIS WINDOWS PORT (over what is standard in MicroEMACS 3.11c)
  169. -----------------------------
  170.  
  171. MENUS:
  172.  
  173. I have put most of the functions available in MicroEMACS into a set of
  174. menus (some with nested popups). There are a few MicroEMACS functions
  175. that would not make much sense in a menu and have therefore been
  176. excluded. A few menu items have no equivalent function in the MicroEMACS
  177. macro language.
  178. In addition to the standard Windows convention of appending an ellipsis
  179. to menus items that beget a dialog box, I have used the following: a
  180. colon is appended to menus items that require a user response on the
  181. message line and an equal sign is inserted in front of items that
  182. require an argument to have been entered (by META + digits).
  183.  
  184. Key bindings are displayed in the menus, using the Windows format for
  185. key descriptions instead of the MicroEMACS format (which, for some
  186. function keys, can be quite cryptic).
  187.  
  188. Some menu items may appear grayed if the context is such that they are
  189. unuseable.
  190.  
  191. ALT KEY HANDLING:
  192.  
  193. In Windows applications, the Alt key can be used in combination with a
  194. letter or digit to pull down a menu from the menu bar. In MicroEMACS,
  195. bindings have the priority over those menu bar accelerators. Thus, if
  196. there is a conflict between a menu-bar accelerator and an emacs binding,
  197. the accelerator looses. On the other hand, trying to create a new
  198. binding interactively by simply invoking bind-to-key or macro-to-key
  199. will not be possible if the desired binding matches a menu-bar
  200. accelerator.
  201. Note that a menu can still be invoked from the keyboard, even when the
  202. accelerator conflict with a binding, by pressing AND releasing the Alt
  203. key and THEN hitting the accelerator character.
  204.  
  205. "NOT QUIESCENT" STATE:
  206.  
  207. If a macro is executing, most menu selections cannot be processed (the
  208. editor is said to be in the "not quiescent" state) because a lot of
  209. MicroEMACS functions are not quite reentrant. This is reflected by a
  210. change of the mouse cursor from a pointing finger to a color-inverting
  211. arrow.
  212.  
  213. $SRES VARIABLE:
  214.  
  215. To allow Windows-aware macros, the $sres is set to "MSWIN" and cannot
  216. be modified (trying to set it has no effect, but it returns no error).
  217.  
  218. NEW MICROEMACS VARIABLES:
  219.  
  220. $hscrlbar
  221. $vscrlbar
  222.  
  223.     These two boolean variables control the presence of scrollbars
  224.     (horizontal and vertical)
  225.  
  226. NEW MICROEMACS COMMANDS:
  227.  
  228. tile-screens
  229. cascade-screens
  230. minimize-screen
  231. maximize-screen
  232.  
  233.     These commands allow shuffling of screens (aka MDI windows) from
  234.     EMACS macros.
  235.  
  236. rename-screen
  237.  
  238.     This one allows you to change the name of the current screen (that
  239.     type of command is not of much use under the other versions of EMACS
  240.     since screen names are rarely displayed).
  241.  
  242. clip-region
  243. cut-region
  244. insert-clip
  245.  
  246.     These supplement copy-region, kill-region and yank, but instead of
  247.     addressing the kill buffer, they address the Windows clipboard.
  248.  
  249. bind-to-menu
  250. macro-to-menu
  251. unbind-menu
  252.  
  253.     These functions allow dynamic modification of the menus. An example
  254.     of their use appears in the EMACS.RC sample start-up file.
  255.  
  256. help-engine
  257.  
  258.     This allows a macro to invoke the Windows Help engine. Look for
  259.     an example in the supplied EMACS.RC.
  260.  
  261. DRAG AND DROP SUPPORT:
  262.  
  263. The key sequence MS! is produced when files are dragged and dropped onto
  264. MicroEMACS. It initially not associated to any command and should be
  265. bound to a macro that handles the drag and drop action. In order for the
  266. macro to acquire the files that were dropped, an invisible buffer named
  267. "Dropped files" is filled with the following data:
  268.     first line: name of the screen on which the drop occured (or empty
  269.                 line if the drop was not done on any screen)
  270.     other lines: pathnames, one per line, of the dropped files
  271.  
  272. In addition, the $xpos and $ypos variables are set to the coordinates
  273. where the drop occured (or 255 if the drop was not done on any screen).
  274.  
  275. The MDI.CMD file contains a macro that handles file dropping.
  276.  
  277. LONG OPERATIONS:
  278.  
  279. When performing long operations (macros with loops, searches, file
  280. IOs...), MicroEMACS checks for user input regularly (see the TimeSlice
  281. profile value in EMACS.INI): during these periods, a few menu options
  282. are still available, among which quitting (Exit in File menu or Close in
  283. system menu). Note that if the user attempts to quit while a file is
  284. being written out, a confirmation is required (the same happens if there
  285. are changed buffers).
  286.  
  287. MicroEMACS cannot ignore typeahead while a lengthy operation is in
  288. process. One particular side effect of this is that if you do a ^X^F
  289. (find-file) followed by <name_of_file><RC> while a lengthy operation is
  290. going on, MicroEMACS absorbs those keystrokes and has to refeed them
  291. into the "Find file" dialog box when it eventually pops up. I have
  292. implemented a mechanism for dealing with this, but it handles only
  293. simple ASCII characters and just throws away any other keystroke (for
  294. instance, arrow keys are not forwarded to the dialog box).
  295.  
  296. FONTS:
  297.  
  298. The Font item in the Screen menu brings up a dialog box that allows the
  299. user to select a fixed font to be used. This font description can be
  300. saved in WIN.INI so that subsequent invokations of MicroEMACS use it at
  301. startup.
  302.  
  303. LOCAL AND GLOBAL MODES:
  304.  
  305. The Mode and Global mode items of the File menu bring up dialog boxes
  306. that offer a user-friendly way of setting the CMODE, VIEW, EXACT, MAGIC,
  307. etc... modes.
  308.  
  309. FILE DIALOG BOX:
  310.  
  311. Instead of using a message line interface with attempted completion of
  312. file names, this program pops up a dialog box whenever a filename has to
  313. be supplied by the user. This is an attempt at CUA compliance. It also
  314. has the side effect of supplying the editor with fully qualified
  315. pathnames. A handy filename completion feature has been implemented as
  316. well, with the addition of auto-scrolling of the filename list: if you
  317. type only the beginning of a file name, up to a point were there is no
  318. ambiguity, hitting the spacebar orders MicroEMACS to complete the
  319. filename for you and OK the dialog.
  320.  
  321. HELP SYSTEM:
  322.  
  323. The first four items in the Help menu load the MEWIN.HLP help file into
  324. the Windows help engine. The information in that help file is fairly
  325. exhaustive and, in particular, covers the MicroEMACS macro language in
  326. detail.
  327.  
  328. ------------------------------------------------------------------------
  329.  
  330. Disclaimer and copyright:
  331. ------------------------
  332.  
  333. This program is supplied without waranties of any kind. Neither I
  334. (Pierre Perret), nor the author and copyright owner of MicroEMACS
  335. (Daniel M. Lawrence), can be held responsible or liable for any damage
  336. caused by the use of this program.
  337.  
  338. In short: USE AT YOUR OWN RISK.
  339.  
  340.     (C)Copyright 1988, 1989, 1990, 1991, 1992 by Daniel M. Lawrence
  341.     MicroEMACS 3.11 can be copied and distributed freely for any
  342.     non-commercial purposes. Commercial users may use MicroEMACS
  343.     3.11 inhouse. MicroEMACS 3.11 can only be incorporated into
  344.         commercial software or resold with the permission of the
  345.         current author:
  346.  
  347.         Daniel M. Lawrence
  348.         617 New York St
  349.         Lafayette, IN 47901
  350.  
  351.         Shareware distributors are hereby authorised to redistribute
  352.         version (1.1) of MicroEMACS for Windows.
  353.  
  354. ------------------------------------------------------------------------
  355.