home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / msdos / winemacs / readme < prev    next >
Encoding:
Text File  |  1993-06-08  |  12.8 KB  |  287 lines
  1. Distribution Notes for Win-Emacs 1.00.05 beta
  2.  
  3. Copyright (c) 1993 Pearl Software, Oakland, CA
  4.  
  5.  
  6. Pearl Software has ported GNU EMACS to Windows.  To run, it requires
  7. an X Windows emulation package.  One such emulation package, WIN-X, is
  8. provided on this disk.  WIN-X is Pearl proprietary.  The license
  9. agreement for the proprietary WIN-X package may be found in the file
  10. demo-license.txt after installation.
  11.  
  12. THE FREE SOFTWARE FOUNDATION'S GNU EMACS IS PROVIDED AT NO
  13. CHARGE UNDER THE TERMS OF THE FREE SOFTWARE FOUNDATION'S
  14. GENERAL PUBLIC LICENSE.  THE GENERAL PUBLIC LICENSE MAY BE
  15. VIEWED BY INSTALLING THE SOFTWARE AND TYPING CONTROL-H FOL-
  16. LOWED BY CONTROL-C OR BY VIEWING THE FILE "COPYING" IN THE
  17. "info" DIRECTORY AFTER INSTALLATION.
  18.  
  19. The reason we consider WIN-X and GNU Emacs two separate programs, and
  20. not two parts of one program, is that each makes sense separately.
  21. WIN-X is a general emulator for X Windows, and this version of GNU
  22. Emacs has no modifications specific to use with WIN-X.  It could run
  23. with any X Windows emulator (or, on other systems, with X Windows).
  24.  
  25. Win-Emacs requires Windows 3.1, 8 megabytes of memory, and 9 megabytes
  26. of free hard-disk space for a complete distribution.  It is based on
  27. Lucid GNU Emacs 19.4.
  28.  
  29.  
  30. I. Installation
  31.  
  32.     A. If you received Win-Emacs on floppies:
  33.  
  34.     Installation is accomplished through the SETUP.EXE program located on
  35. the disk "Win-Emacs 1" in the distribution.  Insert this disk in drive A
  36. and type "A:SETUP" from a DOS prompt; or from within Windows, select the Run
  37. command from the File menu in Program Manager and type "A:SETUP.EXE".
  38. Setup will start Windows automatically if it is not currently running, and
  39. will allow you to select the sections of Emacs you wish to install.  The
  40. "Core Program Files" must be installed in order for Emacs to work.  This
  41. includes the binaries, compiled Emacs-Lisp files, and files in the "etc"
  42. subdirectory.  "Emacs Info" refers to the online documentation files; you
  43. may choose not to install these files if you wish.
  44.  
  45.     B. If you downloaded a demo version by FTP or off of a CD-ROM:
  46.  
  47.     You will need to unpack the files from whatever form they are in.
  48. If they are in a .ZIP file, this file should be unpacked using "PKUNZIP -d".
  49. (The -d option is important -- it creates the necessary subdirectories.)
  50. If the files have already been unpacked, you simply need to copy them into
  51. the proper location (e.g. using XCOPY), making sure to preserve the sub-
  52. directory structure.  If there is not already a subdirectory "LOCK" off
  53. of the top-level directory, you must create it.
  54.  
  55.  
  56. II.  Running Win-Emacs
  57.  
  58.     Once Win-Emacs has successfully been installed, you can run it it as
  59. follows:
  60.  
  61.     1) From File Manager, locate the file "WINEMACS.EXE" (this is in the
  62.        "bin" subdirectory of the directory you installed Win-Emacs in).
  63.        Double-click on it to run.
  64.     2) From Program Manager, select "Run" from the File menu and type in
  65.        the full pathname of WINEMACS.EXE (see option 1).
  66.     3) In Program Manager, create a program item and give the full pathname
  67.        of WINEMACS.EXE as the command line.  You may optionally specify
  68.        a directory that will be current when Win-Emacs starts; this is
  69.        the default directory when Win-Emacs searches for files.  If you do
  70.        not specify a current directory, the Windows directory will be
  71.        current.
  72.  
  73.  
  74. III. Initialization files
  75.  
  76.     There are two startup files: _emacs and xdefault.ini.  Win-Emacs looks
  77.     for these files in the directory specified in the environment variable
  78.     HOME, or in the root directory of the current hard disk if HOME does
  79.     not exist.
  80.     
  81.     1) _emacs: This file contains arbitrary Emacs-Lisp code to be executed
  82.        at startup and is the equivalent of the Unix ".emacs" file.  Keys
  83.        can be rebound, options can be set, etc.  For example:
  84.  
  85.        (global-set-key "C-xC-j" 'goto-line)
  86.  
  87.        causes the command sequence C-x C-j ("C-" means the control key is
  88.        held down) to execute the Emacs-Lisp command "goto-line", which
  89.        will prompt for a line number to move to.
  90.  
  91.     2) xdefault.ini: This file allows the startup fonts, colors, and other
  92.        graphical options to be specified.  (this is equivalent to the X-
  93.        Windows ".Xdefaults" file and has the same format.)  The format
  94.        of this file is as follows:
  95.  
  96.        1) Each line (or "resource specification") consists of a resource
  97.           pattern and a value, separated by a colon.
  98.        2) Each resource pattern consists of a series of words
  99.           separated by dots or asterisks or a combination of the two.
  100.  
  101.        The lines in "xdefault.ini" are used to specify the value of
  102.        resources, which are configurable options for particular Emacs
  103.        screens and particular Emacs faces.  Every screen and every face
  104.        has a number of different resources for it.  The format of
  105.        a resource specification for a screen resource is
  106.        
  107.        Emacs.SCREEN_NAME.RESOURCE: value
  108.  
  109.        and the format of a resource for a face is
  110.  
  111.        Emacs.SCREEN_NAME.FACE_NAME.RESOURCE: value
  112.  
  113.        Resource names are case sensitive.
  114.  
  115.        Resource patterns can specify either a single resource or a
  116.        number of resources:
  117.  
  118.        a) An asterisk in a resource pattern is a wildcard and substitutes
  119.           for any number of words in the resource name.
  120.        b) Every screen, face, and resource name is part of a particular
  121.           class, and specifying that class includes all resources of
  122.       that class.
  123.  
  124.        For example, to specify that the default foreground color of all
  125.        screens be blue, use the following resource specification:
  126.  
  127.        Emacs*default.attributeForeground: blue
  128.  
  129.        (In other words, set the value of the "attributeForeground" resource
  130.        of the "default" face of all screens [the asterisk substitutes for all
  131.        screens] to "blue".)
  132.  
  133.        More specifics of resources, including all the available resources,
  134.        can be found in the file "etc/news".
  135.  
  136.        A thorough explanation of the workings of resources, and the
  137.        precedence rules governing conflicting resource specifications,
  138.        can be found in books on the X Toolkit (for example, "X Toolkit
  139.        Intrinsics Programming Manual" published by O'Reilly & Associates).
  140.  
  141.        See the sample file "etc/xdefault.ini" for some resource
  142.        specifications.
  143.  
  144.        The allowable color names are listed in the file "rgb.txt".  Each
  145.        line in this file lists the R, G, and B values of the color
  146.        followed by its name, which is not case sensitive.  You can
  147.        modify this file and add your own color names.
  148.  
  149.        Font names are specified as follows:
  150.  
  151.        -[1]-[2]-[3]-[4]-[5]-[6]-[7]-[8]-[9]-[10]-[11]-[12]-[13]-[14]
  152.  
  153.        where
  154.  
  155.        [1] = foundry that produced the font
  156.        [2] = font family name
  157.        [3] = weight ("medium" or "bold" or "demibold")
  158.        [4] = slant ("r" (normal) or "o" (oblique) or "i" (italic))
  159.        [5] = set width (usually "normal"; could be "semicondensed",
  160.          "condensed", "narrow", "double width", etc.)
  161.        [6] = serif ((nothing) or "sans")
  162.        [7] = pixels
  163.        [8] = points (in tenths of a point)
  164.        [9] = horizontal resolution in dpi
  165.        [10] = vertical resolution in dpi
  166.        [11] = spacing ("m" (monospace) or "p" (proportional) or "c" (?))
  167.        [12] = average width (in tenths of a pixel)
  168.        [13] [14] = character set (usually "iso8859-1")
  169.  
  170.        An asterisk can be substituted for a section in place of specifying
  171.        a value.  The sample "xdefault.ini" file contains the following
  172.        font specification:
  173.  
  174. Emacs*default.attributeFont: -*-courier-medium-r-*-*-*-80-*-*-*-*-iso8859-*
  175.  
  176.        This sets the font of the default face on all screens to be a standard
  177.        Courier 8-point font.  (Courier is a fixed-width font and should be
  178.        the font normally used, since support for variable-width fonts is
  179.        currently incomplete.)
  180.  
  181.  
  182. IV. Known bugs and missing features
  183.  
  184.     1) Spawning sub-processes is not currently implemented.  We are planning
  185.        on including this feature in the next release.
  186.     2) Scrollbars do not exist in either Win-Emacs or Lucid-Emacs 19.4.  These
  187.        may be added in a future release.
  188.     3) Support for italicized and variable-width fonts is not perfect.  Using
  189.        these fonts or changing font size often during program execution may
  190.        produce unexpected results.  We are planning on fixing these problems in
  191.        near releases.
  192.     4) The Emacs key bindings may not be shown in the menus.
  193.     5) Paste is not grayed when no selection from the clipboard is available.
  194.     6) Win-Emacs does not currently handle resource limitations gracefully.
  195.        It may crash when it runs out of memory.
  196.     7) Win-Emacs may not work perfectly on black-and-white or 16-color
  197.        displays.
  198.     8) Multiple instances of Win-Emacs are not allowed.  If Win-Emacs is
  199.         running and another instance is started, the second instance will
  200.         simply exit.  This is not a big problem because multiple top-level
  201.         windows can be created within a single instance (for example, with
  202.         the "C-x 5" key sequence).
  203.     9) There are some minor redisplay and miscellaneous problems: you cannot
  204.        quit from Win-Emacs directly after startup until at least one keyboard
  205.        or mouse event is processed; redisplay is incomplete if you select a
  206.        menu item in an unselected window and the drawing isn't completed
  207.        until after the menu is popped down; new screens are redisplayed twice
  208.        at creation time.
  209.     10) If you iconify and then de-iconify Win-Emacs, it may not let you
  210.         iconify it again using "C-z" or 'iconify-screen.
  211.     11) Timers of greater than 65.5 seconds are not handled properly.
  212.  
  213.  
  214. V. MS-Windows integration
  215.  
  216.    Since Win-Emacs is still in beta, integration with Microsoft Windows
  217.    is not complete.  The current level of integration is as follows:
  218.  
  219.    1) Clipboard selections can be pasted with the "paste" menu item in
  220.       the Edit menu.  Cutting or copying a region of text in Emacs using
  221.       the "cut" or "copy" menu items copies the text into the clipboard.
  222.    2) Text can be selected by holding down the left mouse button and
  223.       dragging.  You can drag the selection beyond the bottom of the
  224.       screen, but not currently beyond the top of the screen.
  225.    3) Single-clicking the left mouse button places the cursor; double-
  226.       clicking selects the word under the cursor; triple-clicking selects
  227.       the line under the cursor.
  228.    4) Mouse buttons can be bound just like keys, using "global-set-key"
  229.       and such.  The left mouse button is "button1"; the right mouse
  230.       button is "button2"; and the middle mouse button on a three-button
  231.       mouse is "button3".
  232.    5) Multiple windows can be created using "C-x 5" and can be resized and
  233.       moved around.  Closing a window using the "close" button in the
  234.       upper-left corner will delete the window if there is more than one,
  235.       and quit Win-Emacs if there is only one window.
  236.    6) Drag-and-drop support is now present: i.e. files from File Manager
  237.       can be dragged and dropped into a Win-Emacs window, and new screens
  238.       will be created, each one visiting one of the dropped files.
  239.  
  240.  
  241. VI. Differences between Win-Emacs and Emacs version 18
  242.  
  243.     Please look in the file "etc/news" for more information.  This file
  244. documents the differences between Emacs 18 and Lucid Emacs 19.4.
  245.  
  246.  
  247. VII. MS-DOS-specific additions to Emacs
  248.  
  249.     These are documented in the file "readme.dos".
  250.  
  251.  
  252. VIII. Where to look for more documentation
  253.  
  254.     The file "readme.dos" documents MS-DOS additions, as mentioned in (VII).
  255.     The file "etc/news" documents Emacs 19 additions, as mentioned in (VI).
  256.     There is extensive online documentation, which can be retrieved by
  257.     typing "C-h i" from within Emacs.  This documents how to use Win-Emacs
  258.     as an editor, how to program in Emacs-Lisp, how to add more on-line
  259.     documentation, and how to use the various Emacs extensions.
  260.  
  261.  
  262. IX. Obtaining source code
  263.  
  264.     Source code for the Emacs DLL and for the Emacs-Lisp files can be
  265.     FTP'ed from netcom.com:/pub/pearl.  The Emacs DLL source code is in the
  266.     form of diffs; in order to construct the source files, you will need to
  267.     obtain the Lucid-Emacs 19.4, X Library, and X Toolkit sources.  See
  268.     the README file at the FTP site for more information.
  269.  
  270.     The full source code (not in diff form) can also be ordered from us
  271.     for a shipping/handling fee.  Please contact us for more information.
  272.  
  273.  
  274. X. Questions, comments, problems, bug reports
  275.  
  276.     Please send e-mail to
  277.  
  278.     pearl@netcom.com
  279.  
  280.     or contact Pearl Software at
  281.  
  282.     320 Lenox Ave.
  283.     Oakland, CA 94610
  284.  
  285.     voice: 510-273-9795
  286.     fax: 510-839-9820
  287.